Class Label

Hierarchy

Label

Index

Constructors

Properties

_pos3d api counter disposed label prePositioned rego renderRemoval terrChangedRemoval viewer visualRegister

Accessors

Disposed Rego pos3d

Methods

Dispose createLabel removeLabel

Constructors

constructor

new Label(params): Label
Parameters
- params: {
      api?: Api;
      pos3d?: Cartesian3;
      rego: IVisualRego;
      viewer: Viewer;
      visualRegister?: Register;
  }
  - Optional api?: Api
  - Optional pos3d?: Cartesian3
  - rego: IVisualRego
  - viewer: Viewer
  - Optional visualRegister?: Register
Returns Label
- Defined in src/rendering/render-managers/common/entity-label.ts:67

Properties

`Private` _pos3d

_pos3d: Cartesian3 = null

`Private` api

api: Api

`Private` counter

counter: number = 0

`Private` disposed

disposed: boolean = false

`Private` label

label: HTMLElement = null

`Private` prePositioned

prePositioned: boolean = false

`Private` rego

rego: IVisualRego

`Private` renderRemoval

renderRemoval: RemoveCallback = null

`Private` terrChangedRemoval

terrChangedRemoval: RemoveCallback = null

`Private` viewer

viewer: Viewer

`Private` visualRegister

visualRegister: Register

Accessors

Disposed

get Disposed(): boolean
Returns boolean
- Defined in src/rendering/render-managers/common/entity-label.ts:51

Rego

get Rego(): IVisualRego
Returns IVisualRego
- Defined in src/rendering/render-managers/common/entity-label.ts:40

pos3d

get pos3d(): Cartesian3
Returns Cartesian3
- Defined in src/rendering/render-managers/common/entity-label.ts:57
set pos3d(val): void
Parameters
- val: Cartesian3
Returns void
- Defined in src/rendering/render-managers/common/entity-label.ts:60

Methods

Dispose

Dispose(): void
Disposes label and marks instance as disposed. Recalling will be ignored.

Returns void
- Defined in src/rendering/render-managers/common/entity-label.ts:93

`Private` createLabel

createLabel(starterPos3d?): Promise<void>
Creates cesium entity for the label if one does not exist.
Parameters
- Optional starterPos3d: Cartesian3
  
  optional position to create label at. Ignored for billboard labels.
Returns Promise<void>
- Defined in src/rendering/render-managers/common/entity-label.ts:105

`Private` removeLabel

removeLabel(): void
Removes label from the viewer and unsubscribes from events.

Returns void
- Defined in src/rendering/render-managers/common/entity-label.ts:449

Generated using TypeDoc