Class PolyLine

An annotation composed of a sequence of lines.

Hierarchy

Annotation
- PolyLine

Implements

PolyLineAnnotationSettingsInterface

Index

Constructors

Methods

addPoint get_id get_label get_lineColor get_lineWidth get_opacity get_showHoverLabel get_tag hitTest set_id set_label set_lineColor set_lineWidth set_opacity set_showHoverLabel set_tag

Constructors

constructor

new PolyLine(): PolyLine
Returns PolyLine

Inherited from Annotation.constructor

Methods

addPoint

addPoint(raDeg, decDeg): void
Add a point to this annotation's definition.
Parameters
- raDeg: number
- decDeg: number
Returns void
- Defined in engine/src/index.d.ts:1264

get_id

get_id(): string
Returns string
Implementation of PolyLineAnnotationSettingsInterface.get_id

Inherited from Annotation.get_id
- Defined in engine/src/index.d.ts:436

get_label

get_label(): string
Returns string
Implementation of PolyLineAnnotationSettingsInterface.get_label

Inherited from Annotation.get_label
- Defined in engine/src/index.d.ts:438

get_lineColor

get_lineColor(): string
Returns string
Implementation of PolyLineAnnotationSettingsInterface.get_lineColor
- Defined in engine/src/index.d.ts:1255

get_lineWidth

get_lineWidth(): number
This parameter currently DOES NOTHING because the WebGL renderer doesn't yet support parametrizable line widths.

Returns number
Implementation of PolyLineAnnotationSettingsInterface.get_lineWidth
- Defined in engine/src/index.d.ts:1259

get_opacity

get_opacity(): number
Ranges between 0 and 1.

Returns number
Implementation of PolyLineAnnotationSettingsInterface.get_opacity

Inherited from Annotation.get_opacity
- Defined in engine/src/index.d.ts:441

get_showHoverLabel

get_showHoverLabel(): boolean
Returns boolean
Implementation of PolyLineAnnotationSettingsInterface.get_showHoverLabel

Inherited from Annotation.get_showHoverLabel
- Defined in engine/src/index.d.ts:443

get_tag

get_tag(): string
Returns string
Implementation of PolyLineAnnotationSettingsInterface.get_tag

Inherited from Annotation.get_tag
- Defined in engine/src/index.d.ts:445

hitTest

hitTest(renderContext, ra, dec, x, y): boolean
Parameters
- renderContext: RenderContext
- ra: number
- dec: number
- x: number
- y: number
Returns boolean
Inherited from Annotation.hitTest
- Defined in engine/src/index.d.ts:448

set_id

set_id(v): string
Parameters
- v: string
Returns string
Implementation of PolyLineAnnotationSettingsInterface.set_id

Inherited from Annotation.set_id
- Defined in engine/src/index.d.ts:437

set_label

set_label(v): string
Parameters
- v: string
Returns string
Implementation of PolyLineAnnotationSettingsInterface.set_label

Inherited from Annotation.set_label
- Defined in engine/src/index.d.ts:439

set_lineColor

set_lineColor(v): string
The color is parsed using Color.load.
Parameters
- v: string
Returns string
Implementation of PolyLineAnnotationSettingsInterface.set_lineColor
- Defined in engine/src/index.d.ts:1257

set_lineWidth

set_lineWidth(v): number
This parameter currently DOES NOTHING because the WebGL renderer doesn't yet support parametrizable line widths.
Parameters
- v: number
Returns number
Implementation of PolyLineAnnotationSettingsInterface.set_lineWidth
- Defined in engine/src/index.d.ts:1261

set_opacity

set_opacity(v): number
Parameters
- v: number
Returns number
Implementation of PolyLineAnnotationSettingsInterface.set_opacity

Inherited from Annotation.set_opacity
- Defined in engine/src/index.d.ts:442

set_showHoverLabel

set_showHoverLabel(v): boolean
Parameters
- v: boolean
Returns boolean
Implementation of PolyLineAnnotationSettingsInterface.set_showHoverLabel

Inherited from Annotation.set_showHoverLabel
- Defined in engine/src/index.d.ts:444

set_tag

set_tag(v): string
Parameters
- v: string
Returns string
Implementation of PolyLineAnnotationSettingsInterface.set_tag

Inherited from Annotation.set_tag
- Defined in engine/src/index.d.ts:446

Generated using TypeDoc