AccumulationDataLabelSettings

23 Sep 20253 minutes to read

This class provides options to customize the appearance and behavior of data labels within a series.

Properties

angle number

Specifies the rotation angle of the data label.

Defaults to 0

border BorderModel

Configures the appearance of the border lines with options for width and color properties.

connectorStyle ConnectorModel

Options to customize the connector line in the series.
By default, the connector length for the Pie series is set to ‘4%’. For other series, it is set to null.

enableRotation boolean

If set to true, the data label will be rotated according to the specified angle.

Defaults to false

fill string

The background color of the data label accepts hex and rgba values as valid CSS color strings.

Defaults to ‘transparent’

font FontModel

Customizes the appearance of the data label text with options for font size, color, style, weight, and family.

format string

Used to format the data label, accepting global string formats like C, n1, P, etc.
It also supports placeholders, such as {value}°C, where {value} represent the point data label (e.g., 20°C).

Defaults to ’’

maxWidth number

Use this property to limit the label width and apply wrapping or trimming.

Defaults to ‘null’

name string

Specifies the data source field that contains the data label value.

Defaults to null

position AccumulationLabelPosition

Specifies the position of the data label relative to the data point.
The available options are:

  • Outside - Places the data label outside the data point, which is typically used to avoid overlap with the data point.
  • Inside - Places the data label inside the data point, which is useful for displaying labels within the data point.

Defaults to ‘Inside’

rx number

Specifies the X-axis rounded corner radius for the data label.

Note that border values must not be null for this feature to work.

Defaults to 5

ry number

Specifies the Y-axis rounded corner radius for the data label.

Note that border values must not be null for this feature to work.

Defaults to 5

showZero boolean

If set to true, the data label for zero values in the series will be rendered.

Defaults to true

template string|Function

Custom template to format the content of the data label.
Use ${point.x} and ${point.y} as placeholders to display the corresponding data point values.

Defaults to null

textOverflow LabelOverflow

Defines the text overflow behavior for the data label when the text exceeds the bounds.
Available options are:

  • Clip - Truncates the data label when it overflows the bounds.
  • Ellipsis - Displays an ellipsis (“…”) at the end of the data label when it overflows the bounds.
    Set the maximum width of the label using the maxWidth property.

Defaults to ‘Ellipsis’

textWrap TextWrap

Defines the text wrap behavior for the data label when it overflows the bounds.
Available options are:

  • Normal - Truncates the data label when it overflows the bounds.
  • Wrap - Breaks the data label into multiple lines when it is too long to fit on a single line.
  • AnyWhere - Breaks the data label at any point if there are no otherwise acceptable break points.
    Set the maximum width of the label using the maxWidth property.

Defaults to ‘Normal’

visible boolean

If set to true, data labels for the series are render. By default, it is set to false.

Defaults to false