Class Annotation

A visual annotation in the WWT view.

Hierarchy

Annotation
- Circle
- Poly
- PolyLine

Implements

AnnotationSettingsInterface

Index

Constructors

Methods

get_id get_label get_opacity get_showHoverLabel get_tag hitTest set_id set_label set_opacity set_showHoverLabel set_tag

Constructors

constructor

new Annotation(): Annotation
Returns Annotation

Methods

get_id

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

get_label

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

get_opacity

get_opacity(): number
Ranges between 0 and 1.

Returns number
Implementation of AnnotationSettingsInterface.get_opacity
- Defined in engine/src/index.d.ts:441

get_showHoverLabel

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

get_tag

get_tag(): string
Returns string
Implementation of AnnotationSettingsInterface.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
- Defined in engine/src/index.d.ts:448

set_id

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

set_label

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

set_opacity

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

set_showHoverLabel

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

set_tag

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

Generated using TypeDoc