Class Annotation

A visual annotation in the WWT view.

Hierarchy

Annotation
- Circle
- Poly
- PolyLine

Implements

AnnotationSettingsInterface

Index

Constructors

constructor

Methods

Constructors

constructor

new Annotation(): Annotation

Returns Annotation

Methods

get_id

get_id(): string

Implementation of AnnotationSettingsInterface.get_id
- Defined in engine/src/index.d.ts:436
Returns string

get_label

get_label(): string

Implementation of AnnotationSettingsInterface.get_label
- Defined in engine/src/index.d.ts:438
Returns string

get_opacity

get_opacity(): number

Implementation of AnnotationSettingsInterface.get_opacity
- Defined in engine/src/index.d.ts:441
Ranges between 0 and 1.

Returns number

get_showHoverLabel

get_showHoverLabel(): boolean

Implementation of AnnotationSettingsInterface.get_showHoverLabel
- Defined in engine/src/index.d.ts:443
Returns boolean

get_tag

get_tag(): string

Implementation of AnnotationSettingsInterface.get_tag
- Defined in engine/src/index.d.ts:445
Returns string

hitTest

hitTest(renderContext: RenderContext, ra: number, dec: number, x: number, y: number): boolean

- Defined in engine/src/index.d.ts:448
Parameters
- renderContext: RenderContext
- ra: number
- dec: number
- x: number
- y: number
Returns boolean

set_id

set_id(v: string): string

Implementation of AnnotationSettingsInterface.set_id
- Defined in engine/src/index.d.ts:437
Parameters
- v: string
Returns string

set_label

set_label(v: string): string

Implementation of AnnotationSettingsInterface.set_label
- Defined in engine/src/index.d.ts:439
Parameters
- v: string
Returns string

set_opacity

set_opacity(v: number): number

Implementation of AnnotationSettingsInterface.set_opacity
- Defined in engine/src/index.d.ts:442
Parameters
- v: number
Returns number

set_showHoverLabel

set_showHoverLabel(v: boolean): boolean

Implementation of AnnotationSettingsInterface.set_showHoverLabel
- Defined in engine/src/index.d.ts:444
Parameters
- v: boolean
Returns boolean

set_tag

set_tag(v: string): string

Implementation of AnnotationSettingsInterface.set_tag
- Defined in engine/src/index.d.ts:446
Parameters
- v: string
Returns string

Generated using TypeDoc