AccumulationAnnotationSettingsModel

12 Sep 20251 minute to read

Interface for a class AccumulationAnnotationSettings

Properties

content string

The content of the annotation, which can also accept the ID of a custom element.

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 data values.

description string

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

horizontalAlignment Alignment

Specifies the alignment of the annotation.
The options are:

  • Near - Aligns the annotation element to the top side.
  • Far - Aligns the annotation element to the bottom side.
  • Center - Aligns the annotation element to the midpoint.

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.

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.

x string|Date|number

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

y string|number

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