ChartAnnotationSettings

23 Sep 20251 minute to read

Configures the annotation settings for a chart to highlight or provide additional information about specific points or regions.

Properties

accessibility AccessibilityModel

Options to improve accessibility for chart annotation elements.

content string

The content of the annotation, which also accepts the ID of the custom element.

Defaults to null

coordinateUnits Units

Specifies the coordinate units of the annotation.
The options are:

  • Pixel - Renders the annotation based on x and y pixel values.
  • Point - Renders the annotation based on x and y axis values.

Defaults to ‘Pixel’

description string

A description for the annotation that provides additional information about its content for screen readers.

Defaults to null

horizontalAlignment Alignment

Specifies the alignment of the annotation.
The options are:

  • Near - Aligns the annotation element to the left side.
  • Far - Aligns the annotation element to the right side.
  • Center - Aligns the annotation element to the midpoint.

Defaults to ‘Center’

region Regions

Specifies the regions of the annotation.
The options are:

  • Chart - Renders the annotation based on chart coordinates.
  • Series - Renders the annotation based on series coordinates.

Defaults to ‘Chart’

verticalAlignment Position

Specifies the position of the annotation.
The options are

  • Top - Aligns the annotation element to the top side.
  • Bottom - Aligns the annotation element to the bottom side.
  • Middle - Aligns the annotation element to the midpoint.

Defaults to ‘Middle’

x string|Date|number

If coordinateUnit is set to Pixel, x specifies the pixel value.
If coordinateUnit is set to Point, x specifies the axis value.

Defaults to ‘0’

xAxisName string

The name of the horizontal axis associated with the annotation.
Requires the axes of the chart.

Defaults to null

y string|number

If coordinateUnit is set to Pixel, y specifies the pixel value.
If coordinateUnit is set to Point, y specifies the axis value.

Defaults to ‘0’

yAxisName string

The name of the vertical axis associated with the annotation.
Requires the axes of the chart.

Defaults to null