Text Class
File
wijmo.chart.annotation.js
Module
wijmo.chart.annotation
Base Class
AnnotationBase

Represents a text annotation for the AnnotationLayer.

Constructor

constructor

constructor(options?: any): Text

Initializes a new instance of the Text annotation class.

Parameters
  • options: any Optional

    JavaScript object containing initialization data for the object.

Returns
Text

Properties

attachment

Gets or sets the attachment of the annotation.

Inherited From
AnnotationBase
Type
AnnotationAttachment

isVisible

Gets or sets the visibility of the annotation.

Inherited From
AnnotationBase
Type
boolean

name

Gets or sets the name of the annotation.

Inherited From
AnnotationBase
Type
string

offset

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

Inherited From
AnnotationBase
Type
Point

point

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

Inherited From
AnnotationBase
Type
DataPoint

pointIndex

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

Inherited From
AnnotationBase
Type
number

position

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

Inherited From
AnnotationBase
Type
AnnotationPosition

seriesIndex

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

Inherited From
AnnotationBase
Type
number

style

Gets or sets the style of the annotation.

Inherited From
AnnotationBase
Type
any

text

Gets or sets the text of the annotation.

Type
string

tooltip

Gets or sets the tooltip of the annotation.

Inherited From
AnnotationBase
Type
string

Methods

destroy

destroy(): void

Destroy this annotation

Inherited From
AnnotationBase
Returns
void

render

render(engine: IRenderEngine): void

Render this annotation.

Parameters
Inherited From
AnnotationBase
Returns
void