Class CommonSeriesOptions

Inheritance
System.Object
EJTagHelper
CommonSeriesOptions
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Syncfusion.JavaScript.DataVisualization.Models
Assembly: Syncfusion.EJ.dll
Syntax
public class CommonSeriesOptions : EJTagHelper

Constructors

CommonSeriesOptions()

Declaration
public CommonSeriesOptions()

Properties

AnimationDuration

Gets or sets the animation duration value to animate the series which specifies the Animation duration value to animate the series

Declaration
[JsonProperty("animationDuration")]
public string AnimationDuration { get; set; }
Property Value
Type Description
System.String
Remarks

Animation duration value to animate the series

AnimationType

Gets or sets the value for EnableAnimation which Enable/disable the animation of all the series.

Declaration
[JsonProperty("animationType")]
[JsonConverter(typeof(StringEnumConverter))]
public SeriesAnimationType AnimationType { get; set; }
Property Value
Type Description
SeriesAnimationType
Remarks

Enable/disable the animation of all the series.

BearFillColor

Gets or sets the value for BearFillColor which specifies the Color of the point, where the close is up in financial chart.

Declaration
[JsonProperty("bearFillColor")]
public string BearFillColor { get; set; }
Property Value
Type Description
System.String
Remarks

Color of the point, where the close is up in financial chart.

Border

Gets or sets the value for Border which specifies Options for customizing the border of all the series.

Declaration
[JsonProperty("border")]
public ChartBorder Border { get; set; }
Property Value
Type Description
ChartBorder
Remarks

Options for customizing the border of all the series.

BoxPlotMode

Gets or sets the BoxPlotMode of series which specifies the type of BoxPlotSeries in chart.

Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("boxPlotMode")]
public BoxPlotMode BoxPlotMode { get; set; }
Property Value
Type Description
BoxPlotMode
Remarks

Specifies the type of BoxPlotSeries.

BubbleOptions

Gets or sets the value for BubbleOptions which specifies Options for modifying the bubbleoption of the bubble series

Declaration
[JsonProperty("bubbleOptions")]
public BubbleOptions BubbleOptions { get; set; }
Property Value
Type Description
BubbleOptions
Remarks

Options for modifying the bubbleoption of the bubble series

BullFillColor

Gets or sets the value for BullFillColor which specifies the Color of the point, where the close is down in financial chart.

Declaration
[JsonProperty("bullFillColor")]
public string BullFillColor { get; set; }
Property Value
Type Description
System.String
Remarks

Color of the point, where the close is down in financial chart.

CardinalSplineTension

Gets or sets the value for cardinal spline tension which customize the shape of the cardinal curve.

Declaration
[JsonProperty("cardinalSplineTension")]
public double CardinalSplineTension { get; set; }
Property Value
Type Description
System.Double
Remarks

Customize the shape of the cardinal curve

Close

Gets or sets the value for Close which specifies Name of the property in the data source that contains close value for the series.

Declaration
[JsonProperty("close")]
public string Close { get; set; }
Property Value
Type Description
System.String
Remarks

Name of the property in the data source that contains close value for the series.

ColumnFacet

Gets or sets the value for ColumnFacet which specifies the type of shape to be used for series.

Declaration
[JsonProperty("columnFacet")]
[JsonConverter(typeof(StringEnumConverter))]
public ColumnFacet ColumnFacet { get; set; }
Property Value
Type Description
ColumnFacet
Remarks

Specifies the type of shape to be used for series.

ColumnSpacing

Gets or sets the value which specifies the spacing between columns of different series.

Declaration
[JsonProperty("columnSpacing")]
public double ColumnSpacing { get; set; }
Property Value
Type Description
System.Double
Remarks

Spacing between columns of different series

ColumnWidth

Gets or sets the value for column width which specifies the Width of a column in column type series.

Declaration
[JsonProperty("columnWidth")]
public double ColumnWidth { get; set; }
Property Value
Type Description
System.Double
Remarks

Width of a column in column type series.

ConnectorLine

Gets or sets the value for ConnectorLine which specifies options for customizing the connector line of the series.

Declaration
[JsonProperty("connectorLine")]
public ConnectorLineStyle ConnectorLine { get; set; }
Property Value
Type Description
ConnectorLineStyle
Remarks

