5.20193.637
AnnotationBase Wijmo API Class

AnnotationBase Class

Represents the base class of annotations for the AnnotationLayer.

Heirarchy

Constructors

constructor

  • Initializes a new instance of the AnnotationBase class.

    Parameters

    • Optional options: any

      JavaScript object containing initialization data for the object.

    Returns AnnotationBase

Properties

attachment

Gets or sets the attachment of the annotation.

isVisible

isVisible: boolean

Gets or sets the visibility of the annotation.

name

name: string

Gets or sets the name of the annotation.

offset

offset: Point

Gets or sets the offset of the annotation from the point.

point

point: DataPoint

Gets or sets the point of the annotation. The coordinates of points depends on the attachment property. See AnnotationAttachment for further description.

pointIndex

pointIndex: number

Gets or sets the data point index of the annotation. Applies only when the attachment property is set to DataIndex.

position

Gets or sets the position of the annotation. The position is relative to the point.

seriesIndex

seriesIndex: number

Gets or sets the data series index of the annotation. Applies only when the attachment property is set to DataIndex.

style

style: any

Gets or sets the style of the annotation.

tooltip

tooltip: string

Gets or sets the tooltip of the annotation.

Methods

destroy

  • destroy(): void
  • Destroy this annotation

    Returns void

render

  • Render this annotation.

    Parameters

    Returns void