New to Kendo UI for Angular? Start a free 30-day trial

SeriesLabelsComponent

The configuration of the Chart series label (see example).

Selector

kendo-chart-series-item-labels

Inputs

align

"circle" | "column" | "center" | "right" | "left"

The alignment of the label 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 function which returns the Chart series label content. You can split the text into multiple lines by using line feed characters ("\n").

The fields available in the function argument are:

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

distance

number

The distance between 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 the format method of the IntlService.

from

SeriesLabelsFrom

The from label configuration of the Chart series. 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

SeriesLabelsPosition

The position of the labels.

rotation

number

The rotation angle of the labels. By default, the labels are not rotated.

to

SeriesLabelsTo

The to label configuration of the Chart series. 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) => Element

A function that can be used to create a custom visual for the labels.

The available argument fields are:

  • textThe label text.
  • rectThe geometry Rect that defines where the visual has to be rendered.
  • optionsThe label options.
  • createVisualA function that can be used to get the default visual.
  • senderThe Chart instance (might be undefined).

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.