Class ChartSeries
Inheritance
Inherited Members
Namespace: Syncfusion.JavaScript.DataVisualization.Models
Assembly: Syncfusion.EJ.dll
Syntax
public class ChartSeries
Constructors
ChartSeries()
Declaration
public ChartSeries()
Properties
AnimationDuration
Gets or sets the animationDuration value, which provides an option to customize the duration time for rendering the series.
Declaration
[JsonProperty("animationDuration")]
public string AnimationDuration { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Specifies animation duration for series.
BearFillColor
Gets or sets the bearFillColor value, which customizes point color when close value is up in financial chart.
Declaration
[JsonProperty("bearFillColor")]
public string BearFillColor { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Specifies bear fill color for series
Border
Gets or sets the border value, which provides an option to customize border color, width and dash array of series.
Declaration
[JsonProperty("border")]
public ChartBorder Border { get; set; }
Property Value
Type | Description |
---|---|
ChartBorder |
Remarks
Specifies border for series.
BoxPlotMode
Gets or sets the boxPlotMode value, which provides an option to customize box plot series in three different ways.
Declaration
[JsonProperty("boxPlotMode")]
public BoxPlotMode BoxPlotMode { get; set; }
Property Value
Type | Description |
---|---|
BoxPlotMode |
Remarks
Specifies box plot mode for series.
BubbleOptions
Gets or sets the bubbleOptions, which provides an option to customize the data points of bubble series in chart.
Declaration
[JsonProperty("bubbleOptions")]
public BubbleOptions BubbleOptions { get; set; }
Property Value
Type | Description |
---|---|
BubbleOptions |
Remarks
Options for customizing bubble series.
BullFillColor
Gets or sets the bullFillColor value, which customizes point color when close value is down in financial chart.
Declaration
[JsonProperty("bullFillColor")]
public string BullFillColor { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Specifies bull fill color for series
Close
Gets or sets the close, which is the property name in data source that containes close value for series.
Declaration
[JsonProperty("close")]
public string Close { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Specifies close name for series.
CornerRadius
Gets or sets the cornerRadius value, which takes numeric value to customize the radius of four columns of the column series.
Declaration
[JsonProperty("cornerRadius")]
public CornerRadius CornerRadius { get; set; }
Property Value
Type | Description |
---|---|
CornerRadius |
Remarks
Options for customizing corner radius.
DashArray
Gets or sets the dashArray value, which provides an option to customize dashes and gaps of line series type strokes.
Declaration
[JsonProperty("dashArray")]
public string DashArray { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Specifies series dash array.
DataSource
Gets or sets the dataSource, which specifies array of JSON objects or data manager instance to render chart series.
Declaration
[JsonProperty("dataSource")]
[JsonConverter(typeof(DataManagerConverter))]
public object DataSource { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
Remarks
Sepcfies datasource for series.
DoughnutCoefficient
Gets or sets the doughnutCoefficient value, which controls the doughnut series hole size whose values ranges from 0 to 1.
Declaration
[JsonProperty("doughnutCoefficient")]
public float DoughnutCoefficient { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Remarks
Specifies doughnutCoefficient size of doughnut series.
DoughnutSize
Gets or sets the doughnutSize value, which controls the doughnut series size whose values ranges from 0 to 1.
Declaration
[JsonProperty("doughnutSize")]
public float DoughnutSize { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Remarks
Specifies size of the doughnut series.
DragSettings
Gets or sets the dragSettings value, which provides an option to drag the points based on drag settings option.
Declaration
[JsonProperty("dragSettings")]
public object DragSettings { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
Remarks
Specifies dragsettings for series.
DrawMode
Gets or sets the drawMode value, which provides options to customize the draw modes of hilo open close series.
Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("drawMode")]
public SeriesDrawMode DrawMode { get; set; }
Property Value
Type | Description |
---|---|
SeriesDrawMode |
Remarks
Specifies drawMode for hiloopenclose.
DrawType
Gets or sets the drawType value, which provides an option to customize polar radar series draw types like line, area or column.
Declaration
[JsonProperty("drawType")]
[JsonConverter(typeof(StringEnumConverter))]
public DrawType DrawType { get; set; }
Property Value
Type | Description |
---|---|
DrawType |
Remarks
Specifies draw type of polar or radar series.
EmptyPointSettings
Gets or sets the emptyPointSettings, which provides an option to customize empty points specified in the chart series.
Declaration
[JsonProperty("emptyPointSettings")]
public EmptyPointSettings EmptyPointSettings { get; set; }
Property Value
Type | Description |
---|---|
EmptyPointSettings |
Remarks
Options for customizing empty points.
EnableAnimation
Gets or sets the enableAnimation value, which provides an option to animates pie or doughnut series slices.
Declaration
[JsonProperty("enableAnimation")]
public bool EnableAnimation { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Enables or disables animation.
EnableSmartLabels
Gets or sets the enableSmartLabels value, which avoids the overlapping of chart series data labels smartly.
Declaration
[JsonProperty("enableSmartLabels")]
public bool EnableSmartLabels { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Enables or disables smart labels for series.
EndAngle
Gets or sets the endAngle value, which specifies an end angle where the points of pie or doughnut to be rendered.
Declaration
[JsonProperty("endAngle")]
public double EndAngle { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
Remarks
Specifies endAngle of pie or doughnut.
Explode
Gets or sets the explode value, which explodes the pie or doughnut slices on mouse move over the chart series points.
Declaration
[JsonProperty("explode")]
public bool Explode { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Specifies explode for series.
ExplodeAll
Gets or sets the explodeAll value, which provides an option to explode the data points of pie or doughnut series.
Declaration
[JsonProperty("explodeAll")]
public bool ExplodeAll { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Explodes all slices of pie or doughnut series.
ExplodeIndex
Gets or sets the explodeIndex value, which explodes the specified point in a series based on provided index value.
Declaration
[JsonProperty("explodeIndex")]
public int ExplodeIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Remarks
Specifies explode index for series points.
ExplodeOffset
Gets or sets the explodeOffset value, which specifies the distance of pie or doughnut slice from center position when it is exploded.
Declaration
[JsonProperty("explodeOffset")]
public float ExplodeOffset { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Remarks
Specifies explode offset value of pie or doughnut series.
Fill
Gets or sets the fill value, which provides an option to apply fill color for series data points in chart.
Declaration
[JsonProperty("fill")]
public string Fill { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Specifies series points fill color.
Font
Gets or sets the font value, which provides an option to customize the family, size, color, opacity and weight of series font.
Declaration
[JsonProperty("font")]
public ChartFont Font { get; set; }
Property Value
Type | Description |
---|---|
ChartFont |
Remarks
Options for customizing series font.
FunnelHeight
Gets or sets the funnelHeight, which provides an option to customize height of the funnel whose values can be percentage or pixel.
Declaration
[JsonProperty("funnelHeight")]
public string FunnelHeight { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Specifies height of funnel series.
FunnelWidth
Gets or sets the funnelWidth, which provides an option to customize width of the funnel whose values can be pixel or percentage.
Declaration
[JsonProperty("funnelWidth")]
public string FunnelWidth { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Specifies width of funnel series.
GapRatio
Gets or sets the gapRatio value, which specifies the gap between slices of pyramid or funnel type series, whose value ranges from 0 to 1.
Declaration
[JsonProperty("gapRatio")]
public float GapRatio { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Remarks
Specifies gapRatio of pie or doughnut.
GapWidth
Gets or sets the gapWidth value, which provides an option to customize the distance between two pie's in pieOfPie series.
Declaration
[JsonProperty("gapWidth")]
public float GapWidth { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Remarks
Specifies gap between two pie's.
High
Gets or sets the high, which is the property name in data source that containes high value for series.
Declaration
[JsonProperty("high")]
public string High { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Specifies high name for series.
HighlightSettings
Gets or sets the highlightSettings value, which provides an option to customize appearance of data point or series while highlighting.
Declaration
[JsonProperty("highlightSettings")]
public HighlightSettings HighlightSettings { get; set; }
Property Value
Type | Description |
---|---|
HighlightSettings |
Remarks
Options for highlighting series or points.
LabelPosition
Gets or sets the labelPosition value, which provides an option to customize position of data labels in accumulation series.
Declaration
[JsonProperty("labelPosition")]
[JsonConverter(typeof(StringEnumConverter))]
public ChartLabelPosition LabelPosition { get; set; }
Property Value
Type | Description |
---|---|
ChartLabelPosition |
Remarks
Specifies data label position of accumulation series.
LineCap
Gets or sets the lineCap value, which provides an option to customize the series line cap like butt, round and sqaure.
Declaration
[JsonProperty("lineCap")]
[JsonConverter(typeof(StringEnumConverter))]
public ChartLineCap LineCap { get; set; }
Property Value
Type | Description |
---|---|
ChartLineCap |
Remarks
Specifies line cap of the series.
LineJoin
Gets or sets the lineJoin value, which provides an option to customize series line shapes like round, bevel and milter.
Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("lineJoin")]
public ChartLineJoin LineJoin { get; set; }
Property Value
Type | Description |
---|---|
ChartLineJoin |
Remarks
Specifies line join of the series.
Low
Gets or sets the low, which is the property name in data source that containes low value for series.
Declaration
[JsonProperty("low")]
public string Low { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Specifies low name for series.
Marker
Gets or sets the marker value, which provides an option to customize the marker for individual point in a series.
Declaration
[JsonProperty("marker")]
public Marker Marker { get; set; }
Property Value
Type | Description |
---|---|
Marker |
Remarks
Specifies marker options for series.
Name
Gets or sets the name value, which provides an option to customize name of the series that is to be displayed in legend.
Declaration
[JsonProperty("name")]
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Specifies name of the series.
Opacity
Gets or sets the opacity value, which provides an option to customize opacity of each series data points in chart.
Declaration
[JsonProperty("opacity")]
public double Opacity { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
Remarks
Specifies opacity for series points.
Open
Gets or sets the open, which is the property name in data source that containes open value for series.
Declaration
[JsonProperty("open")]
public string Open { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Specifies open name for series.
OutlierSettings
Gets or sets the outlierSettings value, which provides an option to customize outlier settings of box and whisker series.
Declaration
[JsonProperty("outlierSettings")]
public object OutlierSettings { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
Remarks
Specifies outliersettings of box plot series.
PieCoefficient
Gets or sets the pieCoefficient value, which controls the pie series circle size whole values ranges from 0 to 1.
Declaration
[JsonProperty("pieCoefficient")]
public float PieCoefficient { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Remarks
Specifies coefficient value of pie series.
PieOfPieCoefficient
Gets or sets the pieOfPieCoefficient value, which controls the second pie size in pieOfPie series, whose values ranges from 0 to 1.
Declaration
[JsonProperty("pieOfPieCoefficient")]
public float PieOfPieCoefficient { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Remarks
Specifies coefficient value of pieOfPie series.
PointColorMappingName
Gets or sets the pointColorMappingName, which is the property name in data source that containes fill color for series.
Declaration
[JsonProperty("pointColorMappingName")]
public string PointColorMappingName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Specifies fill color name for series.
Points
Gets or sets the points, which provides an option to add data points, each point have x and y value in chart series.
Declaration
[JsonProperty("points")]
public PointCollection Points { get; set; }
Property Value
Type | Description |
---|---|
PointCollection |
Remarks
Options for customizing data points.
PyramidMode
Gets or sets the pyramidMode value, which provides an option to customize mode like linear or surface of the pyramid series.
Declaration
[JsonProperty("pyramidMode")]
[JsonConverter(typeof(StringEnumConverter))]
public PyramidMode PyramidMode { get; set; }
Property Value
Type | Description |
---|---|
PyramidMode |
Remarks
Specifies the mode for pyramid series.
Query
Gets or sets the query, which specifies query to select the data from the ej.DataManager datasource.
Declaration
[JsonConverter(typeof(QueryConverter))]
[JsonProperty("query")]
public string Query { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Specifies query for series.
SelectionSettings
Gets or sets the value for selectionSettings, which provides an option to customize appearance of data point or series on selection.
Declaration
[JsonProperty("selectionSettings")]
public SelectionSettings SelectionSettings { get; set; }
Property Value
Type | Description |
---|---|
SelectionSettings |
Remarks
Options for selection series or points.
Size
Gets or sets the size, which is the property name in data source that containes size value for series.
Declaration
[JsonProperty("size")]
public string Size { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Specifies size name for series.
SplitMode
Gets or sets the split mode value, which specifies the mode for splitting the pie of pie series data points.
Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("splitMode")]
public SplitMode SplitMode { get; set; }
Property Value
Type | Description |
---|---|
SplitMode |
Remarks
Specifies mode for splitting pieOfPie series points.
SplitValue
Gets or sets the splitValue, in which based on provided split value, the pieOfPie series is splitted into two pie's.
Declaration
[JsonProperty("splitValue")]
public string SplitValue { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Specifies split value for pieOfPie series.
StartAngle
Gets or sets the startAngle value, which specifies an angle from where the points of pie or doughnut to be rendered.
Declaration
[JsonProperty("startAngle")]
public double StartAngle { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
Remarks
Specifies startAngle of pie or doughnut.
Tooltip
Gets or sets the tooltip, which provides an option to customize tooltip values that to be displayed while hovering the series data points.
Declaration
[JsonProperty("tooltip")]
public NewTooltip Tooltip { get; set; }
Property Value
Type | Description |
---|---|
NewTooltip |
Remarks
Options for customizing series tooltip.
Type
Gets or sets the type value, which specifies the type of series to be rendered in chart based on provided value.
Declaration
[JsonProperty("type")]
[JsonConverter(typeof(StringEnumConverter))]
public SeriesType Type { get; set; }
Property Value
Type | Description |
---|---|
SeriesType |
Remarks
Specifies type of series.
Visibility
Gets or sets the visibility value, which controls the visibility of series, whether it to be rendered or not.
Declaration
[JsonProperty("visibility")]
public bool Visibility { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
Enables or disables series visibility.
VisibleOnLegend
Gets or sets the legend visibility value, which controls the visibility of legend items either to be visible or hidden.
Declaration
[JsonProperty("visibleOnLegend")]
[JsonConverter(typeof(StringEnumConverter))]
public VisibleOnLegend VisibleOnLegend { get; set; }
Property Value
Type | Description |
---|---|
VisibleOnLegend |
Remarks
Enables or disables the legend items.
Width
Gets or sets the width value, which provides an option to customize the width of the series to be rendered.
Declaration
[JsonProperty("width")]
public double Width { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
Remarks
Specifies width of the series.
XAxisName
Gets or sets the xAxis name, which associates the axis with series based on the provided x axis name in series.
Declaration
[JsonProperty("xAxisName")]
public string XAxisName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Specifies name of x axis.
XName
Gets or sets the xName, which is the property name in the datasource that contains x value for the series.
Declaration
[JsonProperty("xName")]
public string XName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Specifies xName for series.
YAxisName
Gets or sets the yAxis name, which associates the axis with series based on the provided y axis name in series.
Declaration
[JsonProperty("yAxisName")]
public string YAxisName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Specifies type of series.
YName
Gets or sets the yName, which is the property name in data source that containes y value for series.
Declaration
[JsonProperty("yName")]
public string YName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Specifies y name for series.
ZOrder
Gets or sets the zOrder value, which specifies order in which each series to be rendered based on provided zOrder value.
Declaration
[JsonProperty("zOrder")]
public int ZOrder { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Remarks
Specifies zOrder of series.
Methods
ShouldSerializeBorder()
Declaration
public bool ShouldSerializeBorder()
Returns
Type | Description |
---|---|
System.Boolean |
ShouldSerializeBubbleOptions()
Declaration
public bool ShouldSerializeBubbleOptions()
Returns
Type | Description |
---|---|
System.Boolean |
ShouldSerializeCornerRadius()
Declaration
public bool ShouldSerializeCornerRadius()
Returns
Type | Description |
---|---|
System.Boolean |
ShouldSerializeEmptyPointSettings()
Declaration
public bool ShouldSerializeEmptyPointSettings()
Returns
Type | Description |
---|---|
System.Boolean |
ShouldSerializeFont()
Declaration
public bool ShouldSerializeFont()
Returns
Type | Description |
---|---|
System.Boolean |
ShouldSerializeHighlightSettings()
Declaration
public bool ShouldSerializeHighlightSettings()
Returns
Type | Description |
---|---|
System.Boolean |
ShouldSerializeMarker()
Declaration
public bool ShouldSerializeMarker()
Returns
Type | Description |
---|---|
System.Boolean |
ShouldSerializePoints()
Declaration
public bool ShouldSerializePoints()
Returns
Type | Description |
---|---|
System.Boolean |
ShouldSerializeSelectionSettings()
Declaration
public bool ShouldSerializeSelectionSettings()
Returns
Type | Description |
---|---|
System.Boolean |
ShouldSerializeTooltip()
Declaration
public bool ShouldSerializeTooltip()
Returns
Type | Description |
---|---|
System.Boolean |