Search results

AccumulationAnnotationSettings API in Angular Accumulation Chart API component

Configures the annotation settings for an accumulation chart. Annotations are used to highlight or provide additional information about specific points or regions in the accumulation chart.

Properties

content

string

The content of the annotation, which can also accept the ID of a 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 data 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 top side.
  • Far - Aligns the annotation element to the bottom 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 data value.

Defaults to ‘0’

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.

Defaults to ‘0’