All Components
Components

SeriesItemComponent

The configuration component for a series item.

Selector

kendo-chart-series-item

Inputs

aggregate any

The 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 null if no data points are defined.
  • "first"—The first value.
  • function(values, series, dataItems, category)—User-defined aggregate function. Returns a single value or a data item.
  • object(compound aggregate)—Applicable to the "candlestick", "boxPlot", and "ohlc" series. Specifies the aggregate for each data item field.

axis string

The name of the value axis to use.

The axis option is supported for scatter plots. For scatter plots, refer to xAxis and yAxis.

border Border

The border of the Chart series.

The border option is supported when series.type is set to "bar", "column", "donut", "pie", "bubble", "boxPlot", "candlestick", "ohlc", or "candlestick".

categoryAxis string

The name of the category axis to use for the series.

If no categoryAxis is specified, the first axis is used.

categoryField string

The data item field which contains the category name or date.

If the category is a date, the points are rendered in chronological order.

closeField string

The data field containing the close value.

The closeField option is supported when series.type is set to "candlestick" or "ohlc".

color any

The series base color. The supported values are:

  • CSS color string, including hex and rgb.
  • function(point)—A user-defined function that is evaluated for each point. Returning undefined assumes the default series color.

colorField string

The data item field which contains the series color.

The colorField option is supported when series.type is set to "bar", "column", "rangeBar", "rangeColumn", "bubble", "donut", "pie", "candlestick", "ohlc", or "waterfall".

connectors LabelConnectors

The label connectors options.

