Class ChartSeries

Inheritance
System.Object
SfBaseComponent
SfDataBoundComponent
ChartDataBoundComponent
ChartSeries
Inherited Members
Namespace: Syncfusion.Blazor.Charts
Assembly: Syncfusion.Blazor.dll
Syntax
public class ChartSeries : ChartDataBoundComponent, ISubcomponentTracker, IChartElement

Constructors

ChartSeries()

Declaration
public ChartSeries()

Properties

AccessibilityDescription

Gets or sets the accessibility description for the ChartSeries.

Declaration
public string AccessibilityDescription { get; set; }
Property Value
Type Description
System.String

Accepts a string that defines the accessibility description for the ChartSeries. The default value is null.
Remarks

Use this property to provide an accessibility description for the ChartSeries root element, which is the parent element of the series points.

AccessibilityDescriptionFormat

Gets or sets the format for the points accessibility description of the ChartSeries. The format string can include the following placeholders:

  • ${series.name}: Displays the name of the series.
  • ${point.x}: Displays the x-value of the point.
  • ${point.y}: Displays the y-value of the point.
  • ${point.high}: Displays the high value of the point. This is applicable only for financial and range series.
  • ${point.low}: Displays the low value of the point. This is applicable only for financial and range series.
  • ${point.open}: Displays the open value of the point. This is applicable only for financial series.
  • ${point.close}: Displays the close value of the point. This is applicable only for financial series.
Declaration
public string AccessibilityDescriptionFormat { get; set; }
Property Value
Type Description
System.String

Accepts a string that defines the format for the points accessibility description of the ChartSeries. The default value is null.
Remarks

Use this property to specify the format for the points accessibility description of the ChartSeries. The AccessibilityDescription property provides accessibility information for the series root element. However, this property allows you to provide dynamic information based on the ChartSeries data. For example, the format "${series.name} : ${point.x}" displays the series name and x-value of the point in the accessibility description.

AccessibilityRole

Gets or sets the accessibility role for the ChartSeries.

Declaration
public string AccessibilityRole { get; set; }
Property Value
Type Description
System.String

Accepts a string that defines the accessibility role for the ChartSeries. The default value is null.
Remarks

Use this property to specify the accessibility role for the ChartSeries root element.

Animation

Specifies the configuration of the animation settings for series.

Declaration
public ChartSeriesAnimation Animation { get; set; }
Property Value
Type
ChartSeriesAnimation

BearFillColor

Specifies BearFillColor for candle series.

Declaration
public string BearFillColor { get; set; }
Property Value
Type
System.String

BinInterval

Specifies the BinInterval for Histogram series.

Declaration
public double BinInterval { get; set; }
Property Value
Type
System.Double

Border

Defines the border of the rectangle shaped series.

Declaration
public ChartSeriesBorder Border { get; set; }
Property Value
Type
ChartSeriesBorder

BoxPlotMode

Specifies the BoxPlotMode for box and whisker series.

Declaration
public BoxPlotMode BoxPlotMode { get; set; }
Property Value
Type
BoxPlotMode

BullFillColor

Specifies the BullFillColor for candle series.

Declaration
public string BullFillColor { get; set; }
Property Value
Type
System.String

CardinalSplineTension

Specifies the CardinalSplineTension for spline series.

Declaration
public double CardinalSplineTension { get; set; }
Property Value
Type
System.Double

ChartDataEditSettings

Configuration of drag settings for the series.

Declaration
public ChartDataEditSettings ChartDataEditSettings { get; set; }
Property Value
Type
ChartDataEditSettings

Close

The DataSource field that contains the close value for financial type series.

Declaration
public string Close { get; set; }
Property Value
Type
System.String

ColumnSpacing

Defines the space between adjacent series for the rectangle shaped series.

Declaration
public double ColumnSpacing { get; set; }
Property Value
Type
System.Double

ColumnWidth

Specifies the column width of the rectangle typed series.

Declaration
public double ColumnWidth { get; set; }
Property Value
Type
System.Double

Connector

Declaration
public ChartSeriesConnector Connector { get; set; }
Property Value
Type
ChartSeriesConnector

CornerRadius

Specifies the corner radius of the rectangle shaped series.

Declaration
public ChartCornerRadius CornerRadius { get; set; }
Property Value
Type
ChartCornerRadius

DashArray

Defines the pattern of dashes and gaps to stroke the lines in Line type series.

Declaration
public string DashArray { get; set; }
Property Value
Type
System.String

DataSource

Specifies the DataSource for the chart. It can be an array of JSON objects or an instance of DataManager.

