[]
DEMOS DOCS API
DOWNLOAD NEED HELP? BOOK DEMO
(Showing Draft Content)

Polygon Class

Polygon Class

Represents a polygon annotation for AnnotationLayer.

Heirarchy

Constructors

Properties

Methods

Constructors

constructor

  • new Polygon(options?: any): Polygon

  • Initializes a new instance of the Polygon annotation class.

    Parameters

    • Optional options: any

      JavaScript object containing initialization data for the object.

    Returns Polygon

Properties

attachment

attachment: AnnotationAttachment

Gets or sets the attachment of the annotation.

content

content: string

Gets or sets the text 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.

points

points: ObservableArray

Gets the collection of points of the Polygon annotation.

position

position: AnnotationPosition

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

render