Class ChartSeries

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

ChartSeries

Namespace: Syncfusion.EJ2.Charts

Assembly: Syncfusion.EJ2.dll

Syntax

public class ChartSeries : EJTagHelper

Constructors

ChartSeries()

Declaration

public ChartSeries()

Properties

Accessibility

Options to improve accessibility for series elements.

Declaration

public ChartSeriesAccessibility Accessibility { get; set; }

Property Value

Type	Description
ChartSeriesAccessibility	The default value is null

AddPoint

Declaration

public object AddPoint { get; set; }

Property Value

Type	Description
System.Object	The default value is null

Animation

Options for customizing the animation of the series. By default, animation is enabled with a duration of 1000 milliseconds (about 1 second). It can be disabled by setting enable to false. The following properties are supported in animation: enable: If set to true, the series is animated on initial loading. duration: The duration of the animation in milliseconds. delay: The delay before the animation starts, in milliseconds.

Declaration

public ChartAnimation Animation { get; set; }

Property Value

Type	Description
ChartAnimation	The default value is null

BearFillColor

This property is used in financial charts to visualize price movements in stocks. 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	The default value is null

BinInterval

The binInterval property controls the width of each bin and the interval between bins for histogram points.

Declaration

public double BinInterval { get; set; }

Property Value

Type	Description
System.Double	The default value is Double.NaN

Border

Options for customizing the border of the series.

Note that this property is applicable only for Column and Bar type series.

Declaration

public ChartBorder Border { get; set; }

Property Value

Type	Description
ChartBorder	The default value is null

BoxPlotMode

Specifies the box plot mode for the box and whisker chart series. The available modes are: Exclusive - Renders the series based on the exclusive mode. Inclusive - Renders the series based on the inclusive mode. Normal - Renders the series based on the normal mode.

Declaration

public BoxPlotMode BoxPlotMode { get; set; }

Property Value

Type	Description
BoxPlotMode	The default value is BoxPlotMode.Normal

BullFillColor

This property is used in financial charts to visualize price movements in stocks. 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	The default value is null

CardinalSplineTension

Specifies the tension parameter for cardinal splines. This affects the curvature of the spline.

Declaration

public double CardinalSplineTension { get; set; }

Property Value

Type	Description
System.Double	The default value is 0.5

Close

The data source field that contains the close value. It is applicable for both financial series and technical indicators.

Declaration

public string Close { get; set; }

Property Value

Type	Description
System.String	The default value is ""

ColorName

The data source field that contains the color mapping value. It is applicable for range color mapping.

Declaration

public string ColorName { get; set; }

Property Value

Type	Description
System.String	The default value is null

ColumnFacet

Defines the shape of the data in a column and bar chart. Available shapes are: Rectangle: Displays the data in a column and bar chart with a rectangular shape. Cylinder: Displays the data in a column and bar chart with a cylindrical shape.

Declaration

public ShapeType ColumnFacet { get; set; }

Property Value

Type	Description
ShapeType	The default value is ShapeType.Rectangle

ColumnSpacing

This property determines the space between columns in a column or bar chart.

Note that it takes a value from 0 to 1.

Declaration

public double ColumnSpacing { get; set; }

Property Value

Type	Description
System.Double	The default value is 0

ColumnWidth

The columnWidth property can be used to customize the width of the columns in a column series.

Note that if the series type is histogram, the default value is 1; otherwise, it is 0.7.

Declaration

public double ColumnWidth { get; set; }

Property Value

Type	Description
System.Double	The default value is Double.NaN

ColumnWidthInPixel

To render the column series points with a specific column width in pixels.

Declaration

public double ColumnWidthInPixel { get; set; }

Property Value

Type	Description
System.Double	The default value is Double.NaN

Connector

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

Declaration

public object Connector { get; set; }

Property Value

Type	Description
System.Object	The default value is null

CornerRadius

