Components / Charts / API

SeriesLabelsFrom

The configuration options of the series from labels.

background? string

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

border? Border

The border of the from labels.

color? string

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

content? (e: any) => string

The function which returns the Chart series from label content.

The fields available in the function argument 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.
  • 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 the line feed characters ("\n").

font? string

The font style of the from labels.

format? string

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

margin? Margin | number

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

padding? Padding | number

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

position? "center" | "insideBase" | "insideEnd" | "outsideEnd"

The position of the from labels.

  • "center"—The label is positioned at the point center.
  • "insideBase"—The label is positioned inside, near the base of the bar.
  • "insideEnd"—The label is positioned inside, near the end of the point.
  • "outsideEnd"—The label is positioned outside, near the end of the point.
  • "above"—the label is positioned at the top of the marker. Applicable for "rangeArea" and "verticalRangeArea" series.
  • "below"—the label is positioned at the bottom of the marker. Applicable for "rangeArea" and "verticalRangeArea" series.
  • "left"—the label is positioned to the left of the marker. Applicable for "rangeArea" and "verticalRangeArea" series.
  • "right"—the label is positioned to the right of the marker. Applicable for "rangeArea" and "verticalRangeArea" series.

visible? boolean

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