xgis-cesium v0.1.9

---

xgis-cesium / HeatMapLayer

Class: HeatMapLayer

Defined in: src/heat-map/HeatMapLayer.js:16

Extends

• Layer

Constructors

new HeatMapLayer()

new HeatMapLayer(id, options): HeatMapLayer

Defined in: src/heat-map/HeatMapLayer.js:17

Parameters

id

any

options

Returns

HeatMapLayer

Overrides

Layer.constructor

Properties

_attr

_attr: object

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

Inherited from

Layer._attr

---

_bid

_bid: any

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

Inherited from

Layer._bid

---

_bounds

_bounds: Rectangle

Defined in: src/heat-map/HeatMapLayer.js:30

---

_boundsInMeter

_boundsInMeter: Rectangle

Defined in: src/heat-map/HeatMapLayer.js:31

---

_cache

_cache: object

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

Inherited from

Layer._cache

---

_canvas

_canvas: HTMLCanvasElement

Defined in: src/heat-map/HeatMapLayer.js:25

---

_delegate

_delegate: PrimitiveCollection

Defined in: src/heat-map/HeatMapLayer.js:23

Inherited from

Layer._delegate

---

_heat

_heat: WebGLHeatmap

Defined in: src/heat-map/HeatMapLayer.js:27

---

_id

_id: string

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

Inherited from

Layer._id

---

_isGround

_isGround: boolean

Defined in: src/heat-map/HeatMapLayer.js:24

Inherited from

Layer._isGround

---

_layerEvent

_layerEvent: LayerEvent

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

Inherited from

Layer._layerEvent

---

_options

_options: object

Defined in: src/heat-map/HeatMapLayer.js:19

classificationType

classificationType: number = 2

gradient

gradient: any = undefined

height

height: number = 0

radius

radius: number = 30

useGround

useGround: boolean = false

---

_points

_points: any[]

Defined in: src/heat-map/HeatMapLayer.js:29

---

_primitive

_primitive: any

Defined in: src/heat-map/HeatMapLayer.js:32

---

_scale

_scale: number

Defined in: src/heat-map/HeatMapLayer.js:28

---

_show

_show: boolean

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

Inherited from

Layer._show

---

_state

_state: string

Defined in: src/heat-map/HeatMapLayer.js:46

Inherited from

Layer._state

---

_viewer

_viewer: any

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

Inherited from

Layer._viewer

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

Inherited from

Layer.attr

---

delegate

Get Signature

get delegate(): any

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

Returns

any

Inherited from

Layer.delegate

---

id

Get Signature

get id(): any

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

Returns

any

Inherited from

Layer.id

---

layerEvent

Get Signature

get layerEvent(): LayerEvent

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

Returns

LayerEvent

Inherited from

Layer.layerEvent

---

layerId

Get Signature

get layerId(): string

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

Returns

string

Inherited from

Layer.layerId

---

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

Inherited from

Layer.show

---

state

Get Signature

get state(): string

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

Returns

string

Inherited from

Layer.state

---

type

Get Signature

get type(): any

Defined in: src/heat-map/HeatMapLayer.js:49

Returns

any

Methods

addOverlay()

addOverlay(overlay): Layer

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

Add overlay

Parameters

overlay

any

Returns

Layer

Inherited from

Layer.addOverlay

---

addOverlays()

addOverlays(overlays): Layer

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

Add overlays

Parameters

overlays

any

Returns

Layer

Inherited from

Layer.addOverlays

---

addTo()

addTo(viewer): Layer

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

Adds to the viewer

Parameters

viewer

any

Returns

Layer

Inherited from

Layer.addTo

---

clear()

clear(): HeatMapLayer

Defined in: src/heat-map/HeatMapLayer.js:234

Returns

HeatMapLayer

Overrides

Layer.clear

---

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

Inherited from

Layer.eachOverlay

---

fire()

fire(type, params): Layer

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

Trigger subscription event

Parameters

type

any

params

any

Returns

Layer

Inherited from

Layer.fire

---

getOverlay()

getOverlay(overlayId): any

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

Returns the overlay by overlayId

Parameters

overlayId

any

Returns

any

Inherited from

Layer.getOverlay

---

getOverlayById()

getOverlayById(id): any

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

Returns the overlay by bid

Parameters

id

any

Returns

any

Inherited from

Layer.getOverlayById

---

getOverlays()

getOverlays(): []

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

Returns all overlays

Returns

[]

Inherited from

Layer.getOverlays

---

getOverlaysByAttr()

getOverlaysByAttr(attrName, attrVal): []

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

Returns the overlays by attrName and AttrVal

Parameters

attrName

any

attrVal

any

Returns

[]

Inherited from

Layer.getOverlaysByAttr

---

off()

off(type, callback, context): Layer

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

Unsubscribe event

Parameters

type

any

callback

any

context

any

Returns

Layer

Inherited from

Layer.off

---

on()

on(type, callback, context): Layer

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

Subscribe event

Parameters

type

any

callback

any

context

any

Returns

Layer

Inherited from

Layer.on

---

remove()

remove(): void

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

Removes from the viewer

Returns

void

Inherited from

Layer.remove

---

removeOverlay()

removeOverlay(overlay): Layer

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

Remove overlay

Parameters

overlay

any

Returns

Layer

Inherited from

Layer.removeOverlay

---

setPoints()

setPoints(points): HeatMapLayer

Defined in: src/heat-map/HeatMapLayer.js:205

Parameters

points

any

Returns

HeatMapLayer

---

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

Inherited from

Layer.setStyle

---

getLayerType()

static getLayerType(type): any

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

Returns type

Parameters

type

any

Returns

any

Inherited from

Layer.getLayerType

---

registerType()

static registerType(type): void

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

Registers Type

Parameters

type

any

Returns

void

Inherited from

Layer.registerType