AnnotationDirective API in Angular Chart API component

Annotation Directive

<e-annotations><e-annotation></e-annotation><e-annotations>

Properties

accessibility

any

Options to improve accessibility for chart annotation elements.

content

any

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

Defaults to null

coordinateUnits

any

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

any

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

Defaults to null

horizontalAlignment

any

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

any

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

any

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

any

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

any

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

Defaults to null

y

any

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

any

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

Defaults to null