Class Circle

A simple circular annotation.

Hierarchy

Annotation
- Circle

Implements

CircleAnnotationSettingsInterface

Constructors

constructor

new Circle(): Circle
Returns Circle

Inherited from Annotation.constructor

Methods

get_fill

get_fill(): boolean
Returns boolean
Implementation of CircleAnnotationSettingsInterface.get_fill
- Defined in engine/src/index.d.ts:500

get_fillColor

get_fillColor(): string
Returns string
Implementation of CircleAnnotationSettingsInterface.get_fillColor
- Defined in engine/src/index.d.ts:502

get_id

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

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

get_label

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

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

get_lineColor

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

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 CircleAnnotationSettingsInterface.get_lineWidth
- Defined in engine/src/index.d.ts:509

get_opacity

get_opacity(): number
Ranges between 0 and 1.

Returns number
Implementation of CircleAnnotationSettingsInterface.get_opacity

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

get_radius

get_radius(): number
Returns number
Implementation of CircleAnnotationSettingsInterface.get_radius
- Defined in engine/src/index.d.ts:512

get_showHoverLabel

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

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

get_skyRelative

get_skyRelative(): boolean
Returns boolean
Implementation of CircleAnnotationSettingsInterface.get_skyRelative
- Defined in engine/src/index.d.ts:514

get_tag

get_tag(): string
Returns string
Implementation of CircleAnnotationSettingsInterface.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

setCenter

setCenter(raDeg, decDeg): void
Set the position of this circle's center.
Parameters
- raDeg: number
- decDeg: number
Returns void
- Defined in engine/src/index.d.ts:518

set_fill

set_fill(v): boolean
Parameters
- v: boolean
Returns boolean
Implementation of CircleAnnotationSettingsInterface.set_fill
- Defined in engine/src/index.d.ts:501

set_fillColor

set_fillColor(v): string
The color is parsed using Color.fromName.
Parameters
- v: string
Returns string
Implementation of CircleAnnotationSettingsInterface.set_fillColor
- Defined in engine/src/index.d.ts:504

set_id

set_id(v): string
Parameters
- v: string
Returns string
Implementation of CircleAnnotationSettingsInterface.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 CircleAnnotationSettingsInterface.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 CircleAnnotationSettingsInterface.set_lineColor
- Defined in engine/src/index.d.ts:507

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 CircleAnnotationSettingsInterface.set_lineWidth
- Defined in engine/src/index.d.ts:511

set_opacity

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

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

set_radius

set_radius(v): number
Parameters
- v: number
Returns number
Implementation of CircleAnnotationSettingsInterface.set_radius
- Defined in engine/src/index.d.ts:513

set_showHoverLabel

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

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

set_skyRelative

set_skyRelative(v): boolean
Parameters
- v: boolean
Returns boolean
Implementation of CircleAnnotationSettingsInterface.set_skyRelative
- Defined in engine/src/index.d.ts:515

set_tag

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

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

Generated using TypeDoc