Series
configurationThe configuration of the chart series.
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.
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.
Default: "max"
series.autoFit
BooleanIf set to true, the Chart automatically scales down to fit the content area. Applicable for the Pie and Donut series.
The
autoFitoption is supported when series.type is set to "pie" or "donut".
Default: false
series.axis
Stringseries.border
ObjectThe border of the chart series.
The
borderoption is supported when series.type is set to "bar", "column", "donut", "pie", "bubble", "boxPlot", "candlestick", "ohlc" or "candlestick".
series.categoryAxis
StringThe name of the category axis to use for the series.
The first axis will be used if no categoryAxis is specified.
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.
Default: "category"
series.closeField
StringThe data field containing the close value.
The
closeFieldoption is supported when series.type is set to "candlestick" or "ohlc".
Default: "close"
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 item field which contains the series color.
The
colorFieldoption is supported when series.type
is set to "bar", "column", "rangeBar", "rangeColumn", "bubble", "donut", "pie", "candlestick", "ohlc" or "waterfall".
Default: "color"
series.connectors
ObjectThe label connectors options.
The
connectorsoption is supported when series.type is set to "donut" or "pie" and
series.labels.visible is set to true.
series.currentField
StringThe data item field containing the current value.
The
currentFieldoption is supported when series.type is set to "bullet" or "verticalBullet".
Default: "current"
series.dashType
StringThe dash type of line chart.
The
dashTypeoption is taken into consideration only if the series.type option is set to "line".
The following dash types are supported:
- "dash" - a line consisting of dashes
- "dashDot" - a line consisting of a repeating pattern of dash-dot
- "dot" - a line consisting of dots
- "longDash" - a line consisting of a repeating pattern of long-dash
- "longDashDot" - a line consisting of a repeating pattern of long-dash-dot
- "longDashDotDot" - a line consisting of a repeating pattern of long-dash-dot-dot
- "solid" - a solid line
Default: "solid"
series.data
ArrayThe array of data items which represent the series data.
Can be set to :
- Array of objects. Each point is bound to the field specified via the series.field option.
- Array of numbers. Supported when the series.type option is set to "area", "bar", "column", "donut", "pie", "line" or "waterfall".
- Array of arrays of numbers. Supported when the series.type option is set to "bubble", "scatter", "scatterLine", "ohlc", "rangeBar", "rangeArea" or polar series.
- Bubble series need arrays of three values - X value, Y value and Size value e.g.
[1, 1, 10] - Scatter and scatter line series need arrays of two values - X value and Y value
- OHLC and candlestick series need arrays of four values - open, high, low and close
- RangeBar and RangeArea series need arrays of two values - the from and to value.
- Bubble series need arrays of three values - X value, Y value and Size value e.g.
series.downColor
String|FunctionThe series color when the open value is greater than the close value.
The
downColoroption is supported when series.type is set to "candlestick".
series.downColorField
StringThe data field containing the color applied when the open value is greater than the close value.
The
downColorFieldoption is supported when series.type is set to "candlestick".
Default: "downColor"
series.drilldownField
StringThe data field which contains the value to use to drill down into detailed data for the point.
series.drilldownSeriesFactory
FunctionA function that creates the drilldown series for a given point.
The function should accept a single parameter, the point drilldownField value.
The function should return a series configuration object or a Promise that resolves to one.
Important - The function must return exactly one series object. Returning an array of series is not supported.
series.dynamicHeight
BooleanThe
dynamicHeightoption is supported when series.type is set to "funnel" or "pyramid".
When set to false all segments become with the same height, otherwise the height of each segment is based on its value.
Default: true
series.dynamicSlope
BooleanThe
dynamicSlopeoption is supported when series.type is set to "funnel".
When set to true the ratio of the bases of each segment is calculated based on the ratio of currentDataItem.value/nextDataItem.value The last element is always created like a rectangle since there is no following element.
Default: false
series.errorBars
ObjectThe error bars of the chart series.
The
errorBarsoption is supported when series.type is set to "bar", "column", "line", "area", "scatter", "scatterLine" or "bubble".
series.errorHighField
StringThe data item field which contains the series.errorBars high value.
The
errorHighFieldoption is supported when series.type is set to "bar", "column", "line" or "area".
Default: "errorHigh"
series.errorLowField
StringThe data item field which contains the series.errorBars low value.
The
errorLowFieldoption is supported when series.type is set to "bar", "column", "line" or "area".
Default: "errorLow"
series.explodeField
StringThe data item field which contains a boolean value indicating whether the sector is exploded.
The
explodeFieldoption is supported when series.type is set to "donut" or "pie".
Default: "explode"
series.extremes
ObjectThe chart series extremes configuration. Applies to extreme outliers. Also check series.outliers.
series.field
StringThe data item field which contains the series value. The field name should be a valid Javascript identifier and should contain only alphanumeric characters (or "$" or "_"), and may not start with a digit.
Default: "value"
series.focusHighlight
ObjectThe focus highlight configuration options.
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.fromField
StringThe data item field which contains the series from value.
Default: "min"
series.gap
NumberThe distance between categories expressed as a percentage of the bar width.
See the related spacing setting.
The
gapoption is supported when series.type is set to "bar", "column", "candlestick", "ohlc", "radarColumn" or "waterfall".
Default: 1.5
series.highField
StringThe data field containing the high value.
The
highFieldoption is supported when series.type is set to "candlestick" or "ohlc".
Default: "high"
series.highlight
ObjectThe chart series highlighting configuration options.
series.holeSize
NumberThe radius of the donut hole in pixels.
The
holeSizeoption is supported when series.type is set to "donut".
series.labels
ObjectThe chart series label configuration.
The chart displays the series labels when the series.labels.visible option is set to
true.
series.legendItem
ObjectThe configuration of the Chart legend item for this series.
series.line
String|ObjectThe chart line configuration options.
The
lineoption is supported when the series.type option is set to "area", "candlestick", "ohlc" or "waterfall".
series.lowField
StringThe data field containing the low value.
The
lowFieldoption is supported when series.type is set to "candlestick" or "ohlc".
Default: "low"
series.lowerField
StringThe data item field which contains the series lower value.
Default: "lower"
series.margin
Number|ObjectThe margin around each donut series (ring). A numeric value will set all margins.
Default: 1
series.markers
ObjectThe chart series marker configuration.
The chart displays the series labels when the series.markers.visible option is set to
true. Themarkersoption is supported when series.type is set to "area", "rangeArea", "line", "scatter", "scatterLine", "radarLine", "radarArea", "polarLine", "polarScatter" or "polarArea".
series.maxSize
NumberThe maximum size of the chart bubble series marker.
Default: 100
series.mean
ObjectThe configuration of the Box Plot mean value indicator (line).
series.meanField
StringThe data item field which contains the series mean value.
Default: "mean"
series.median
ObjectThe configuration of the Box Plot median value indicator (line).
series.medianField
StringThe data item field which contains the series median value.
Default: "median"
series.minSize
NumberThe minimum size of the chart bubble series marker.
Default: 5
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", "rangeArea", "line", "scatterLine", "radarLine", "radarArea", "polarLine" or "polarArea".
series.name
StringThe name of the chart series which is visible in the legend.
series.neckRatio
NumberneckRatio specifies the ratio top-base/bottom-base of the whole chart. neckRatio set to three means the top base is three times smaller than the bottom base.
The
neckRatiooption is supported when series.type is set to "funnel" and dynamicSlope set tofalse.
Default: 0.3
series.negativeColor
StringThe color to use for bar, column or waterfall series with negative values. Accepts a valid CSS color string, including hex and rgb.
series.negativeValues
ObjectThe options for displaying the chart negative bubble values.
series.noteTextField
StringThe data item field which contains the series note text.
Default: "noteText"
series.notes
ObjectThe series notes configuration.
series.opacity
NumberThe series opacity. By default the series are opaque.
Default: 1
series.openField
StringThe data field containing the open value.
The
openFieldoption is supported when series.type is set to "candlestick" or "ohlc".
series.outliers
ObjectThe chart series outliers configuration. Applies to mild outliers. Also check series.extremes.
series.outliersField
StringThe data item field which contains the series outliers value.
Default: "outliers"
series.overlay
ObjectThe chart series overlay options.
series.padding
NumberThe padding around the chart (equal on all sides).
The
paddingoption is supported when series.type is set to "donut" or "pie".
series.pattern
ObjectThe configuration options of the series pattern.
The pattern inherits the
series.coloras main color and accepts an optionalbackgroundcolor.
series.patternField
StringThe data item field which contains the series pattern configuration for individual chart segments.
The
patternFieldoption is supported when series.type
is set to "pie", "donut", "funnel", "heatmap", or "pyramid".
series.q1Field
StringThe data item field which contains the series q1 value. This configuration is available only for box plot charts.
Default: "q1"
series.q3Field
StringThe data item field which contains the series q3 value. This configuration is available only for box plot charts.
Default: "q3"
series.segmentSpacing
NumberThe space in pixels between the different segments of the funnel and pyramid charts.
The
segmentSpacingoption is supported when series.type is set to "funnel" or "pyramid".
Default: 0
series.size
NumberThe or radius of the chart donut series in pixels. If not set, the available space is split evenly between the series.
series.sizeField
StringThe data field containing the bubble size value.
Default: "size"
series.spacing
NumberThe distance between series points within a category. Expressed as a percentage of the bar width.
See the related gap setting.
The
spacingoption is supported when series.type is set to "bar", "column", "candlestick", "ohlc" or "radarColumn".
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" or "radarColumn". All series in the stack must be of the same type.
Stack settings of the first series are inherited as a default value by the rest of the series, in case they are not overridden.
Default: false
series.startAngle
NumberThe start angle (degrees) of the first donut or pie segment.
Angles increase clockwise and zero is to the left. Negative values are acceptable.
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", "scatterLine", "radarLine" or "polarLine".
The
stepvalue is only supported when series.type is set to "line".
The
smoothoptions is not supported for stacked area series with missing values.
Default: "normal"
series.summaryField
StringThe data item field which contains the summary type for waterfall series. Summary columns are optional and can be one of two types:
- "runningTotal" - Displays the sum of all items since the last "runningTotal" point.
- "total" - Displays the sum of all previous items.
The value, if any, of a data item marked as a summary point will be discarded.
Default: "summary"
series.target
ObjectThe configuration options of the target
The
targetoption is supported when series.type is set to "bullet" or "verticalBullet".
series.targetField
StringThe data item field containing the target value.
The
currentFieldoption is supported when series.type is set to "bullet" or "verticalBullet".
Default: "target"
series.toField
StringThe data item field which contains the series to value.
Default: "max"
series.tooltip
ObjectThe chart series tooltip configuration options.
The chart series tooltip is displayed when the series.tooltip.visible option is set to
true.
series.trendline
ObjectThe trendline configuration options.
The
trendlineoption is supported when series.type is set to "linearTrendline", "exponentialTrendline", "logarithmicTrendline", "powerTrendline", "polynomialTrendline" or "movingAverageTrendline".
series.type
StringThe type of the series.
The supported values are:
areabarbubblebulletcandlestickcolumndonutfunnelpyramidheatmaphorizontalWaterfalllinelinearTrendlineexponentialTrendlinelogarithmicTrendlinepowerTrendlinepolynomialTrendlinemovingAverageTrendlineohlcpiepolarAreapolarLinepolarScatterradarArearadarColumnradarLinerangeArearangeBarrangeColumnscatterscatterLineverticalAreaverticalBoxPlotverticalBulletverticalLineverticalRangeAreawaterfall
Different chart types expect data in specific formats:
- Simple values:
[1, 2, 3, 4]- Line, Area, Column, Bar - Category-value objects:
[{category: "A", value: 10}]- Pie, Donut, Funnel, Pyramid - Two-value arrays:
[[x, y], [x, y]]- Scatter, Range charts - Three-value arrays:
[[x, y, size]]- Bubble charts - Four-value arrays:
[[open, high, low, close]]- Candlestick, OHLC - Five-value arrays:
[[min, q1, median, q3, max]]- Box Plot - Target-current objects:
[{current: 750, target: 1000}]- Bullet charts
Default: "column"
series.upperField
StringThe data item field which contains the series upper value.
Default: "upper"
series.visible
BooleanSets the visible property of a chart series
Default: true
series.visibleInLegend
BooleanA value indicating whether to show the point category name (for funnel, pyramid, donut and pie series) or series name (for other available series types) in the legend.
Default: true
The data item field which indicates whether to show the point category name in the legend.
The
visibleInLegendFieldoption is supported when series.type is set to "funnel", "pyramid", "donut" or "pie".
series.visual
FunctionA function that can be used to create a custom visual for the points. Applicable for bar, column, pie, donut, funnel, pyramid, line, scatterLine, rangeBar, rangeColumn and waterfall series. The available argument fields are:
- rect - the
kendo.geometry.Rectthat defines where the visual should be rendered. - options - the point options.
- createVisual - a function that can be used to get the default visual.
- category - the point category.
- dataItem - the point dataItem.
- value - the point value.
- stackValue - the cumulative point value on the stack. Available only for stackable series.
- sender - the chart instance.
- series - the point series.
- percentage - the point value represented as a percentage value. Available only for donut, pie and 100% stacked charts.
- runningTotal - the sum of point values since the last "runningTotal" summary point. Available for waterfall series.
- total - the sum of all previous series values. Available for waterfall series.
- radius - the segment radius. Available for donut and pie series.
- innerRadius - the segment inner radius. Available for donut series.
- startAngle - the segment start angle. Available for donut and pie series.
- endAngle - the segment end angle. Available for donut and pie series.
- center - the segment center point. Available for donut and pie series.
- points - the segment points. Available for funnel, pyramid, line and scatterLine series.
series.whiskers
ObjectThe chart series whiskers configuration.
The appearance settings for the BoxPlot whiskers.
series.width
NumberThe line width.
The
widthoption is supported when series.type is set to "line", "scatterLine", "radarLine" or "polarLine".
series.xAxis
StringThe name of the X axis to use.
The
xAxisoption is supported when series.type is set to "bubble", "scatter", "scatterLine" or polar series.
For polar series the xAxis range is expressed in degrees.
Default: "primary"
series.xErrorHighField
StringThe data item field which contains the series.errorBars xAxis high value.
The
xErrorHighFieldoption is supported when series.type is set to "scatter", "scatterLine" or "bubble".
Default: "xErrorHigh"
series.xErrorLowField
StringThe data item field which contains the series.errorBars xAxis low value.
The
xErrorLowFieldoption is supported when series.type is set to "scatter", "scatterLine" or "bubble".
Default: "xErrorLow"
series.xField
StringThe data item field containing the X value.
The
xFieldoption is supported when series.type is set to "bubble", "scatter", "scatterLine" or polar series.
Default: "x"
series.yAxis
StringThe name of the Y axis to use.
** Available for bubble, scatter, scatterLine and polar series. **
Default: "primary"
series.yErrorHighField
StringThe data item field which contains the series.errorBars yAxis high value.
The
yErrorHighFieldoption is supported when series.type is set to "scatter", "scatterLine" or "bubble".
Default: "yErrorHigh"
series.yErrorLowField
StringThe data item field which contains the series.errorBars yAxis low value.
The
yErrorLowFieldoption is supported when series.type is set to "scatter", "scatterLine" or "bubble".
Default: "yErrorLow"
series.yField
StringThe data item field containing the Y value.
The
yFieldoption is supported when series.type is set to "bubble", "scatter" or "scatterLine".
Default: "y"
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.