xgis-cesium v0.1.9

---

xgis-cesium / Layer

Class: Layer

Defined in: src/layer/Layer.js:8

Extended by

• ClusterLayer
• CzmlLayer
• DynamicLayer
• FeatureGridLayer
• GeoJsonLayer
• GpxLayer
• GraticuleLayer
• GroundPrimitiveLayer
• HtmlLayer
• I3SLayer
• KmlLayer
• LabelLayer
• PrimitiveLayer
• RasterTileLayer
• TilesetLayer
• VectorLayer
• HeatMapLayer
• WindLayer

Constructors

new Layer()

new Layer(id): Layer

Defined in: src/layer/Layer.js:9

Parameters

id

any

Returns

Layer

Properties

_attr

_attr: object

Defined in: src/layer/Layer.js:18

---

_bid

_bid: any

Defined in: src/layer/Layer.js:11

---

_cache

_cache: object

Defined in: src/layer/Layer.js:17

---

_delegate

_delegate: any

Defined in: src/layer/Layer.js:12

---

_id

_id: string

Defined in: src/layer/Layer.js:10

---

_isGround

_isGround: boolean

Defined in: src/layer/Layer.js:16

---

_layerEvent

_layerEvent: LayerEvent

Defined in: src/layer/Layer.js:19

---

_show

_show: boolean

Defined in: src/layer/Layer.js:15

---

_state

_state: string

Defined in: src/layer/Layer.js:14

---

_viewer

_viewer: any

Defined in: src/layer/Layer.js:13

Accessors

attr

Get Signature

get attr(): object

Defined in: src/layer/Layer.js:53

Returns

object

Set Signature

set attr(attr): void

Defined in: src/layer/Layer.js:49

Parameters

attr

Returns

void

---

delegate

Get Signature

get delegate(): any

Defined in: src/layer/Layer.js:32

Returns

any

---

id

Get Signature

get id(): any

Defined in: src/layer/Layer.js:28

Returns

any

---

layerEvent

Get Signature

get layerEvent(): LayerEvent

Defined in: src/layer/Layer.js:45

Returns

LayerEvent

---

layerId

Get Signature

get layerId(): string

Defined in: src/layer/Layer.js:24

Returns

string

---

show

Get Signature

get show(): boolean

Defined in: src/layer/Layer.js:41

Returns

boolean

Set Signature

set show(show): void

Defined in: src/layer/Layer.js:36

Parameters

show

boolean

Returns

void

---

state

Get Signature

get state(): string

Defined in: src/layer/Layer.js:57

Returns

string

Methods

addOverlay()

addOverlay(overlay): Layer

Defined in: src/layer/Layer.js:165

Add overlay

Parameters

overlay

any

Returns

Layer

---

addOverlays()

addOverlays(overlays): Layer

Defined in: src/layer/Layer.js:175

Add overlays

Parameters

overlays

any

Returns

Layer

---

addTo()

addTo(viewer): Layer

Defined in: src/layer/Layer.js:279

Adds to the viewer

Parameters

viewer

any

Returns

Layer

---

clear()

clear(): void

Defined in: src/layer/Layer.js:263

Clears all overlays Subclasses need to be overridden

Returns

void

---

eachOverlay()

eachOverlay(method, context): Layer

Defined in: src/layer/Layer.js:240

Iterate through each overlay and pass it as an argument to the callback function

Parameters

method

any

context

any

Returns

Layer

---

fire()

fire(type, params): Layer

Defined in: src/layer/Layer.js:323

Trigger subscription event

Parameters

type

any

params

any

Returns

Layer

---

getOverlay()

getOverlay(overlayId): any

Defined in: src/layer/Layer.js:199

Returns the overlay by overlayId

Parameters

overlayId

any

Returns

any

---

getOverlayById()

getOverlayById(id): any

Defined in: src/layer/Layer.js:208

Returns the overlay by bid

Parameters

id

any

Returns

any

---

getOverlays()

getOverlays(): []

Defined in: src/layer/Layer.js:251

Returns all overlays

Returns

[]

---

getOverlaysByAttr()

getOverlaysByAttr(attrName, attrVal): []

Defined in: src/layer/Layer.js:224

Returns the overlays by attrName and AttrVal

Parameters

attrName

any

attrVal

any

Returns

[]

---

off()

off(type, callback, context): Layer

Defined in: src/layer/Layer.js:312

Unsubscribe event

Parameters

type

any

callback

any

context

any

Returns

Layer

---

on()

on(type, callback, context): Layer

Defined in: src/layer/Layer.js:300

Subscribe event

Parameters

type

any

callback

any

context

any

Returns

Layer

---

remove()

remove(): void

Defined in: src/layer/Layer.js:268

Removes from the viewer

Returns

void

---

removeOverlay()

removeOverlay(overlay): Layer

Defined in: src/layer/Layer.js:189

Remove overlay

Parameters

overlay

any

Returns

Layer

---

setStyle()

setStyle(style): void

Defined in: src/layer/Layer.js:291

sets the style, the style will apply to every overlay of the layer Subclasses need to be overridden

Parameters

style

any

Returns

void

---

getLayerType()

static getLayerType(type): any

Defined in: src/layer/Layer.js:343

Returns type

Parameters

type

any

Returns

any

---

registerType()

static registerType(type): void

Defined in: src/layer/Layer.js:332

Registers Type

Parameters

type

any

Returns

void