Api chartAnnotationSettings in EJ2 TypeScript Chart control

8 May 20231 minute to read

Configures the Annotation for chart.

Properties

content string

Content of the annotation, which accepts the id of the custom element.

Defaults to null

coordinateUnits string

Specifies the coordinate units of the annotation. They are

  • Pixel - Annotation renders based on x and y pixel value.
  • Point - Annotation renders based on x and y axis value.

Defaults to ‘Pixel’

description string

Information about annotation for assistive technology.

Defaults to null

horizontalAlignment string

Specifies the alignment of the annotation. They are

  • Near - Align the annotation element as left side.
  • Far - Align the annotation element as right side.
  • Center - Align the annotation element as mid point.

Defaults to ‘Center’

region string

Specifies the regions of the annotation. They are

  • Chart - Annotation renders based on chart coordinates.
  • Series - Annotation renders based on series coordinates.

Defaults to ‘Chart’

verticalAlignment string

Specifies the position of the annotation. They are

  • Top - Align the annotation element as top side.
  • Bottom - Align the annotation element as bottom side.
  • Middle - Align the annotation element as mid point.

Defaults to ‘Middle’

x string | Date | number

if set coordinateUnit as Pixel X specifies the axis value else is specifies pixel or percentage of coordinate

Defaults to 0

xAxisName string

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

Defaults to null

y string | number

if set coordinateUnit as Pixel Y specifies the axis value
else is specifies pixel or percentage of coordinate

Defaults to 0

yAxisName string

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

Defaults to null