Series Types StackedSplineSeries

Describes settings supported by a series of the stacked spline type.

Type: Object

argumentField

Specifies which data source field provides arguments for series points.

Type: String
Default Value: 'arg'
Cannot be used in themes.

In the Cartesian coordinate system, each point is characterized by a pair of coordinates (X, Y). In the Chart widget, X's are provided by the argumentField; Y's are provided by the valueField.

NOTE: Certain series types have more than one value field, or require additional data fields to be set. Refer to the valueField option description for details.

Commonly, a chart contains several series, and many of them have the same argument field. In this case, assign the name of this field to the argumentField property of the commonSeriesSettings object. If a series must have a unique argument field, specify the same property, but do so in the series object within the series array.

axis

Binds the series to a value axis.

Type: String
Default Value: undefined

When there are multiple value axes in a chart, series need to know exactly which axis they are bound to. By default, all of them are bound to the first axis in the valueAxis array. To bind a series to another axis, assign the name of the axis to the axis series property.

View Demo

color

Specifies the color of the series.

Type: String
Default Value: undefined

This option supports the following colors.

Specified in the commonSeriesSettings object, this option colors all series in the chart. To color an individual series, specify this option in the series object within the series array.

dashStyle

Specifies the dash style of the series line. Applies only to line-like series.

Type: String
Default Value: 'solid'
Accepted Values: 'solid' | 'longDash' | 'dash' | 'dot'

This option accepts one of the following values.

  • solid
    Displays a solid, continuous series line.
  • dash
    Displays the series line using short dashes.
  • longDash
    Displays the series line using long dashes.
  • dot
    Displays the series line using dots.
  • Any combination of 'longDash', 'dash' and 'dot'
    Displays the series line by repeating the specified combination. For example, 'dashdotdash'.

hoverMode

Specifies series elements to be highlighted when a user points to a series.

Type: String
Default Value: 'nearestPoint'
Accepted Values: 'nearestPoint' | 'includePoints' | 'excludePoints' | 'none'

When a user points to a series, it may react in one of the following ways depending on the value of the hoverMode option.

hoverMode Result
"nearestPoint"
"includePoints"
"excludePoints"
"none"
See Also
  • hoverStyle - specifies the appearance of series in the hover state.
  • point | hoverMode - specifies the hover mode of series points.

hoverStyle

Configures the appearance adopted by the series when a user points to it.

Type: Object

Declared in commonSeriesSettings, hoverStyle applies to all series in the chart. Declared in a series configuration object, hoverStyle applies to this particular series only. The series-specific hoverStyle overrides the common one.

ignoreEmptyPoints

Specifies whether the series should ignore null data points.

Type: Boolean
Default Value: false

Data points that have the null argument or value do not produce actual series points. Because of this, series of continuous types (line, spline, area, etc.) may be drawn with unnecessary gaps where missing points should have been. To remove these gaps, set the ignoreEmptyPoints option to true.

label

Configures point labels.

Type: Object

Declared in commonSeriesSettings, the label settings apply to all point labels in the chart. Declared in a series configuration object, the label settings apply only to the point labels that belong to this particular series. The series-specific label settings override the common ones.

See Also
  • customizeLabel - сustomizes the appearance of an individual point label.

maxLabelCount

Specifies a limit for the number of point labels.

Type: Number
Default Value: undefined

If the number of points in a series increases over time, there comes a time when it becomes so massive that displaying labels for them makes the chart too cluttered. In this instance, to keep the chart clear to the viewer, specify a limit for the number of point labels using the maxLabelCount option. Once this limit is exceeded, all point labels of the series will be hidden.

pane

Specifies which pane the series should belong to. Accepts the name of the pane.

Type: String
Default Value: 'default'

If this option is not specified, the series will belong to the default pane.

See Also
  • panes - declares a collection of panes.

View Demo

point

Configures series points in scatter, line- and area-like series.

Type: Object

Declared in commonSeriesSettings, the point settings apply to all points in the chart. Declared in a series configuration object, the point settings apply only to the points that belong to this particular series. The series-specific point settings override the common ones.

See Also
  • customizePoint - сustomizes the appearance of an individual series point.

selectionMode

Specifies series elements to be highlighted when a user selects a series.

Type: String
Default Value: 'includePoints'
Accepted Values: 'includePoints' | 'excludePoints' | 'none'

NOTE: Though not provided out of the box, the selection capability can be implemented using the widget API. Refer to the onSeriesClick option description for details.

When a user selects a series, it may react in one of the following ways depending on the value of the selectionMode option.

selectionMode Result
"includePoints"
"excludePoints"
"none"
See Also
  • seriesSelectionMode - specifies whether only one or several series can stay selected.
  • series | selectionStyle - specifies the appearance of a series in the selected state.
  • series | point | selectionMode - specifies the selection mode of series points.
  • seriesSelectionChanged - an event that fires after the selection state of a series has been changed.

selectionStyle

Configures the appearance adopted by the series when a user selects it.

Type: Object

NOTE: Though not provided out of the box, the selection capability can be implemented using the widget API. Refer to the onPointClick option description for details.

Declared in commonSeriesSettings, selectionStyle applies to all series in the chart. Declared in a series configuration object, selectionStyle applies to this particular series only. The series-specific selectionStyle overrides the common one.

showInLegend

Specifies whether to show the series in the legend or not.

Type: Boolean
Default Value: true

tagField

Specifies which data source field provides auxiliary data for series points.

Type: String
Default Value: 'tag'
Cannot be used in themes.

This option allows you to associate virtually any required data with a series point. This data will be stored in the tag field of the Point object.

Commonly, a chart contains several series, and many of them have the same tagField value. In this case, specify the tagField property in the commonSeriesSettings object. If a series must have a unique tagField value, specify the same property, but do so in the series object within the series array.

See Also
  • series | tag - associates data with an entire series.

valueField

Specifies which data source field provides values for series points.

Type: String
Default Value: 'val'
Cannot be used in themes.

In the Cartesian coordinate system, each point is characterized by a pair of coordinates (X, Y). In a common case, X's are provided by the argumentField; Y's are provided by the valueField.

Certain series types require more than one value field, because their points are characterized by a larger number of coordinates. These series types are:

  • Range-like series types
    Range bar and range area require two value fields: rangeValue1Field and rangeValue2Field.
  • Financial series types
    Stock and candlestick require four value fields: openValueField, closeValueField, highValueField and lowValueField.

If you use a series template, specify the value field properties in the commonSeriesSettings object. Otherwise, do this in the series object within the series array.

visible

Specifies whether the series is visible or not.

Type: Boolean
Default Value: true

NOTE: When the series is invisible, the marker of its legend item is faded.

See Also
  • Series | show() - shows the series at runtime.
  • Series | hides() - hides the series at runtime.

width

Specifies the width of the series line in pixels. Applies only to line-like series.

Type: Number
Default Value: 2