The connectors option is supported when series.type is set to "donut" or "pie" and series.labels.visible is set to true`.

currentField string

The data item field containing the current value.

The currentField option is supported when series.type is set to "bullet" or "verticalBullet".

dashType DashType

The dash type of line Chart.

The dashType option 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.

data any[]

The 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 the "bubble", "scatter", "scatterLine", "ohlc", or "polar" series. The Bubble series need arrays of three values - X value, Y value, and Size value—for example, [1, 1, 10]Scatter. The Scatter Line series need arrays of two values - X value and Y valueOHLC. The Candlestick series need arrays of four values - open, high, low, and close.

downColor string

The series color when the open value is greater than the close value.

The downColor option is supported when series.type is set to "candlestick".

downColorField string

The data field containing the color applied when the open value is greater than the close value.

The downColorField option is supported when series.type is set to "candlestick".

dynamicHeight boolean

The dynamicHeight option is supported when series.type is set to "funnel".

When set to false, all segments become with the same height. Otherwise, the height of each segment is based on its value.

dynamicSlope boolean

The dynamicSlope option 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.

errorBars any

The error bars of the Chart series.

The errorBars option is supported when series.type is set to "bar", "column", "line", "area", "scatter", "scatterLine", or "bubble".

errorHighField string

The data item field which contains the series.errorBars high value.

The errorHighField option is supported when series.type is set to "bar", "column", "line", or "area".

errorLowField string

The data item field which contains the series.errorBars low value.

The errorLowField option is supported when series.type is set to "bar", "column", "line", or "area".

explodeField string

The data item field which contains a Boolean value indicating whether the sector is exploded.

The explodeField option is supported when series.type is set to "donut" or "pie".

extremes any

The Chart series extremes configuration. Applies to extreme outliers. For more information, refer to series.outliers.

field string

The data item field which contains the series value.

fromField string

The data item field which contains the series from value.

gap number

The distance between categories expressed as a percentage of the bar width.

See the related spacing setting.

The gap option is supported when series.type is set to "bar", "column", "candlestick", "ohlc", "radarColumn", or "waterfall".

highField string

The data field containing the high value.

The highField option is supported when series.type is set to "candlestick" or "ohlc".

highlight any

The Chart series highlighting configuration options.

holeSize number

The diameter of the donut hole in pixels.

The holeSize option is supported when series.type is set to "donut".

labels any

The Chart series label configuration.

The Chart displays the series labels when the series.labels.visible option is set to true.

line SeriesLine

The Chart line configuration options.

The line option is supported when the series.type option is set to "area", "candlestick", "ohlc", or "waterfall".

lowField string

The data field containing the low value.

The lowField option is supported when series.type is set to "candlestick" or "ohlc".

lowerField string

The data item field which contains the series lower value.

margin Margin | number

The margin around each donut series (ring). A numeric value sets all margins.

markers any

The Chart series marker configuration.

The Chart displays the series labels when the series.markers.visible option is set to true. The markers option is supported when series.type is set to "area", "line", "scatter", "scatterLine", "radarLine", "radarArea", "polarLine", "polarScatter", or "polarArea".

maxSize number

The maximum size of the chart bubble series marker.

meanField string

The data item field which contains the series mean value.

medianField string

The data item field which contains the series median value.

minSize number

The minimum size of the Chart bubble series marker.

missingValues string

The 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 the "area" and stacked series which default to "zero".

The missingValues option is supported when series.type is set to "area", "line", "scatterLine", "radarLine", "radarArea", "polarLine", or "polarArea".

name string

The name of the Chart series which is visible in the legend.

neckRatio number

Specifies the top-base/bottom-base ratio of the whole Chart. If the neckRatio is set to 3, it means the top base is three times smaller than the bottom base.

The neckRatio option is supported when series.type is set to "funnel" and dynamicSlope is set to false.

negativeColor string

The color to use for the Bar, Column, or Waterfall series with negative values. Accepts a valid CSS color string, including hex and rgb.

negativeValues NegativeBubbleValues

The options for displaying the Chart negative bubble values.

noteTextField string

The data item field which contains the series note text.

notes any

The series notes configuration.

opacity number

The series opacity. By default, the series are opaque.

openField string

The data field containing the open value.

The openField option is supported when series.type is set to "candlestick" or "ohlc".

outliers any

The Chart series outliers configuration. Applies to mild outliers. For more information, refer to series.extremes.

outliersField string

The data item field which contains the series outliers value.

overlay Overlay

The Chart series overlay options.

padding number

The padding around the Chart (equal on all sides).

The padding option is supported when series.type is set to "donut" or "pie".

q1Field string

The data item field which contains the series q1 value.

q3Field string

The data item field which contains the series q3 value.

segmentSpacing number

The space in pixels between the different segments of the Funnel Chart.

The segmentSpacing option is supported when series.type is set to "funnel".

size number

The radius of the Chart Donut series in pixels. If not set, the available space is split evenly between the series.

sizeField string

The data field containing the bubble size value.

spacing number

The distance between series points within a category. Expressed as a percentage of the bar width.

See the related gap setting.

The spacing option is supported when series.type is set to "bar", "column", "candlestick", "ohlc", or "radarColumn".

stack SeriesStack

A Boolean value indicating if the series have to be stacked. A string value is interpreted as series.stack.group.

The stack option is supported when series.type is set to "bar", "column", "line", "area", "verticalLine", "verticalArea", "radarLine", "radarArea", and "radarColumn".

If not overridden, the stack settings of the first series are inherited as a default value by the rest of the series.

startAngle number

The start angle (in degrees) of the first Donut or Pie segment.

Angles increase clockwise and zero is to the left. Negative values are acceptable.

style string

The supported values are:

  • "normal"—The values will be connected with a straight line.
  • "step"—The values will be connected with a right-angled line.
  • "smooth"—The values will be connected with a smooth line.

The default value is "normal".

The style option is supported when series.type is set to "line", "scatterLine", "radarLine", or "polarLine".

The step value is only supported when series.type is set to "line".

The smooth options is not supported for stacked area series with missing values.

summaryField string

The 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.

target BulletTarget

The configuration options of the target.

The target option is supported when series.type is set to "bullet" or "verticalBullet".

toField string

The data item field which contains the series to value.

tooltip any

The configuration options of the chart series tooltip.

The chart series tooltip is displayed when the series.tooltip.visible option is set to true.

type string

The type of the series.

The supported values are:

  • area
  • bar
  • bubble
  • bullet
  • candlestick
  • column
  • donut
  • funnel
  • horizontalWaterfall
  • line
  • ohlc
  • pie
  • polarArea
  • polarLine
  • polarScatter
  • radarArea
  • radarColumn
  • radarLine
  • rangeBar
  • rangeColumn
  • scatter
  • scatterLine
  • verticalArea
  • verticalBoxPlot
  • verticalBullet
  • verticalLine
  • waterfall

upperField string

The data item field which contains the series upper value.

visible boolean

Sets the visible property of a Chart series.

visibleInLegend boolean

A value indicating whether to show the point category (for Funnel, Donut, and Pie series) or series name (for other available series types) in the legend.

visibleInLegendField string

The data item field which indicates whether to show the point category name in the legend.

The visibleInLegendField option is supported when series.type is set to "funnel", "donut", or "pie".

visual (e: SeriesVisualArgs) => void

A function that can be used to create a custom visual for the points. Applicable for the Bar, Column, Pie, Donut, Funnel, rangeBar, rangeColumn and Waterfall series.

The available argument fields are:

  • rect—The kendo.geometry.Rect that defines where the visual has to 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 the stackable series.
  • sender—The Chart instance.
  • series—The point series.
  • percentage—The point value represented as a percentage value. Available only for the Donut, Pie, and 100% stacked Charts.
  • runningTotal—The sum of point values since the last "runningTotal" summary point. Available for the Waterfall series.
  • total—The sum of all previous series values. Available for the Waterfall series.
  • radius—The segment radius. Available for the Donut and Pie series.
  • innerRadius—The segment inner radius. Available for the Donut series.
  • startAngle—The segment start angle. Available for the Donut and Pie series.
  • endAngle—The segment end angle. Available for the Donut and Pie series.
  • center—The segment center point. Available for the Donut and Pie series.
  • points—The segment points. Available for the Funnel series.

width number

The line width.

The width option is supported when series.type is set to "line", "scatterLine", "radarLine", or "polarLine".

xAxis string

The name of the x axis to use.

The xAxis option is supported when series.type is set to "bubble", "scatter", "scatterLine", or "polar" series.

For the Polar series, the xAxis range is expressed in degrees.

xErrorHighField string

The data item field which contains the series.errorBars xAxis high value.

The xErrorHighField option is supported when series.type is set to "scatter", “scatterLine”, or “bubble”`.