Declaration
public IEnumerable<object> DataSource { get; set; }
Property Value
Type
System.Collections.Generic.IEnumerable<System.Object>

DrawType

Type of series to be drawn in radar or polar series. They are 'Line' 'Column' 'Area' 'Scatter' 'Spline' 'StackingColumn' 'StackingArea' 'RangeColumn' 'SplineArea'.

Declaration
public ChartDrawType DrawType { get; set; }
Property Value
Type
ChartDrawType

EmptyPointSettings

Specifies the customization of the empty point settins for the series.

Declaration
public ChartEmptyPointSettings EmptyPointSettings { get; set; }
Property Value
Type
ChartEmptyPointSettings

EnableComplexProperty

This property used to improve chart performance via data mapping for series dataSource.

Declaration
public bool EnableComplexProperty { get; set; }
Property Value
Type
System.Boolean

EnableSolidCandles

Enables SolidCandles for candle series.

Declaration
public bool EnableSolidCandles { get; set; }
Property Value
Type
System.Boolean

EnableTooltip

If set true, the Tooltip for series will be visible.

Declaration
public bool EnableTooltip { get; set; }
Property Value
Type
System.Boolean

ErrorBar

Declaration
public ChartErrorBarSettings ErrorBar { get; set; }
Property Value
Type
ChartErrorBarSettings

Fill

The fill color for the series that accepts value in hex and rgba as a valid CSS color string. It also represents the color of the signal lines in technical indicators. For technical indicators, the default value is 'blue' and for series, it has null.

Declaration
public string Fill { get; set; }
Property Value
Type
System.String

Focusable

Gets or sets the accessibility keyboard navigation focus option for the ChartSeries.

Declaration
public bool Focusable { get; set; }
Property Value
Type Description
System.Boolean

Accepts a boolean value to enable or disable keyboard navigation for the ChartSeries. The default value is true.
Remarks

Use this property to toggle keyboard navigation focus for the ChartSeries.

GroupName

Defines the name that specifies the chart series are mutually exclusive and can be overlaid. The axis in the same group shares the same baseline and location on the corresponding axis.

Declaration
public string GroupName { get; set; }
Property Value
Type
System.String

High

The DataSource field that contains the high value for financial type series.

Declaration
public string High { get; set; }
Property Value
Type
System.String

HighlightStyle

Specfies the class name when the series is highlighted.

Declaration
public string HighlightStyle { get; set; }
Property Value
Type
System.String

IntermediateSumIndexes

IntermediateSumIndexes for waterfall series.

Declaration
public double[] IntermediateSumIndexes { get; set; }
Property Value
Type
System.Double[]

IsClosed

Enables the polar line based series to be closed.

Declaration
public bool IsClosed { get; set; }
Property Value
Type
System.Boolean

LegendShape

Specifies the legend shape of the series.

Declaration
public LegendShape LegendShape { get; set; }
Property Value
Type
LegendShape

Low

The DataSource field that contains the low value for financial type series.

Declaration
public string Low { get; set; }
Property Value
Type
System.String

Marker

Specifies the customization of the marker of the series.

Declaration
public ChartMarker Marker { get; set; }
Property Value
Type
ChartMarker

MaxRadius

Denoted the maximum radius for bubble series.

Declaration
public double MaxRadius { get; set; }
Property Value
Type
System.Double

MinRadius

Denoted the minimum radius for bubble series.

Declaration
public double MinRadius { get; set; }
Property Value
Type
System.Double

Name

Specifies the name of the series.

Declaration
public string Name { get; set; }
Property Value
Type
System.String

NegativeFillColor

Specifies the NegativeFillColor for waterfall series.

Declaration
public string NegativeFillColor { get; set; }
Property Value
Type
System.String

NonHighlightStyle

Specfies the class name when the series is non-highlighted.

Declaration
public string NonHighlightStyle { get; set; }
Property Value
Type
System.String

Opacity

Defines the opacity of the series fill.

Declaration
public double Opacity { get; set; }
Property Value
Type
System.Double

Open

The DataSource field that contains the open value for financial type series.

Declaration
public string Open { get; set; }
Property Value
Type
System.String

PointColorMapping

The DataSource field that contains the color value of point It is applicable for series.

Declaration
public string PointColorMapping { get; set; }
Property Value
Type
System.String

Query

Specifies query to select data from DataSource. This property is applicable only when the DataSource is SfDataManager.

Declaration
public Query Query { get; set; }
Property Value
Type
Query

RendererKey

Declaration
public string RendererKey { get; set; }
Property Value
Type
System.String

RendererType

Declaration
public Type RendererType { get; set; }
Property Value
Type
System.Type

