Class Circle

A simple circular annotation.

Hierarchy

Annotation
- Circle

Implements

CircleAnnotationSettingsInterface

Index

Constructors

constructor

Constructors

constructor

new Circle(): Circle

Inherited from Annotation.constructor

Returns Circle

Methods

get_fill

get_fill(): boolean

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

get_fillColor

get_fillColor(): string

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

get_id

get_id(): string

Implementation of CircleAnnotationSettingsInterface.get_id

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

get_label

get_label(): string

Implementation of CircleAnnotationSettingsInterface.get_label

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

get_lineColor

get_lineColor(): string

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

get_lineWidth

get_lineWidth(): number

Implementation of CircleAnnotationSettingsInterface.get_lineWidth
- Defined in engine/src/index.d.ts:509
This parameter currently DOES NOTHING because the WebGL renderer doesn't yet support parametrizable line widths.

Returns number

get_opacity

get_opacity(): number

Implementation of CircleAnnotationSettingsInterface.get_opacity

Inherited from Annotation.get_opacity
- Defined in engine/src/index.d.ts:441
Ranges between 0 and 1.

Returns number

get_radius

get_radius(): number

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

get_showHoverLabel

get_showHoverLabel(): boolean

Implementation of CircleAnnotationSettingsInterface.get_showHoverLabel

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

get_skyRelative

get_skyRelative(): boolean

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

get_tag

get_tag(): string

Implementation of CircleAnnotationSettingsInterface.get_tag

Inherited from Annotation.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

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

setCenter

setCenter(raDeg: number, decDeg: number): void

- Defined in engine/src/index.d.ts:518
Set the position of this circle's center.

Parameters
- raDeg: number
- decDeg: number
Returns void

set_fill

set_fill(v: boolean): boolean

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

set_fillColor

set_fillColor(v: string): string

Implementation of CircleAnnotationSettingsInterface.set_fillColor
- Defined in engine/src/index.d.ts:504
The color is parsed using Color.fromName.

Parameters
- v: string
Returns string

set_id

set_id(v: string): string

Implementation of CircleAnnotationSettingsInterface.set_id

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

set_label

set_label(v: string): string

Implementation of CircleAnnotationSettingsInterface.set_label

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

set_lineColor

set_lineColor(v: string): string

Implementation of CircleAnnotationSettingsInterface.set_lineColor
- Defined in engine/src/index.d.ts:507
The color is parsed using Color.load.

Parameters
- v: string
Returns string

set_lineWidth

set_lineWidth(v: number): number

Implementation of CircleAnnotationSettingsInterface.set_lineWidth
- Defined in engine/src/index.d.ts:511
This parameter currently DOES NOTHING because the WebGL renderer doesn't yet support parametrizable line widths.

Parameters
- v: number
Returns number

set_opacity

set_opacity(v: number): number

Implementation of CircleAnnotationSettingsInterface.set_opacity

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

set_radius

set_radius(v: number): number

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

set_showHoverLabel

set_showHoverLabel(v: boolean): boolean

Implementation of CircleAnnotationSettingsInterface.set_showHoverLabel

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

set_skyRelative

set_skyRelative(v: boolean): boolean

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

set_tag

set_tag(v: string): string

Implementation of CircleAnnotationSettingsInterface.set_tag

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

Generated using TypeDoc