All Components
Components

SeriesLabelsComponent

The Chart series label configuration.

Selector

kendo-chart-series-item-labels

Inputs

align string

The label alignment when series.type is set to "donut", "funnel", or "pie".

The supported values for "donut" and "pie" are:

  • "circle"—The labels are positioned in circle around the Chart.
  • "column"—The labels are positioned in columns to the left and right of the Chart.

The supported values for "funnel" are:

  • "center"—The labels are positioned in the center over the funnel segment.
  • "right"—The labels are positioned on the right side of the Chart and, if there is enough space, do not overlap the funnel segments.
  • "left"—The labels are positioned on the left side of the Chart and, if there is enough space, do not overlap the funnel segments.

background string

The background color of the labels. Accepts a valid CSS color string, including hex and rgb.

border Border

The border of the labels.

color string

The text color of the labels. Accepts a valid CSS color string, including hex and rgb.

content (e: any) => string

The template which renders the Chart series label.

The fields which can be used in the template are:

  • category—The category name. Available for the Area, Bar, Column, Bubble, Donut, Line, Pie, and Waterfall series.
  • dataItem—The original data item used to construct the point. If binding to an array, it will be null.
  • percentage—The point value represented as a percentage value. Available only for the Donut, Pie, and 100% stacked charts.
  • series—The data series.
  • stackValue—The cumulative point value on the stack. Available only for the stackable series.
  • value—The point value. Can be a number or object containing each bound field.
  • 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.

The text can be split into multiple lines by using line feed characters ("\n").

distance number

The distance of the labels when series.type is set to "donut" or `“pie”.

font string

The font style of the labels.

format string

The format of the labels. Uses kendo.format.

from any

The Chart series from label configuration.

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

margin Margin | number

The margin of the labels. A numeric value sets all margins.

padding Padding | number

The padding of the labels. A numeric value sets all paddings.

Bar and Column series always apply full padding and ignore this setting.

position string

The position of the labels.

  • "above"—The label is positioned at the top of the marker. Applicable for series that render points, including the Bubble series.
  • "below"—The label is positioned at the bottom of the marker. Applicable for series that render points, including the Bubble series.
  • "center"—The label is positioned at the point center. Applicable for the Bar, Column, Donut, Pie, Funnel, radarColumn, and Waterfall series.
  • "insideBase"—The label is positioned inside, near the base of the bar. Applicable for the Bar, Column, and Waterfall series.
  • "insideEnd"—The label is positioned inside, near the end of the point. Applicable for the Bar, Column, Donut, Pie, radarColumn, and Waterfall series.
  • "left"—The label is positioned to the left of the marker. Applicable for series that render points, including the Bubble series.
  • "outsideEnd"—The label is positioned outside, near the end of the point. Applicable for the Bar, Column, Donut, Pie, radarColumn, and Waterfall series. Not applicable for stacked series.
  • "right"—The label is positioned to the right of the marker. Applicable for series that render points, including the Bubble series.
  • "top"—The label is positioned at the top of the segment. Applicable for the Funnel series.
  • "bottom"—The label is positioned at the bottom of the segment. Applicable for the Funnel series.

to any

The Chart series to label configuration.

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

visible boolean

If set to true, the Chart displays the series labels. By default, the Chart series labels are not displayed.

visual (e: SeriesLabelsVisualArgs) => void

A function that can be used to create a custom visual for the labels. The available argument fields are:

  • text—The label text.
  • rect—The kendo.geometry.Rect that defines where the visual has to be rendered.
  • options—The label options.
  • createVisual—A function that can be used to get the default visual.
  • sender—The Chart instance (might be undefined).
In this article