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.
The supported values are:
- "avg" - the average of all values for the date period.
- "count" - the number of values for the date period.
- "max" - the highest value for the date period.
- "min" - the lowest value for the date period.
- "sum" - the sum of all values for the date period. Defaults to 0 if no data points are defined.
- "sumOrNull" - the sum of all values for the date period. Defaults to
nullif no data points are defined. - "first" - the first value
- function(values, series, dataItems, category) - user-defined aggregate function. Returns single value or data item.
- object - (compound aggregate)Applicable to "candlestick" and ohlc "series". Specifies the aggregate for each data item field.
Default: "max"
series.axis
StringThe name of the value axis to use.
Applicable to area, bar, column and line series
Default: "primary"
series.border
ObjectThe border of the points.
Applicable to bar, column and pie series
series.categoryField
StringThe data field containing the point category name.
Applicable to pie series.
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 bar, column and pie series.
series.connectors
ObjectThe label connectors options.
Applicable to pie 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, bar, column, pie and line series.
series.explodeField
StringThe data field containing a Boolean value that indicates if the sector is exploded.
Available for pie series
series.field
StringThe data field containing the series value.
series.gap
NumberThe distance between category clusters.
Applicable for bar and column series.
Default: 1.5
series.highlight
ObjectConfigures the appearance of highlighted points.
series.labels
ObjectConfigures the series data labels.
series.line
String | ObjectLine options.
Applicable to area series.
series.markers
ObjectMarker options.
Applicable to 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", "line", "scatterLine", "radarLine", "radarArea", "polarLine" or "polarArea".
series.name
StringThe series name.
The name can also be a template which sets the name of the series when bound to grouped data source.
The fields which can be used in the template are:
- series - the series options
- group - the data group
- group.field - the name of the field used for grouping
- group.value - the field value for this group.
series.negativeColor
StringColor to use for bars with negative values.
Applicable only to bar and column series.
series.notes
ObjectThe series notes configuration.
series.opacity
NumberThe series opacity.
series.overlay
ObjectThe effects overlay.
series.padding
NumberThe padding around the chart (equal on all sides).
Available for pie series.
series.size
NumberThe size (or radius) of the series in pixels. If not specified, the available space is split evenly between the series.
Available for only.
series.spacing
NumberSpace between points as proportion of the point width.
Available for bar and column 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".
Stack settings of the first series are applied to the rest of the series.
Default: false
series.startAngle
NumberThe start angle of the first segment.
Available for pie series.
Default: 90
series.style
StringThe supported values are:
- "normal" - The values will be connected with straight line.
- "step" - The values will be connected with a line with right angle.
- "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.
Available for pie series
series.tooltip
ObjectThe data point tooltip configuration options.
series.type
StringThe type of the series. Available types:
- area
- column (synonym: bar)
- line
- pie
- bullet
Default: "line"
series.width
NumberThe line width.
Available for line series
Default: 0.5
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. For example line series will be on top with bar and area following below.