Options for customizing the connector line of the series.

CornerRadius

Gets or sets the value for CornerRadius which specifies the Options for customizing the corner radius for the column series

Declaration
[JsonProperty("cornerRadius")]
public CornerRadius CornerRadius { get; set; }
Property Value
Type Description
CornerRadius
Remarks

Options for customizing the corner radius for the column series

DashArray

Gets or sets the value for DashArray which Pattern of dashes and gaps used to stroke the line type series.

Declaration
[JsonProperty("dashArray")]
public string DashArray { get; set; }
Property Value
Type Description
System.String
Remarks

Pattern of dashes and gaps used to stroke the line type series.

DataSource

Gets or sets the value for DataSource which specifies  DataSource in series in chart control.

Declaration
[HtmlAttributeName("datasource")]
[JsonProperty("dataSource")]
[JsonConverter(typeof(ChartSQLDataConverter))]
public object DataSource { get; set; }
Property Value
Type Description
System.Object
Remarks

DataSource in series.

DoughnutCoefficient

Gets or sets the value for DoughnutCoefficient which Controls the size of the hole in doughnut series. Value ranges from 0 to 1.

Declaration
[JsonProperty("doughnutCoefficient")]
public double DoughnutCoefficient { get; set; }
Property Value
Type Description
System.Double
Remarks

Controls the size of the hole in doughnut series. Value ranges from 0 to 1.

DoughnutSize

Gets or sets the value for DoughnutSize which Controls the size of the doughnut series.

Declaration
[JsonProperty("doughnutSize")]
public double DoughnutSize { get; set; }
Property Value
Type Description
System.Double
Remarks

Controls the size of the doughnut series. Value ranges from 0 to 1.

DragSettings

Gets or sets the DragOptions of series which specifies the Options for dragging the series point.

Declaration
[JsonProperty("dragSettings")]
public DragSettings DragSettings { get; set; }
Property Value
Type Description
DragSettings
Remarks

Options for dragging the series point.

DrawMode

Gets or sets the value for DrawMode which Specifies the mode of drawing in chart control.

Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("drawMode")]
public SeriesDrawMode DrawMode { get; set; }
Property Value
Type Description
SeriesDrawMode
Remarks

Specifies the mode of drawing.

DrawType

Gets or sets the value for DrawType which specifies Type of series to be drawn in radar or polar series.

Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("drawType")]
public DrawType DrawType { get; set; }
Property Value
Type Description
DrawType
Remarks

Type of series to be drawn in radar or polar series.

EmptyPointSettings

Gets or sets the value for EmptyPointsSettings which  Specifies options for customizing the empty points.

Declaration
[JsonProperty("emptyPointSettings")]
public EmptyPointSettings EmptyPointSettings { get; set; }
Property Value
Type Description
EmptyPointSettings
Remarks

Specifies options for customizing the empty points.

EnableAnimation

Gets or sets the value for EnableAnimation which Enable/disable the animation of all the series.