xErrorLowField string

The data item field which contains the series.errorBars xAxis low value.

The xErrorLowField option is supported when series.type is set to "scatter", "scatterLine", or "bubble".

xField string

The data item field containing the x value.

The xField option is supported when series.type is set to "bubble", "scatter", "scatterLine", or "polar" series.

yAxis string

The name of the y axis to use.

Available for the Bubble, Scatter, scatterLine, and Polar series.

yErrorHighField string

The data item field which contains the series.errorBars yAxis high value.

The yErrorHighField option is supported when series.type is set to "scatter", "scatterLine", or "bubble".

yErrorLowField string

The data item field which contains the series.errorBars yAxis low value.

The yErrorLowField option is supported when series.type is set to "scatter", "scatterLine", or "bubble".

yField string

The data item field containing the y value.

The yField option is supported when series.type is set to "bubble", "scatter", or "scatterLine".

zIndex number

An optional Z-index that can be used to change the default stacking order of series.

The series with the highest Z-index are placed on top.

Series with no Z-index use the default stacking order based on the series type. For example, Line series will be on top with the Bar and Area following after.

Methods

togglePointVisibility

Toggle the visibility of a point with the given index.

Applicable for the "pie", "donut", and "funnel" series.

Parameters

pointIndex number

The zero-based index of the point to toggle.

toggleVisibility

Toggles the series visibility and updates the parent Chart without animated transitions.

In this article