xgis-cesium v0.1.9

---

xgis-cesium / Overlay

Class: Overlay

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

Extended by

• CustomBillboard
• CustomLabel
• DivIcon
• Model
• I3S
• Tileset
• AttackArrow
• DoubleArrow
• FineArrow
• GatheringPlace
• Curve
• Arc
• StraightArrow
• Lune
• Sector
• ClosedCurve
• TriangleFlag
• BillboardPrimitive
• CloudPrimitive
• DiffuseWallPrimitive
• ElecEllipsoidPrimitive
• FlowLinePrimitive
• LabelPrimitive
• LightCylinderPrimitive
• ModelPrimitive
• PointPrimitive
• PolylinePrimitive
• ScanCirclePrimitive
• TrailLinePrimitive
• VideoPrimitive
• WaterPrimitive
• Billboard
• Box
• Circle
• Corridor
• Cylinder
• Ellipse
• Sphere
• Label
• Plane
• Point
• Polygon
• Polyline
• PolylineVolume
• Rect
• Wall

Constructors

new Overlay()

new Overlay(): Overlay

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

Returns

Overlay

Properties

_allowDrillPicking

protected _allowDrillPicking: boolean

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

---

_attr

protected _attr: any

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

---

_bid

protected _bid: string

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

---

_contextMenu

protected _contextMenu: any[]

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

---

_delegate

protected _delegate: any

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

---

_id

protected _id: string

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

---

_layer

protected _layer: any

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

---

_overlayEvent

protected _overlayEvent: OverlayEvent

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

---

_show

protected _show: boolean

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

---

_state

protected _state: string

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

---

_style

protected _style: any

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

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

---

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

---

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

---

delegate

Get Signature

get delegate(): any

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

Returns

any

---

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

---

overlayEvent

Get Signature

get overlayEvent(): OverlayEvent

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

Returns

OverlayEvent

---

overlayId

Get Signature

get overlayId(): string

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

Returns

string

---

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

---

state

Get Signature

get state(): string

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

Returns

string

---

type

Get Signature

get type(): string

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

Returns

string

Methods

addTo()

addTo(layer): Overlay

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

adds to layer

Parameters

layer

any

Returns

Overlay

---

fire()

fire(type, params): Overlay

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

Trigger subscription event

Parameters

type

any

params

any

Returns

Overlay

---

off()

off(type, callback, context): Overlay

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

Unsubscribe event

Parameters

type

any

callback

any

context

any

Returns

Overlay

---

on()

on(type, callback, context): Overlay

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

Subscribe event

Parameters

type

any

callback

any

context

any

Returns

Overlay

---

remove()

remove(): Overlay

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

Removes from layer

Returns

Overlay

---

setLabel()

setLabel(text, textStyle): Overlay

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

Sets Text with Style

Parameters

text

any

textStyle

any

Returns

Overlay

---

setStyle()

setStyle(style): any

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

Sets style

Parameters

style

any

Returns

any