Declaration
[JsonProperty("enableAnimation")]
public bool EnableAnimation { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Enable/disable the animation of all the series.

EnableTrackTooltip

Gets or sets the value for enableTrackTooltip which Specifies whether to show crosshair trackball tooltip in multiple series.

Declaration
[JsonProperty("enableTrackTooltip")]
public bool EnableTrackTooltip { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Specifies whether to show crosshair trackball tooltip in multiple series.

EndAngle

Gets or sets the value for EndAngle which specifies the End angle of pie/doughnut series.

Declaration
[JsonProperty("endAngle")]
public double? EndAngle { get; set; }
Property Value
Type Description
System.Nullable<System.Double>
Remarks

End angle of pie/doughnut series. For a complete circle, it has to be 360, by default.

Errorbar

Gets or sets the value for ErrorBar which Specifies options for customizing the ErrorBar.

Declaration
[JsonProperty("errorBar")]
public ErrorBar Errorbar { get; set; }
Property Value
Type Description
ErrorBar
Remarks

Specifies options for customizing the ErrorBar.

Explode

Gets or sets the value for Explode which specifies the Explodes the pie/doughnut slices on mouse move.

Declaration
[JsonProperty("explode")]
public bool Explode { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Explodes the pie/doughnut slices on mouse move.

ExplodeAll

Gets or sets the value for ExplodeAll which specifies the Explodes all the slice of pie/doughnut on render.

Declaration
[JsonProperty("explodeAll")]
public bool ExplodeAll { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Explodes all the slice of pie/doughnut on render.

ExplodeIndex

Gets or sets the value for ExplodeIndex which specifies the Index of the point to be exploded from pie/doughnut/pyramid/funnel.

Declaration
[JsonProperty("explodeIndex")]
public int? ExplodeIndex { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>
Remarks

Index of the point to be exploded from pie/doughnut/pyramid/funnel.

ExplodeOffset

Gets or sets the value for ExplodeOffset which Specifies the distance of the slice from the center, when it is exploded.

Declaration
[JsonProperty("ExplodeOffset")]
public double ExplodeOffset { get; set; }
Property Value
Type Description
System.Double
Remarks

Specifies the distance of the slice from the center, when it is exploded.

Fill

Gets or sets the value for Fill which specifies the fill color of all the series in chart.

Declaration
[JsonProperty("fill")]
public string Fill { get; set; }
Property Value
Type Description
System.String
Remarks

Fill color of all the series.

Font

Gets or sets the value for Font which specifies options for customizing the Font.

Declaration
[JsonProperty("font")]
public ChartFont Font { get; set; }
Property Value
Type Description
ChartFont
Remarks

Specifies options for customizing the Font.

FunnelHeight

Gets or sets the value for FunnelHeight which Specifies the height of the funnel in funnel series.

Declaration
[JsonProperty("funnelHeight")]
public string FunnelHeight { get; set; }
Property Value
Type Description
System.String
Remarks

Specifies the height of the funnel in funnel series. Values can be in both pixel and percentage.

FunnelWidth

Gets or sets the value for FunnelWidth which Specifies the width of the funnel in funnel series.

Declaration
[JsonProperty("funnelWidth")]
public string FunnelWidth { get; set; }
Property Value
Type Description
System.String
Remarks

Specifies the width of the funnel in funnel series. Values can be in both pixel and percentage.

GapRatio

Gets or sets the value for GapRatio which specifies the Gap between the slices of pyramid/funnel series.

Declaration
[JsonProperty("gapRatio")]
public double GapRatio { get; set; }
Property Value
Type Description
System.Double
Remarks

Gap between the slices of pyramid/funnel series.

GapWidth

Gets or sets the value for GapWidth which specifies the Gap between two pie's in pieofpie seriestype.

Declaration
[JsonProperty("gapWidth")]
public double GapWidth { get; set; }
Property Value
Type Description
System.Double
Remarks

Gap between two pie's in pieofpie seriestype.

High

Gets or sets the value for High which specifies Name of the property in the data source that contains high value for the series.

Declaration
[JsonProperty("high")]
public string High { get; set; }
Property Value
Type Description
System.String
Remarks

Name of the property in the data source that contains high value for the series.

HighlightSettings

Gets or sets the value for HighlightSettings which specifies Options for customizing the appearance of the series while highlighting.

Declaration
[JsonProperty("highlightSettings")]
public HighlightSettings HighlightSettings { get; set; }
Property Value
Type Description
HighlightSettings
Remarks

Options for customizing the appearance of the series or data point while highlighting.

IsClosed

Gets or sets the value for IsClosed which Specifies whether to join start and end point of a line/area series

Declaration
[JsonProperty("isClosed")]
public bool IsClosed { get; set; }
Property Value
Type Description
System.Boolean
Remarks

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

IsStacking

Gets or sets the value for IsStacking which Specifies whether to stack the column series in polar/radar charts.

Declaration
[JsonProperty("isStacking")]
public bool IsStacking { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Specifies whether to stack the column series in polar/radar charts.

LabelPosition

Gets or sets the value for LabelPosition which Position of the data label in pie/doughnut/pyramid/funnel series.

Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("labelPosition")]
public ChartLabelPosition LabelPosition { get; set; }
Property Value
Type Description
ChartLabelPosition
Remarks

Position of the data label in pie/doughnut/pyramid/funnel series. OutsideExtended position is not applicable for pyramid/funnel.

LineCap

Gets or sets the value for LineCap which specifies the LineCap of all the series in chart.

Declaration
[JsonConverter(typeof(StringEnumConverter))]
[JsonProperty("lineCap")]
public ChartLineCap LineCap { get; set; }
Property Value
Type Description
ChartLineCap
Remarks

LineCap of all the series.

LineJoin

Gets or sets the value for LineJoin which specifies the type of shape to be used where two lines meet.

Declaration
[JsonProperty("lineJoin")]
[JsonConverter(typeof(StringEnumConverter))]
public ChartLineJoin LineJoin { get; set; }
Property Value
Type Description
ChartLineJoin
Remarks

Specifies the type of shape to be used where two lines meet.

Low

Gets or sets the value for Low which specifies Name of the property in the data source that contains low value for the series.

Declaration
[JsonProperty("low")]
public string Low { get; set; }
Property Value
Type Description
System.String
Remarks

Name of the property in the data source that contains low value for the series.

Marker

Gets or sets the value for Marker.Marker contains shapes and/or data labels in chart control.

Declaration
[JsonProperty("marker")]
public Marker Marker { get; set; }
Property Value
Type Description
Marker
Remarks

Options for displaying and customizing marker for individual point in a series. Marker contains shapes and/or data labels.

Opacity

Gets or sets the value for Opacity which specifies the opacity of all the series in chart.

Declaration
[JsonProperty("opacity")]
public double Opacity { get; set; }
Property Value
Type Description
System.Double
Remarks

Opacity of all the series.

Open

Gets or sets the value for Open which specifies Name of the property in the data source that contains open value for the series.

Declaration
[JsonProperty("open")]
public string Open { get; set; }
Property Value
Type Description
System.String
Remarks

Name of the property in the data source that contains open value for the series.

OutlierSettings

Gets or sets the Outlier of the boxplot series which specifies the Options for customizing the outlier.

Declaration
[JsonProperty("outlierSettings")]
public OutlierSettings OutlierSettings { get; set; }
Property Value
Type Description
OutlierSettings
Remarks

Options for customizing the outlier.

PieCoefficient

Gets or sets the value for PieCoefficient which Controls the size of pie series.

Declaration
[JsonProperty("pieCoefficient")]
public double PieCoefficient { get; set; }
Property Value
Type Description
System.Double
Remarks

Controls the size of pie series. Value ranges from 0 to 1.

PieOfPieCoefficient

Gets or sets the value for PieOfPieCoefficient which Controls the size of pieofpie series.

Declaration
[JsonProperty("pieOfPieCoefficient")]
public double PieOfPieCoefficient { get; set; }
Property Value
Type Description
System.Double
Remarks

Controls the size of pieofpie series. Value ranges from 0 to 1.

PositiveFill

Fill color for the positive column of the waterfall which specifies the column of the waterfall.

Declaration
[JsonProperty("positiveFill")]
public string PositiveFill { get; set; }
Property Value
Type Description
System.String

PyramidMode

Gets or sets the value for PyramidMode which Specifies the mode of the pyramid series.

Declaration
[JsonProperty("pyramidMode")]
[JsonConverter(typeof(StringEnumConverter))]
public PyramidMode PyramidMode { get; set; }
Property Value
Type Description
PyramidMode
Remarks

Specifies the mode of the pyramid series.

Query

Gets or sets the value for Query whcih specifies the Specifies the value for query in chart.

Declaration
[JsonProperty("query")]
[JsonConverter(typeof(QueryConverter))]
public string Query { get; set; }
Property Value
Type Description
System.String
Remarks

Specifies the value for query.

SelectionSettings

Gets or sets the value for SelectionSettings which Options for customizing the appearance of the series/data point on selection.

Declaration
[JsonProperty("selectionSettings")]
public SelectionSettings SelectionSettings { get; set; }
Property Value
Type Description
SelectionSettings
Remarks

Options for customizing the appearance of the series/data point on selection.

ShowMedian

Declaration
[JsonProperty("showMedian")]
public bool ShowMedian { get; set; }
Property Value
Type Description
System.Boolean

Size

Gets or sets the value for Size in chart which specifies options for Size in chart control.

Declaration
[JsonProperty("size")]
public string Size { get; set; }
Property Value
Type Description
System.String
Remarks

Specifies options for Size.

SplineType

Gets or sets the spline series type which specifies the type of spline in chart control.

Declaration
[JsonProperty("splineType")]
[JsonConverter(typeof(StringEnumConverter))]
public SplineType SplineType { get; set; }
Property Value
Type Description
SplineType
Remarks

Specifies the type of spline.

SplitMode

Gets or sets the mode for pieofpie series split which Specifies the split mode for pieofpie.

Declaration
[JsonProperty("splitMode")]
[JsonConverter(typeof(StringEnumConverter))]
public SplitMode SplitMode { get; set; }
Property Value
Type Description
SplitMode
Remarks

Specifies the split mode for pieofpie.

SplitValue

Gets or sets the SplitValue for pieofpie which specifies the SplitValue of pieofpie series.

Declaration
[JsonProperty("splitValue")]
public string SplitValue { get; set; }
Property Value
Type Description
System.String
Remarks

SplitValue of pieofpie series

StackingGroup

Gets or sets the value for StackingGroup which specifies the value of stacking group in chart.

Declaration
[JsonProperty("stackingGroup")]
public string StackingGroup { get; set; }
Property Value
Type Description
System.String
Remarks

Specified the value of stacking group.

StartAngle

Gets or sets the value for StartAngle which specifies the Start angle from where the pie/doughnut series renders

Declaration
[JsonProperty("startAngle")]
public double? StartAngle { get; set; }
Property Value
Type Description
System.Nullable<System.Double>
Remarks

Start angle from where the pie/doughnut series renders. It starts from 0, by default.

Tooltip

Gets or sets the value for Tooltip which specifies the Options for customizing the tooltip of chart.

Declaration
[JsonProperty("tooltip")]
public NewTooltip Tooltip { get; set; }
Property Value
Type Description
NewTooltip
Remarks

Options for customizing the tooltip of chart.

Type

Gets or sets the value for Type which specifies the type of the series to render in chart.

Declaration
[JsonProperty("type")]
[JsonConverter(typeof(StringEnumConverter))]
public SeriesType Type { get; set; }
Property Value
Type Description
SeriesType
Remarks

Specifies the type of the series to render in chart.

VisibleOnLegend

gets or sets the value for legend visibility which specifies the series name to be displayed in the legend.

Declaration
[JsonProperty("visibleOnLegend")]
[JsonConverter(typeof(StringEnumConverter))]
public VisibleOnLegend VisibleOnLegend { get; set; }
Property Value
Type Description
VisibleOnLegend
Remarks

series name to be displayed in the legend

Width

Gets or sets the value for Width which specfies the width of the series in chart control

Declaration
[JsonProperty("width")]
public double Width { get; set; }
Property Value
Type Description
System.Double
Remarks

Width of all the series.

XName

Gets or sets the value for XName which specifies Name of the property in the data source that contains x value for the series.

Declaration
[JsonProperty("xName")]
public string XName { get; set; }
Property Value
Type Description
System.String
Remarks

Name of the property in the data source that contains x value for the series.

YName

Gets or sets the value for YName which specifies the  YName in data source in chart control.

Declaration
[JsonProperty("yName")]
public string YName { get; set; }
Property Value
Type Description
System.String
Remarks

YName in data source.

Methods

ShouldSerializeBorder()

Declaration
public bool ShouldSerializeBorder()
Returns
Type Description
System.Boolean

ShouldSerializeConnectorLine()

Declaration
public bool ShouldSerializeConnectorLine()
Returns
Type Description
System.Boolean

ShouldSerializeDragSettings()

Declaration
public bool ShouldSerializeDragSettings()
Returns
Type Description
System.Boolean

ShouldSerializeEmptyPointSettings()

Declaration
public bool ShouldSerializeEmptyPointSettings()
Returns
Type Description
System.Boolean

ShouldSerializeErrorbar()

Declaration
public bool ShouldSerializeErrorbar()
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

ShouldSerializeOutlierSettings()

Declaration
public bool ShouldSerializeOutlierSettings()
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