Api chartAnnotationSettingsModel in Vue Chart component

18 Nov 20181 minute to read

Interface for a class ChartAnnotationSettings

Properties

content string

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

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.

description string

Information about annotation for assistive technology.

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.

region string

Specifies the regions of the annotation. They are

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

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.

x string | Date | number

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

xAxisName string

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

y string | number

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

yAxisName string

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