Class ChartSeries

Inheritance
System.Object
Syncfusion.Blazor.BaseComponent
ChartSeries
Implements
System.IDisposable
Namespace: Syncfusion.Blazor.Charts
Assembly: Syncfusion.Blazor.dll
Syntax
public class ChartSeries : BaseComponent, IDisposable

Constructors

ChartSeries()

Declaration
public ChartSeries()

Properties

Animation

Options to customizing animation for the series.

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

BearFillColor

This property is used in financial charts to visualize the price movements in stock. It defines the color of the candle/point, when the opening price is less than the closing price.

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

BinInterval

The bin interval of each histogram points.

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

Border

Options to customizing the border of the series. This is applicable only for Column and Bar type series.

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

BoxPlotMode

The mode of the box and whisker char series. They are, Exclusive Inclusive Normal

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

BullFillColor

This property is used in financial charts to visualize the price movements in stock. It defines the color of the candle/point, when the opening price is higher than the closing price.

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

CardinalSplineTension

It defines tension of cardinal spline types

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

ChildContent

Declaration
public RenderFragment ChildContent { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.RenderFragment

Close

The DataSource field that contains the close value of y It is applicable for series and technical indicators

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

ColumnSpacing

To render the column series points with particular column spacing. It takes value from 0 - 1.

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

ColumnWidth

To render the column series points with particular column width. If the series type is histogram the default value is 1 otherwise 0.7.

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

Connector

Defines the appearance of line connecting adjacent points in waterfall charts.

Declaration
public ConnectorModel Connector { get; set; }
Property Value
Type Description
ConnectorModel

CornerRadius

To render the column series points with particular rounded corner.

Declaration
public ChartCornerRadius CornerRadius { get; set; }
Property Value
Type Description
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 Description
System.String

DataSource

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

Declaration
public object DataSource { get; set; }
Property Value
Type Description
System.Object

DragSettings

Options to customize the drag settings for series

Declaration
public ChartDragSettings DragSettings { get; set; }
Property Value
Type Description
ChartDragSettings

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 Description
ChartDrawType

EmptyPointSettings

options to customize the empty points in series

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

EnableComplexProperty

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

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

EnableSolidCandles

This property is applicable for candle series. It enables/disables to visually compare the current values with the previous values in stock.

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

EnableTooltip

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

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

ErrorBar

Options for displaying and customizing error bar for individual point in a series.

Declaration
public ChartErrorBarSettings ErrorBar { get; set; }
Property Value
Type Description
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 Description
System.String

High

The DataSource field that contains the high value of y It is applicable for series and technical indicators

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

IntermediateSumIndexes

Defines the collection of indexes of the intermediate summary columns in waterfall charts.

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

IsClosed

Specifies whether to join start and end point of a line/area series used in polar/radar chart to form a closed path.

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

jsProperty

Declaration
protected override string jsProperty { get; set; }
Property Value
Type Description
System.String
Overrides
Syncfusion.Blazor.BaseComponent.jsProperty

LegendShape

The shape of the legend. Each series has its own legend shape. They are, Circle Rectangle Triangle Diamond Cross HorizontalLine VerticalLine Pentagon InvertedTriangle SeriesType

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

Low

The DataSource field that contains the low value of y It is applicable for series and technical indicators

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

mainParent

Declaration
protected override BaseComponent mainParent { get; set; }
Property Value
Type Description
Syncfusion.Blazor.BaseComponent
Overrides
Syncfusion.Blazor.BaseComponent.mainParent

Marker

Options for displaying and customizing markers for individual points in a series.

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

MaxRadius

Maximum radius

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

MinRadius

Minimum radius

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

Name

The name of the series visible in legend.

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

NegativeFillColor

Defines the visual representation of the negative changes in waterfall charts.

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

NonHighlightStyle

Custom style for the non-highlighted series or points.

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

Opacity

The opacity of the series.

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

Open

The DataSource field that contains the open value of y It is applicable for series and technical indicators

Declaration
public string Open { get; set; }
Property Value
Type Description
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 Description
System.String

Query

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

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

SegmentAxis

Defines the axis, based on which the line series will be split.

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

Segments

Defines the collection of regions that helps to differentiate a line series.

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

SelectionStyle

Custom style for the selected series or points.

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

ShowMean

If set true, the mean value for box and whisker will be visible.

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

ShowNormalDistribution

The normal distribution of histogram series.

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

Size

The DataSource field that contains the size value of y

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

SplineType

Defines type of spline to be rendered.

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

StackingGroup

This property allows grouping series in Stacked column / bar charts. Any string value can be provided to the stackingGroup property. If any two or above series have the same value, those series will be grouped together.

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

SumIndexes

Defines the collection of indexes of the overall summary columns in waterfall charts.

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

SummaryFillColor

Defines the visual representation of the summaries in waterfall charts.

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

TooltipFormat

user can format now each series tooltip format separately.

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

TooltipMappingName

The provided value will be considered as a Tooltip name

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

Trendlines

Defines the collection of trendlines that are used to predict the trend

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

Type

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 Description
ChartSeriesType

UnSelectedStyle

Custom style for the deselected series or points.

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

Visible

Specifies the visibility of series.

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

Volume

Defines the data source field that contains the volume value in candle charts It is applicable for financial series and technical indicators

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

Width

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

Declaration
public double Width { get; set; }
Property Value
Type Description
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 Description
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 Description
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 Description
System.String

YName

The DataSource field that contains the y value.

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

ZOrder

The z order of the series.

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

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

GetJSNamespace()

Declaration
public string GetJSNamespace()
Returns
Type Description
System.String

OnInitializedAsync()

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
System.Threading.Tasks.Task
Overrides
Syncfusion.Blazor.BaseComponent.OnInitializedAsync()

OnParametersSetAsync()

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

updateChildProperties(String, Object)

Declaration
public void updateChildProperties(string key, object value)
Parameters
Type Name Description
System.String key
System.Object value

Implements

System.IDisposable