SeriesDefaultsLabels

The configuration options of the series labels.

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 labels content.
You can split the text into multiple lines by using line feed characters ("\n").

The available fields in the function argument are:

  • category—The category name. Available for the Area, Bar, Column, Bubble, Donut, Funnel, Line, and Pie 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 for the Donut, Funnel, and Pie series.
  • series—The data 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.

font? string

The font style of the labels.

format? string

The format of the labels. Uses the format method of IntlService.

from? SeriesDefaultsLabelsFrom

The Chart series from label configuration.
The Chart displays the series labels when either the seriesDefaults.labels.visible or
the seriesDefaults.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 margins.

rotation? number

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

to? SeriesDefaultsLabelsTo

The Chart series to label configuration.
The Chart displays the series labels when either the seriesDefaults.labels.visible or
the seriesDefaults.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:

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