Series
configurationArray of series definitions.
The series type is determined by the value of the type field. If a type value is missing, the type is assumed to be the one specified in seriesDefaults.
Each series type has a different set of options.
Info: Some options accept function as argument. They will be evaluated for each point (supplied as parameter). The theme/seriesDefaults value will be used if no value is returned.
series
Arrayseries.aggregate
String|FunctionThe aggregate function to apply for date series.
This function is used when a category (an year, month, etc.) contains two or more points. The function return value is displayed instead of the individual points.
Default: "max"
series.axis
StringThe name of the value axis to use.
** Applicable to area, column, line, ohlc and candlestick series **
Default: "primary"
series.border
ObjectThe border of the points.
** Applicable to column, ohlc and candlestick series **
series.categoryField
StringThe data item field which contains the category name or date.
The points will be rendered in chronological order if the category is a date.
If specified, the dateField option is used as a default.
Default: "category"
series.closeField
StringThe data field containing the close value.
series.color
String|FunctionThe series base color. The supported values are:
- CSS color string, including hex and rgb
- function(point) - user-defined function that will be evaluated for each point. Returning
undefinedwill assume the default series color.
series.colorField
StringThe data field containing the point color.
** Applicable for column, candlestick and ohlc series. **
series.currentField
StringThe data field containing the current value.
** Available for bullet and verticalBullet series. **
series.dashType
StringThe series line dash type.
** Applicable only to line series **
"solid"
Specifies a solid line.
"dot"
Specifies a line consisting of dots.
"dash"
Specifies a line consisting of dashes.
"longDash"
Specifies a line consisting of a repeating pattern of long-dash.
"dashDot"
Specifies a line consisting of a repeating pattern of dash-dot.
"longDashDot"
Specifies a line consisting of a repeating pattern of long-dash-dot.
"longDashDotDot"
Specifies a line consisting of a repeating pattern of long-dash-dot-dot.
Default: "solid"
series.data
ArrayArray of data items. The data item type can be either a:
- Array of objects. Each point is bound to the specified series fields.
- Array of numbers. Available for area, column and line series.
- Array of arrays of numbers. Available for:
- OHLC and candlestick series (open, high, low, close)
series.downColor
String|FunctionThe series color when the open value is greater than the close value.
series.downColorField
StringThe data field containing the color applied when the open value is greater than the close value.
** Available for candlestick series only **
series.field
StringThe data field containing the series value.
series.for
StringThe name of the parent series of the trendline.
The
foroption is supported when series.type is set to "linearTrendline", "exponentialTrendline", "logarithmicTrendline", "powerTrendline", "polynomialTrendline" or "movingAverageTrendline".
series.gap
NumberThe distance between category clusters.
** Applicable for column, candlestick and ohlc series. **
Default: 1.5
series.highField
StringThe data field containing the high value.
** Available for candlestick and ohlc series only **
series.highlight
ObjectConfigures the appearance of highlighted points.
series.labels
Objectseries.legendItem
ObjectThe configuration of the Chart legend item for this series.
series.line
String | ObjectLine options.
** Applicable to area, candlestick and ohlc series. **
series.lowField
StringThe data field containing the low value.
** Available for candlestick and ohlc series **
series.markers
ObjectMarker options.
** Applicable for area and line series. **
series.missingValues
StringThe behavior for handling missing values. The supported values are:
- "gap" - the plot stops before the missing point and continues after it.
- "interpolate" - the value is interpolated from neighboring points.
- "zero" - the value is assumed to be zero.
The default value is "interpolate", except for "area" and stacked series which default to "zero".
The
missingValuesoption is supported when series.type is set to "area" and "line".
series.name
StringThe series name visible in the legend.
series.negativeColor
StringColor to use for bars with negative values.
** Applicable only to column series. **
series.notes
ObjectThe series notes configuration.
series.opacity
NumberThe series opacity.
series.openField
StringThe data field containing the open value.
** Available for candlestick and ohlc series **
series.overlay
ObjectThe effects overlay.
series.spacing
NumberSpace between points as proportion of the point width.
Available for column, candlestick and ohlc series.
Default: 0.4
series.stack
Boolean|String|ObjectA boolean value indicating if the series should be stacked. A string value is interpreted as series.stack.group.
The
stackoptions is supported when series.type is set to "bar", "column", "line", "area", "verticalLine", "verticalArea", "radarLine", "radarArea" and "radarColumn".
Default: false
series.style
StringThe supported values are:
- "normal" - The values will be connected with straight line.
- "step" - The values will be connected with a line at right.
- "smooth" - The values will be connected with a smooth line.
The default value is "normal".
The
styleoption is supported when series.type is set to "line".
Default: "normal"
series.target
ObjectThe target of the bullet chart.
series.targetField
StringThe data field containing the target value.
** Available for bullet and verticalBullet series. **
series.tooltip
ObjectThe data point tooltip configuration options.
series.trendline
ObjectThe trendline configuration options.
The
trendlineoption is supported when series.type is set to "linearTrendline", "exponentialTrendline", "logarithmicTrendline", "powerTrendline" or "movingAverageTrendline".
series.type
StringThe type of the series. Available types:
areacandlestickcolumnexponentialTrendlinelinelinearTrendlinelogarithmicTrendlinemovingAverageTrendlineohlcpolynomialTrendlinepowerTrendline
series.visibleInLegend
BooleanA value indicating whether to show the series name in the legend.
Default: true
series.width
NumberThe line width.
** Applicable for area and line series. **
series.zIndex
NumberAn optional Z-index that can be used to change the default stacking order of series.
The series with the highest Z-index will be placed on top.
Series with no Z-index will use the default stacking order based on series type.