The cornerRadius property specifies the radius for the corners of the column series points to create a rounded appearance in the chart.

Declaration

public ChartCornerRadius CornerRadius { get; set; }

Property Value

Type	Description
ChartCornerRadius	The default value is null

DashArray

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

Declaration

public string DashArray { get; set; }

Property Value

Type	Description
System.String	The default value is ""

DataSource

Specifies the data source 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	The default value is null

DragSettings

Customize the drag settings for the series with this property to configure drag behavior in the chart.

Declaration

public ChartDragSettings DragSettings { get; set; }

Property Value

Type	Description
ChartDragSettings	The default value is null

DrawType

Specifies the type of series to be drawn in radar or polar charts. The available options are: 'Line' - Renders a line series. 'Column' - Renders a column series. 'Area' - Renders an area series. 'Scatter' - Renders a scatter series. 'Spline' - Renders a spline series. 'StackingColumn' - Renders a stacking column series. 'StackingArea' - Renders a stacking area series. 'RangeColumn' - Renders a range column series. 'SplineArea' - Renders a spline area series.

Declaration

public ChartDrawType DrawType { get; set; }

Property Value

Type	Description
ChartDrawType	The default value is ChartDrawType.Line

EmptyPointSettings

Declaration

public ChartEmptyPointSettings EmptyPointSettings { get; set; }

Property Value

Type
ChartEmptyPointSettings

EnableComplexProperty

This property is used to improve chart performance through data mapping for the series data source.

Declaration