SegmentAxis

Specifies in which axis segment will be done.

Declaration
public Segment SegmentAxis { get; set; }
Property Value
Type
Segment

Segments

Specified the segments of the multicolor series.

Declaration
public List<ChartSegment> Segments { get; set; }
Property Value
Type
System.Collections.Generic.List<ChartSegment>

SelectionStyle

Spectifies class name when the series is selected.

Declaration
public string SelectionStyle { get; set; }
Property Value
Type
System.String

ShowMean

Specifies the Showmean for box and whisker series.

Declaration
public bool ShowMean { get; set; }
Property Value
Type
System.Boolean

ShowNormalDistribution

Specifies the ShowNormalDistribution for Histogram series.

Declaration
public bool ShowNormalDistribution { get; set; }
Property Value
Type
System.Boolean

Size

The DataSource field that contains the size value for the bubble series.

Declaration
public string Size { get; set; }
Property Value
Type
System.String

SplineType

Specifies the splineType for spline series.

Declaration
public SplineType SplineType { get; set; }
Property Value
Type
SplineType

StackingGroup

Based on this value stacking series are grouped together.

Declaration
public string StackingGroup { get; set; }
Property Value
Type
System.String

StepPosition

Defines the position for the steps in the stepline, steparea, and steprange area chart types. The available positions are,

  • Center Steps start between the data points.
  • Left Steps start from the left side of the 2nd point.
  • Right Steps start from the right side of the 1st point.
Declaration
public StepPosition StepPosition { get; set; }
Property Value
Type Description
StepPosition

Customize the step position for the chart step series. The default value is Left.

SumIndexes

Specifies the sumIndexes for waterfall series.

Declaration
public double[] SumIndexes { get; set; }
Property Value
Type
System.Double[]

SummaryFillColor

Specifies the summaryFillColor for waterfall series.

Declaration
public string SummaryFillColor { get; set; }
Property Value
Type
System.String

TooltipFormat

Specifies the format of the tooltip for the series.

Declaration
public string TooltipFormat { get; set; }
Property Value
Type
System.String

TooltipMappingName

Specifies the intermediateSumIndexes for waterfall series The provided value will be considered as a Tooltip Mapping name.

Declaration
public string TooltipMappingName { get; set; }
Property Value
Type
System.String

Trendlines

Specifies the trendlines for the series.

Declaration
public List<ChartTrendline> Trendlines { get; set; }
Property Value
Type
System.Collections.Generic.List<ChartTrendline>

Type

Specifies the type of series The type of the series are Line Column Area Bar Histogram StackingColumn StackingArea StackingBar StepLine StepArea Scatter Spline StackingColumn100 StackingBar100 StackingArea100 RangeColumn Hilo HiloOpenClose Waterfall RangeArea Bubble Candle Polar Radar BoxAndWhisker Pareto.

Declaration
public ChartSeriesType Type { get; set; }
Property Value
Type
ChartSeriesType

UnSelectedStyle

Spectifies class name when the series is deselected.

Declaration
public string UnSelectedStyle { get; set; }
Property Value
Type
System.String

Visible

Specifies the visibility of series.

Declaration
public bool Visible { get; set; }
Property Value
Type
System.Boolean

Volume

The DataSource field that contains the volume value for financial type series.

Declaration
public string Volume { get; set; }
Property Value
Type
System.String

Width

The stroke width for the series that is applicable only for Line type series. It also represent the stroke width of the signal lines in technical indicators.

Declaration
public double Width { get; set; }
Property Value
Type
System.Double

XAxisName

The name of the horizontal axis associated with the series. It requires Axes of the chart. It is applicable for series and technical indicators.

Declaration
public string XAxisName { get; set; }
Property Value
Type
System.String

XName

The DataSource field that contains the x value. It is applicable for series and technical indicators.

Declaration
public string XName { get; set; }
Property Value
Type
System.String

YAxisName

The name of the vertical axis associated with the series. It requires Axes of the chart. It is applicable for series and technical indicators.

Declaration
public string YAxisName { get; set; }
Property Value
Type
System.String

YName

The DataSource field that contains the y value.

Declaration
public string YName { get; set; }
Property Value
Type
System.String

ZOrder

Specifies the z order of the series.

Declaration
public int ZOrder { get; set; }
Property Value
Type
System.Int32

Methods

OnAfterRender(Boolean)

Declaration
protected override void OnAfterRender(bool firstRender)
Parameters
Type Name Description
System.Boolean firstRender

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type
System.Threading.Tasks.Task
Overrides

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
System.Threading.Tasks.Task
Overrides