Class ChartSeries
Inherited Members
Namespace: Syncfusion.EJ2.Charts
Assembly: Syncfusion.EJ2.dll
Syntax
public class ChartSeries : EJTagHelper
Constructors
ChartSeries()
Declaration
public ChartSeries()
Properties
Animation
Options to customizing animation for the series.
Declaration
[HtmlAttributeName("animation")]
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 the price movements in stock. It defines the color of the candle/point, when the opening price is less than the closing price.
Declaration
[HtmlAttributeName("bearFillColor")]
public string BearFillColor { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
BinInterval
The bin interval of each histogram points.
Declaration
[HtmlAttributeName("binInterval")]
public double BinInterval { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is Double.NaN |
Border
Options to customizing the border of the series. This is applicable only for Column
and Bar
type series.
Declaration
[HtmlAttributeName("border")]
public ChartBorder Border { get; set; }
Property Value
Type | Description |
---|---|
ChartBorder | The default value is null |
BoxPlotMode
The mode of the box and whisker char series. They are, Exclusive Inclusive Normal
Declaration
[HtmlAttributeName("boxPlotMode")]
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 the price movements in stock. It defines the color of the candle/point, when the opening price is higher than the closing price.
Declaration
[HtmlAttributeName("bullFillColor")]
public string BullFillColor { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
CardinalSplineTension
It defines tension of cardinal spline types.
Declaration
[HtmlAttributeName("cardinalSplineTension")]
public double CardinalSplineTension { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 0.5 |
Close
The DataSource field that contains the close value of y It is applicable for series and technical indicators
Declaration
[HtmlAttributeName("close")]
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 properly.
Declaration
[HtmlAttributeName("colorName")]
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. Rectangle: Displays the data in a column and bar chart in a rectangle shape. Cylinder: Displays the data in a column and bar chart in a cylinder shape.
Declaration
[HtmlAttributeName("columnFacet")]
public ShapeType ColumnFacet { get; set; }
Property Value
Type | Description |
---|---|
ShapeType | The default value is ShapeType.Rectangle |
ColumnSpacing
To render the column series points with particular column spacing. It takes value from 0 - 1.
Declaration
[HtmlAttributeName("columnSpacing")]
public double ColumnSpacing { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 0 |
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
[HtmlAttributeName("columnWidth")]
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 particular column width as pixel.
Declaration
[HtmlAttributeName("columnWidthInPixel")]
public double ColumnWidthInPixel { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is Double.NaN |
Connector
Defines the appearance of line connecting adjacent points in waterfall charts.
Declaration
[HtmlAttributeName("connector")]
public object Connector { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
CornerRadius
To render the column series points with particular rounded corner.
Declaration
[HtmlAttributeName("cornerRadius")]
public ChartCornerRadius CornerRadius { get; set; }
Property Value
Type | Description |
---|---|
ChartCornerRadius | The default value is null |
DashArray
Defines the pattern of dashes and gaps to stroke the lines in Line
type series.
Declaration
[HtmlAttributeName("dashArray")]
public string DashArray { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
DataSource
Specifies the DataSource for the series. It can be an array of JSON objects or an instance of DataManager.
Declaration
[HtmlAttributeName("dataSource")]
public object DataSource { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
DragSettings
Options to customize the drag settings for series
Declaration
[HtmlAttributeName("dragSettings")]
public ChartDragSettings DragSettings { get; set; }
Property Value
Type | Description |
---|---|
ChartDragSettings | The default value is null |
DrawType
Type of series to be drawn in radar or polar series. They are 'Line' 'Column' 'Area' 'Scatter' 'Spline' 'StackingColumn' 'StackingArea' 'RangeColumn' 'SplineArea'
Declaration
[HtmlAttributeName("drawType")]
public ChartDrawType DrawType { get; set; }
Property Value
Type | Description |
---|---|
ChartDrawType | The default value is ChartDrawType.Line |
EmptyPointSettings
options to customize the empty points in series.
Declaration
[HtmlAttributeName("emptyPointSettings")]
public ChartEmptyPointSettings EmptyPointSettings { get; set; }
Property Value
Type | Description |
---|---|
ChartEmptyPointSettings | The default value is null |
EnableComplexProperty
This property used to improve chart performance via data mapping for series dataSource.
Declaration
[HtmlAttributeName("enableComplexProperty")]
public bool EnableComplexProperty { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableSolidCandles
This property is applicable for candle series. It enables/disables to visually compare the current values with the previous values in stock.
Declaration
[HtmlAttributeName("enableSolidCandles")]
public bool EnableSolidCandles { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableTooltip
If set true, the Tooltip for series will be visible.
Declaration
[HtmlAttributeName("enableTooltip")]
public bool EnableTooltip { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
ErrorBar
Options for displaying and customizing error bar for individual point in a series.
Declaration
[HtmlAttributeName("errorBar")]
public ChartErrorBarSettings ErrorBar { get; set; }
Property Value
Type | Description |
---|---|
ChartErrorBarSettings | The default value is null |
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
[HtmlAttributeName("fill")]
public string Fill { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
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
[HtmlAttributeName("groupName")]
public string GroupName { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
High
The DataSource field that contains the high value of y It is applicable for series and technical indicators
Declaration
[HtmlAttributeName("high")]
public string High { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
IntermediateSumIndexes
Defines the collection of indexes of the intermediate summary columns in waterfall charts.
Declaration
[HtmlAttributeName("intermediateSumIndexes")]
public int[] IntermediateSumIndexes { get; set; }
Property Value
Type | Description |
---|---|
System.Int32[] | The default value is null |
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
[HtmlAttributeName("isClosed")]
public bool IsClosed { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
LegendImageUrl
The URL for the Image that is to be displayed as a Legend icon. It requires legendShape
value to be an Image
.
Declaration
[HtmlAttributeName("legendImageUrl")]
public string LegendImageUrl { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
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 Image
Declaration
[HtmlAttributeName("legendShape")]
public LegendShape LegendShape { get; set; }
Property Value
Type | Description |
---|---|
LegendShape | The default value is LegendShape.SeriesType |
Low
The DataSource field that contains the low value of y It is applicable for series and technical indicators
Declaration
[HtmlAttributeName("low")]
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
[HtmlAttributeName("marker")]
public ChartMarkerSettings Marker { get; set; }
Property Value
Type | Description |
---|---|
ChartMarkerSettings | The default value is null |
MaxRadius
Maximum radius
Declaration
[HtmlAttributeName("maxRadius")]
public double MaxRadius { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 3 |
MinRadius
Minimum radius
Declaration
[HtmlAttributeName("minRadius")]
public double MinRadius { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 1 |
Name
The name of the series visible in legend.
Declaration
[HtmlAttributeName("name")]
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
NegativeFillColor
Defines the visual representation of the negative changes in waterfall charts.
Declaration
[HtmlAttributeName("negativeFillColor")]
public string NegativeFillColor { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "#C64E4A" |
NonHighlightStyle
Custom style for the non-highlighted series or points.
Declaration
[HtmlAttributeName("nonHighlightStyle")]
public string NonHighlightStyle { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Opacity
The opacity of the series.
Declaration
[HtmlAttributeName("opacity")]
public double Opacity { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 1 |
Open
The DataSource field that contains the open value of y It is applicable for series and technical indicators
Declaration
[HtmlAttributeName("open")]
public string Open { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
ParetoOptions
Options for customizing the pareto line series.
Declaration
[HtmlAttributeName("paretoOptions")]
public ChartParetoOptions ParetoOptions { get; set; }
Property Value
Type | Description |
---|---|
ChartParetoOptions | The default value is null |
PointColorMapping
The DataSource field that contains the color value of point It is applicable for series
Declaration
[HtmlAttributeName("pointColorMapping")]
public string PointColorMapping { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
Query
Specifies query to select data from DataSource. This property is applicable only when the DataSource is ej.DataManager
.
Declaration
[HtmlAttributeName("query")]
public string Query { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
SegmentAxis
Defines the axis, based on which the line series will be split.
Declaration
[HtmlAttributeName("segmentAxis")]
public Segment SegmentAxis { get; set; }
Property Value
Type | Description |
---|---|
Segment | The default value is null |
Segments
Defines the collection of regions that helps to differentiate a line series.
Declaration
[HtmlAttributeName("segments")]
public List<ChartSegment> Segments { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<ChartSegment> | The default value is null |
SelectionStyle
Custom style for the selected series or points.
Declaration
[HtmlAttributeName("selectionStyle")]
public string SelectionStyle { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
ShowMean
If set true, the mean value for box and whisker will be visible.
Declaration
[HtmlAttributeName("showMean")]
public bool ShowMean { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
ShowNormalDistribution
The normal distribution of histogram series.
Declaration
[HtmlAttributeName("showNormalDistribution")]
public bool ShowNormalDistribution { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
Size
The DataSource field that contains the size value of y
Declaration
[HtmlAttributeName("size")]
public string Size { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
SplineType
Defines type of spline to be rendered.
Declaration
[HtmlAttributeName("splineType")]
public SplineType SplineType { get; set; }
Property Value
Type | Description |
---|---|
SplineType | The default value is SplineType.Natural |
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
[HtmlAttributeName("stackingGroup")]
public string StackingGroup { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
SumIndexes
Defines the collection of indexes of the overall summary columns in waterfall charts.
Declaration
[HtmlAttributeName("sumIndexes")]
public int[] SumIndexes { get; set; }
Property Value
Type | Description |
---|---|
System.Int32[] | The default value is null |
SummaryFillColor
Defines the visual representation of the summaries in waterfall charts.
Declaration
[HtmlAttributeName("summaryFillColor")]
public string SummaryFillColor { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "#4E81BC" |
TooltipFormat
user can format now each series tooltip format separately.
Declaration
[HtmlAttributeName("tooltipFormat")]
public string TooltipFormat { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
TooltipMappingName
The provided value will be considered as a Tooltip name
Declaration
[HtmlAttributeName("tooltipMappingName")]
public string TooltipMappingName { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
Trendlines
Defines the collection of trendlines that are used to predict the trend
Declaration
[HtmlAttributeName("trendlines")]
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 are Line Column Area Bar Histogram StackingColumn StackingArea StackingBar StepLine StepArea Scatter Spline StackingColumn100 StackingBar100 StackingArea100 RangeColumn Hilo HiloOpenClose Waterfall RangeArea SplineRangeArea Bubble Candle Polar Radar BoxAndWhisker Pareto
Declaration
[HtmlAttributeName("type")]
public ChartSeriesType Type { get; set; }
Property Value
Type | Description |
---|---|
ChartSeriesType | The default value is ChartSeriesType.Line |
UnSelectedStyle
Custom style for the deselected series or points.
Declaration
[HtmlAttributeName("unSelectedStyle")]
public string UnSelectedStyle { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Visible
Specifies the visibility of series.
Declaration
[HtmlAttributeName("visible")]
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 financial series and technical indicators
Declaration
[HtmlAttributeName("volume")]
public string Volume { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
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
[HtmlAttributeName("width")]
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
[HtmlAttributeName("xAxisName")]
public string XAxisName { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
XName
The DataSource field that contains the x value. It is applicable for series and technical indicators
Declaration
[HtmlAttributeName("xName")]
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
[HtmlAttributeName("yAxisName")]
public string YAxisName { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
YName
The DataSource field that contains the y value.
Declaration
[HtmlAttributeName("yName")]
public string YName { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
ZOrder
The z order of the series.
Declaration
[HtmlAttributeName("zOrder")]
public double ZOrder { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 0 |