xgis-cesium v0.1.9

---

xgis-cesium / BillboardPrimitive

Class: BillboardPrimitive

Defined in: src/overlay/primitive/BillboardPrimitive.ts:10

Extends

• Overlay

Extended by

• BounceBillboardPrimitive

Constructors

new BillboardPrimitive()

new BillboardPrimitive(position, icon): BillboardPrimitive

Defined in: src/overlay/primitive/BillboardPrimitive.ts:14

Parameters

position

any

icon

any

Returns

BillboardPrimitive

Overrides

Overlay.constructor

Properties

_allowDrillPicking

protected _allowDrillPicking: boolean

Defined in: src/overlay/Overlay.ts:17

Inherited from

Overlay._allowDrillPicking

---

_attr

protected _attr: any

Defined in: src/overlay/Overlay.ts:16

Inherited from

Overlay._attr

---

_bid

protected _bid: string

Defined in: src/overlay/Overlay.ts:10

Inherited from

Overlay._bid

---

_contextMenu

protected _contextMenu: any[]

Defined in: src/overlay/Overlay.ts:18

Inherited from

Overlay._contextMenu

---

_delegate

protected _delegate: any

Defined in: src/overlay/Overlay.ts:11

Inherited from

Overlay._delegate

---

_id

protected _id: string

Defined in: src/overlay/Overlay.ts:9

Inherited from

Overlay._id

---

_layer

protected _layer: any

Defined in: src/overlay/Overlay.ts:13

Inherited from

Overlay._layer

---

_overlayEvent

protected _overlayEvent: OverlayEvent

Defined in: src/overlay/Overlay.ts:19

Inherited from

Overlay._overlayEvent

---

_show

protected _show: boolean

Defined in: src/overlay/Overlay.ts:14

Inherited from

Overlay._show

---

_state

protected _state: string

Defined in: src/overlay/Overlay.ts:12

Inherited from

Overlay._state

---

_style

protected _style: any

Defined in: src/overlay/Overlay.ts:15

Inherited from

Overlay._style

Accessors

allowDrillPicking

Get Signature

get allowDrillPicking(): boolean

Defined in: src/overlay/Overlay.ts:80

Returns

boolean

Set Signature

set allowDrillPicking(allowDrillPicking): void

Defined in: src/overlay/Overlay.ts:76

Parameters

allowDrillPicking

boolean

Returns

void

Inherited from

Overlay.allowDrillPicking

---

attr

Get Signature

get attr(): any

Defined in: src/overlay/Overlay.ts:72

Returns

any

Set Signature

set attr(attr): void

Defined in: src/overlay/Overlay.ts:68

Parameters

attr

any

Returns

void

Inherited from

Overlay.attr

---

contextMenu

Get Signature

get contextMenu(): any[]

Defined in: src/overlay/Overlay.ts:100

Returns

any[]

Set Signature

set contextMenu(menus): void

Defined in: src/overlay/Overlay.ts:96

Parameters

menus

any[]

Returns

void

Inherited from

Overlay.contextMenu

---

delegate

Get Signature

get delegate(): any

Defined in: src/overlay/Overlay.ts:88

Returns

any

Inherited from

Overlay.delegate

---

icon

Get Signature

get icon(): string

Defined in: src/overlay/primitive/BillboardPrimitive.ts:49

Returns

string

Set Signature

set icon(icon): void

Defined in: src/overlay/primitive/BillboardPrimitive.ts:44

Parameters

icon

string

Returns

void

---

id

Get Signature

get id(): string

Defined in: src/overlay/Overlay.ts:49

Returns

string

Set Signature

set id(id): void

Defined in: src/overlay/Overlay.ts:45

Parameters

id

string

Returns

void

Inherited from

Overlay.id

---

overlayEvent

Get Signature

get overlayEvent(): OverlayEvent

Defined in: src/overlay/Overlay.ts:84

Returns

OverlayEvent

Inherited from

Overlay.overlayEvent

---

overlayId

Get Signature

get overlayId(): string

Defined in: src/overlay/Overlay.ts:37

Returns

string

Inherited from

Overlay.overlayId

---

position

Get Signature

get position(): any

Defined in: src/overlay/primitive/BillboardPrimitive.ts:40

Returns

any

Set Signature

set position(position): void

Defined in: src/overlay/primitive/BillboardPrimitive.ts:32

Parameters

position

any

Returns

void

---

show

Get Signature

get show(): boolean

Defined in: src/overlay/Overlay.ts:64

Returns

boolean

Set Signature

set show(show): void

Defined in: src/overlay/Overlay.ts:53

Parameters

show

boolean

Returns

void

Inherited from

Overlay.show

---

size

Get Signature

get size(): [number, number]

Defined in: src/overlay/primitive/BillboardPrimitive.ts:62

Returns

[number, number]

Set Signature

set size(size): void

Defined in: src/overlay/primitive/BillboardPrimitive.ts:53

Parameters

size

[number, number]

Returns

void

---

state

Get Signature

get state(): string

Defined in: src/overlay/Overlay.ts:92

Returns

string

Inherited from

Overlay.state

---

type

Get Signature

get type(): string

Defined in: src/overlay/primitive/BillboardPrimitive.ts:28

Returns

string

Overrides

Overlay.type

Methods

addTo()

addTo(layer): BillboardPrimitive

Defined in: src/overlay/Overlay.ts:290

adds to layer

Parameters

layer

any

Returns

BillboardPrimitive

Inherited from

Overlay.addTo

---

fire()

fire(type, params): BillboardPrimitive

Defined in: src/overlay/Overlay.ts:327

Trigger subscription event

Parameters

type

any

params

any

Returns

BillboardPrimitive

Inherited from

Overlay.fire

---

off()

off(type, callback, context): BillboardPrimitive

Defined in: src/overlay/Overlay.ts:316

Unsubscribe event

Parameters

type

any

callback

any

context

any

Returns

BillboardPrimitive

Inherited from

Overlay.off

---

on()

on(type, callback, context): BillboardPrimitive

Defined in: src/overlay/Overlay.ts:304

Subscribe event

Parameters

type

any

callback

any

context

any

Returns

BillboardPrimitive

Inherited from

Overlay.on

---

remove()

remove(): BillboardPrimitive

Defined in: src/overlay/Overlay.ts:278

Removes from layer

Returns

BillboardPrimitive

Inherited from

Overlay.remove

---

setLabel()

setLabel(text, textStyle): BillboardPrimitive

Defined in: src/overlay/Overlay.ts:253

Sets Text with Style

Parameters

text

any

textStyle

any

Returns

BillboardPrimitive

Inherited from

Overlay.setLabel

---

setStyle()

setStyle(style): BillboardPrimitive

Defined in: src/overlay/primitive/BillboardPrimitive.ts:83

Parameters

style

any

Returns

BillboardPrimitive

Overrides

Overlay.setStyle