SeriesItemComponent

The configuration component for a series item.

Selector

kendo-chart-series-item

Inputs

aggregate

any

The aggregate function for the date series. The function is used when a category (year, month, or other) contains two or more points. The Chart displays the return value of the function 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)A user-defined aggregate function. Returns a single value or a data item.
  • object (compound aggregate)Applicable to the Candlestick, Box Plot, and OHLC series. Specifies the aggregate for each data item field.

autoFit

boolean

If set to true, the Chart automatically scales down to fit the content area. Applicable for the Pie and Donut series. (See example)

axis

string

The name of the value axis. The axis option is supported for Scatter plots. For more information on 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", or "ohlc".

categoryAxis

string

The name of the category axis that will be used 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 that contains 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 which contains 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 considered 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.

You can set it to:

  • Array of objects. Each point is bound to the field specified through 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", "polar", "rangeBar", or "rangeArea".

The Bubble series need arrays of three valuesX value, Y value, and Size valuefor example, [1, 1, 10]. The Scatter and ScatterLine series need arrays of two valuesX value and Y value. The OHLC and Candlestick series need arrays of four valuesopen, high, low, and close. The RangeBar and RangeArea series need arrays of two valuesthe from and to value.

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 which contains the color that is 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

SeriesErrorBars

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

SeriesExtremes

The configuration of the Chart series extremes. Applies to extreme outliers. The extremes option is supported when series.type is set to "boxPlot".

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 the 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 which contains the high value. The highField option is supported when series.type is set to "candlestick" or "ohlc".

highlight

SeriesHighlight

The configuration of the Chart series highlight.

holeSize

number

The diameter of the donut hole in pixels. The holeSize option is supported when series.type is set to "donut".

labels

SeriesLabels

The configuration of the Chart series label. 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 series.type 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. The lowerField option is supported when series.type is set to "boxPlot".

margin

Margin | number

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

markers

SeriesMarkers

The configuration of the Chart series marker. 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", "rangeArea", "line", "scatter", "scatterLine", "radarLine", "radarArea", "polarLine", "polarScatter", or "polarArea".

maxSize

number

The maximum size of the Chart bubble series marker.

mean

SeriesMean

The configuration of the mean value indicator (line) for Box Plot series. The mean option is not supported by other series types.

meanField

string

The data item field which contains the series mean value. The meanField option is supported when series.type is set to "boxPlot".

median

SeriesMedian

The configuration of the median value indicator (line) for Box Plot series. The median option is not supported by other series types.

medianField

string

The data item field which contains the series median value. The medianField option is supported when series.type is set to "boxPlot".

minSize

number

The minimum size of the Chart bubble series marker.

missingValues

"gap" | "interpolate" | "zero"

The behavior for handling missing values. The missingValues option is available when series.type is set to "area", "rangeArea", "line", "scatterLine", "radarLine", "radarArea", "polarLine", or "polarArea".

The supported values are:

  • "gap"The plot stops before the missing point and continues after it.
  • "interpolate"The value is interpolated from neighboring points. Represents the default value for all series except for the "area" and stacked series. Area and stacked series default to "zero".
  • "zero"The value is assumed to be zero.

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

SeriesNotes

The configuration of the series notes.

opacity

number

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

openField

string

The data field which contains the open value. The openField option is available when series.type is set to "candlestick" or "ohlc".

outliers

SeriesOutliers

The configuration of the Chart series outliers. Applies to mild outliers. The outliers option is supported when series.type is set to "boxPlot".

outliersField

string

The data item field which contains the series outliers value. The outliersField option is supported when series.type is set to "boxPlot".

overlay

Overlay

The overlay options of the Chart series.

padding

number

The padding around the Chart (equal on all sides). The padding option is available when series.type is set to "donut" or "pie".

q1Field

string

The data item field which contains the series q1 value. The q1Field option is supported when series.type is set to "boxPlot".

q3Field

string

The data item field which contains the series q3 value. The q3Field option is supported when series.type is set to "boxPlot".

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 which contains 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

boolean | string | SeriesStack

A Boolean value which indicates 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 with zero to the left. Negative values are acceptable.

style

LineStyle

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

The supported values are:

  • "normal" (default)The values are connected with a straight line.
  • "step"The values are connected with a right-angled line. Only available when series.type is set to "line".
  • "smooth"The values are connected with a smooth line. Not supported for stacked area series with missing values.

summaryField

string

The data item field which contains the summary type for the Waterfall series. The value (if any) of a data item marked as a summary point will be discarded.

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.

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

SeriesTooltip

The configuration options of the Chart series tooltip.

type

SeriesType

The type of the series.

The supported values are:

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

upperField

string

The data item field which contains the series upper value. The upperField option is supported when series.type is set to "boxPlot".

visible

boolean

Sets the visible property of a Chart series.

visibleInLegend

boolean

A value which indicates whether to show the point category (for Funnel, Donut, and Pie series) or the 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) => Element

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

The available argument fields are:

  • rectThe geometry Rect that defines where the visual has to be rendered.
  • optionsThe point options.
  • createVisualA function that can be used to get the default visual.
  • categoryThe point category.
  • dataItemThe point dataItem.
  • valueThe point value.
  • stackValueThe cumulative point value on the stack. Available only for the stackable series.
  • senderThe Chart instance.
  • seriesThe point series.
  • percentageThe point value represented as a percentage value. Available only for the Donut, Pie, and 100% Stacked Charts.
  • runningTotalThe sum of point values since the last "runningTotal" summary point. Available for the Waterfall series.
  • totalThe sum of all previous series values. Available for the Waterfall series.
  • radiusThe segment radius. Available for the Donut and Pie series.
  • innerRadiusThe segment inner radius. Available for the Donut series.
  • startAngleThe segment start angle. Available for the Donut and Pie series.
  • endAngleThe segment end angle. Available for the Donut and Pie series.
  • centerThe segment center point. Available for the Donut and Pie series.
  • pointsThe segment points. Available for the Funnel series.

whiskers

SeriesWhiskers

The configuration of the whiskers for the Chart series. The whiskers option is supported when series.type is set to "boxPlot".

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. 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, Scatter Line, 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

notifyChanges

Updates the component fields with the specified values and refreshes the Chart.

Use this method when the configuration values cannot be set through the template.

item.notifyChanges({ visible: true });

Parameters

changes

any

An object containing the updated input fields.

togglePointVisibility

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