Components / Charts / API

SeriesNotesLabel

The configuration options of the series notes label.

background? string

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

border? Border

The border of the label.

color? string

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

content? (e: any) => string

The function which returns the label content.
The function argument contains a value field which defines the point value.
You can split the text into multiple lines by using line feed characters ("\n").

font? string

The font style of the label.

format? string

The format for displaying the notes label. Uses the format method of IntlService.
Contains one placeholder ("{0}") which represents the axis value.

position? NoteLabelPosition

The position of the labels.

The available options are:

  • "inside"—The label is positioned inside the icon.
  • "outside"—The label is positioned outside the icon.

rotation? number

The rotation angle of the label. By default, the label is not rotated.

visible? boolean

If set to true, the Chart displays the series notes label.
By default, the series notes label is visible.