Rectangle Class
File
wijmo.chart.annotation.js
Module
wijmo.chart.annotation
Base Class
Shape

Represents a rectangle annotation for AnnotationLayer.

Constructor

constructor

constructor(options?: any): Rectangle

Initializes a new instance of the Rectangle annotation class.

Parameters
  • options: any Optional

    JavaScript object containing initialization data for the object.

Returns
Rectangle

Properties

attachment

Gets or sets the attachment of the annotation.

Inherited From
AnnotationBase
Type
AnnotationAttachment

content

Gets or sets the text of the annotation.

Inherited From
Shape
Type
string

height

Gets or sets the height of the Rectangle annotation.

Type
number

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

tooltip

Gets or sets the tooltip of the annotation.

Inherited From
AnnotationBase
Type
string

width

Gets or sets the width of the Rectangle annotation.

Type
number

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