ChartAnnotationSettingsModel API in JavaScript Chart API control

Interface for a class ChartAnnotationSettings

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.

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.

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 left side.
• Far - Aligns the annotation element to the right 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 axis value.

xAxisName

string

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

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.

yAxisName

string

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