public bool EnableComplexProperty { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableSolidCandles

This property is applicable for the candle series. It enables or disables the visual comparison of the current values with previous values in stock charts.

Declaration

public bool EnableSolidCandles { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableTooltip

Controls whether the tooltip for the chart series is enabled or disabled. Set to true to display tooltips on hover, or false to hide them.

Declaration

public bool EnableTooltip { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

ErrorBar

Options for displaying and customizing error bars for individual points in a series.

Declaration

public ChartErrorBarSettings ErrorBar { get; set; }

Property Value

Type	Description
ChartErrorBarSettings	The default value is null

Fill

Declaration

public string Fill { get; set; }

Property Value

Type
System.String

GroupName

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

Declaration

public string GroupName { get; set; }

Property Value

Type	Description
System.String	The default value is ""

High

The data source field that contains the high value. It is applicable for both financial series and technical indicators.

Declaration

public string High { get; set; }

Property Value

Type	Description
System.String	The default value is ""

IntermediateSumIndexes

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

Declaration

public int[] IntermediateSumIndexes { get; set; }

Property Value

Type	Description
System.Int32[]	The default value is null

IsClosed

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

Declaration

public bool IsClosed { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

LegendImageUrl

The URL for the image to be displayed as a legend icon.

Note that legendShape must be set to Image.

Declaration

public string LegendImageUrl { get; set; }

Property Value

Type	Description
System.String	The default value is ""

LegendShape

Specifies the shape of the legend icon for each series. Available shapes for legend: Circle - Renders a circular icon. Rectangle - Renders a rectangular icon. Triangle - Renders a triangular icon. Diamond - Renders a diamond-shaped icon. Cross - Renders a cross-shaped icon. HorizontalLine - Renders a horizontal line icon. VerticalLine - Renders a vertical line icon. Pentagon - Renders a pentagon-shaped icon. InvertedTriangle - Renders an inverted triangle-shaped icon. SeriesType - Uses the default icon shape based on the series type. Image - Renders a custom image for the legend icon.

Declaration

public LegendShape LegendShape { get; set; }

Property Value

Type	Description
LegendShape	The default value is LegendShape.SeriesType

Low

The data source field that contains the low value. It is applicable for both financial series and technical indicators.

Declaration

public string Low { get; set; }

Property Value

Type	Description
System.String	The default value is ""

Marker

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

Declaration

public ChartMarkerSettings Marker { get; set; }

Property Value

Type	Description
ChartMarkerSettings	The default value is null

MaxRadius

Specifies the maximum radius for the data points in the series.

Declaration

public double MaxRadius { get; set; }

Property Value

Type	Description
System.Double	The default value is 3

MinRadius

Specifies the minimum radius for the data points in the series.

Declaration

public double MinRadius { get; set; }

Property Value

Type	Description
System.Double	The default value is 1

Name

The name property allows setting a name for the series, which will be displayed in the legend, identifying different series in the chart, especially when multiple series are present.

Declaration

public string Name { get; set; }

Property Value

Type	Description
System.String	The default value is ""

NegativeFillColor

Defines the visual representation of negative changes in waterfall charts.

Declaration

public string NegativeFillColor { get; set; }

Property Value

Type	Description
System.String	The default value is "#C64E4A"

NonHighlightStyle

The nonHighlightStyle property is used to specify custom CSS styles for the non-highlighted series or points.

Declaration

public string NonHighlightStyle { get; set; }

Property Value

Type	Description
System.String	The default value is null

NoRisers

When set to true, the step series will be rendered without the vertical lines (risers) connecting the horizontal steps.

Note this property is only applicable to step series.

Declaration

public bool NoRisers { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

Opacity

Sets the opacity of the series, with a value between 0 and 1 where 0 is fully transparent and 1 is fully opaque.

Declaration

public double Opacity { get; set; }

Property Value

Type	Description
System.Double	The default value is 1

Open

The data source field that contains the open value. It is applicable for both financial series and technical indicators.

Declaration

public string Open { get; set; }

Property Value

Type	Description
System.String	The default value is ""

ParetoOptions

Options for customizing the Pareto line series, including its appearance and behavior in the chart.

Declaration

public ChartParetoOptions ParetoOptions { get; set; }

Property Value

Type	Description
ChartParetoOptions	The default value is null

PointColorMapping

The data source field that contains the color value of a point. It is applicable for series.

Declaration

public string PointColorMapping { get; set; }

Property Value

Type	Description
System.String	The default value is ""

Query

Specifies a query to select data from the data source. This property is applicable only when the data source is an ej.DataManager.

Declaration

public string Query { get; set; }

Property Value

Type	Description
System.String	The default value is ""

RemovePoint

Declaration

public object RemovePoint { get; set; }

Property Value

Type	Description
System.Object	The default value is null

SegmentAxis

Defines the axis along which the line series will be split.

Declaration

public Segment SegmentAxis { get; set; }

Property Value

Type	Description
Segment	The default value is null

Segments

Specifies a collection of regions used to differentiate a line series.

Declaration

public List<ChartSegment> Segments { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ChartSegment>	The default value is null

SelectionStyle

The selectionStyle property is used to specify custom CSS styles for the selected series or points.

Declaration

public string SelectionStyle { get; set; }

Property Value

Type	Description
System.String	The default value is null

SetData

Declaration

public object SetData { get; set; }

Property Value

Type	Description
System.Object	The default value is null

ShowMean

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

Declaration

public bool ShowMean { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

ShowNearestTooltip

Enables or disables the display of tooltips for the nearest data point to the cursor for series.

Declaration

public bool ShowNearestTooltip { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

ShowNormalDistribution

Specifies whether to display the normal distribution curve for the histogram series.

Declaration

public bool ShowNormalDistribution { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

ShowOutliers

Specifies whether to display outliers in the Box and Whisker chart.

Declaration

public bool ShowOutliers { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

Size

The data source field that contains the size value for the y-axis.

Declaration

public string Size { get; set; }

Property Value

Type	Description
System.String	The default value is ""

SplineType

Specifies the type of spline used for rendering. Available options include: Natural - Renders a natural spline. Cardinal - Renders a cardinal spline. Clamped - Renders a clamped spline. Monotonic - Renders a monotonic spline.

Declaration

public SplineType SplineType { get; set; }

Property Value

Type	Description
SplineType	The default value is SplineType.Natural

StackingGroup

This property allows the grouping of series in stacked column and stacked bar charts. Any string value can be assigned to the stackingGroup property. Series with the same stackingGroup value will be grouped together in the chart.

Declaration

public string StackingGroup { get; set; }

Property Value

Type	Description
System.String	The default value is ""

Step

The step property can be used to change the position of the steps in step line, step area, and step range area chart types. Left: Steps start from the left side of the 2nd point. Center: Steps start between the data points. Right: Steps start from the right side of the 1st point.

Declaration

public StepPosition Step { get; set; }

Property Value

Type	Description
StepPosition	The default value is StepPosition.Left

SumIndexes

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

Declaration

public int[] SumIndexes { get; set; }

Property Value

Type	Description
System.Int32[]	The default value is null

SummaryFillColor

Defines the visual representation of summaries in waterfall charts.

Declaration

public string SummaryFillColor { get; set; }

Property Value

Type	Description
System.String	The default value is "#4E81BC"

TooltipFormat

Use this property to define a custom format for how tooltips are displayed.

Declaration

public string TooltipFormat { get; set; }

Property Value

Type	Description
System.String	The default value is ""

TooltipMappingName

The data source field that contains the value to be displayed in the tooltip.

Declaration

public string TooltipMappingName { get; set; }

Property Value

Type	Description
System.String	The default value is ""

Trendlines

Defines the collection of trendlines used to predict the trend.

Declaration

public List<ChartTrendline> Trendlines { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ChartTrendline>	The default value is null

Type

The type of the series determines the visual representation of the data. Available series types include: Line - Draws a line series. Column - Draws a column series. Area - Draws an area series. Bar - Draws a bar series. Histogram - Draws a histogram series. StackingColumn - Draws a stacking column series. StackingArea - Draws a stacking area series. StackingBar - Draws a stacking bar series. StepLine - Draws a step line series. StepArea - Draws a step area series. Scatter - Draws a scatter series. Spline - Draws a spline series. StackingColumn100 - Draws a 100% stacked column series. StackingBar100 - Draws a 100% stacked bar series. StackingArea100 - Draws a 100% stacked area series. RangeColumn - Draws a range column series. Hilo - Draws a Hilo series. HiloOpenClose - Draws a Hilo Open Close series. Waterfall - Draws a waterfall series. RangeArea - Draws a range area series. SplineRangeArea - Draws a spline range area series. Bubble - Draws a bubble series. Candle - Draws a candle series. Polar - Draws a polar series. Radar - Draws a radar series. BoxAndWhisker - Draws a box and whisker series. Pareto - Draws a Pareto series.

Declaration

public ChartSeriesType Type { get; set; }

Property Value

Type	Description
ChartSeriesType	The default value is ChartSeriesType.Line

UnSelectedStyle

The unSelectedStyle property is used to specify custom CSS styles for the deselected series or points.

Declaration

public string UnSelectedStyle { get; set; }

Property Value

Type	Description
System.String	The default value is null

Visible

If set to true, the series will be visible. If set to false, the series will be hidden.

Declaration

public bool Visible { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

Volume

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

Declaration

public string Volume { get; set; }

Property Value

Type	Description
System.String	The default value is ""

Width

The stroke width for the series, 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	The default value is 1

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	The default value is null

XName

The data source field that contains the x value. It is applicable to both series and technical indicators.

Declaration

public string XName { get; set; }

Property Value

Type	Description
System.String	The default value is ""

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	The default value is null

YName

The data source field that contains the y value.

Declaration

public string YName { get; set; }

Property Value

Type	Description
System.String	The default value is ""

ZOrder

The z-order of the series, which controls the stack order of the series. Higher values are drawn on top of lower values.

Declaration

public double ZOrder { get; set; }

Property Value

Type	Description
System.Double	The default value is 0