HeatmapStyleLayer
Defined in: src/style/style_layer/heatmap_style_layer.ts:21
A style layer that defines a heatmap
Extends
Methods
getLayoutAffectingGlobalStateRefs()
getLayoutAffectingGlobalStateRefs():
Set<string>
Defined in: src/style/style_layer.ts:175
Get list of global state references that are used within layout or filter properties. This is used to determine if layer source need to be reloaded when global state property changes.
Returns
Set<string>
Inherited from
StyleLayer.getLayoutAffectingGlobalStateRefs
listens()
listens(
type:string):boolean
Defined in: src/util/evented.ts:165
Returns a true if this instance of Evented or any forwardeed instances of Evented have a listener for the specified type.
Parameters
| Parameter | Type | Description |
|---|---|---|
type |
string |
The event type |
Returns
boolean
true if there is at least one registered listener for specified event type, false otherwise
Inherited from
off()
off(
type:string,listener:Listener):HeatmapStyleLayer
Defined in: src/util/evented.ts:90
Removes a previously registered event listener.
Parameters
| Parameter | Type | Description |
|---|---|---|
type |
string |
The event type to remove listeners for. |
listener |
Listener |
The listener function to remove. |
Returns
HeatmapStyleLayer
Inherited from
on()
on(
type:string,listener:Listener):Subscription
Defined in: src/util/evented.ts:73
Adds a listener to a specified event type.
Parameters
| Parameter | Type | Description |
|---|---|---|
type |
string |
The event type to add a listen for. |
listener |
Listener |
The function to be called when the event is fired. The listener function is called with the data object passed to fire, extended with target and type properties. |
Returns
Inherited from
once()
once(
type:string,listener?:Listener):Promise<any> |HeatmapStyleLayer
Defined in: src/util/evented.ts:106
Adds a listener that will be called only once to a specified event type.
The listener will be called first time the event fires after the listener is registered.
Parameters
| Parameter | Type | Description |
|---|---|---|
type |
string |
The event type to listen for. |
listener? |
Listener |
The function to be called when the event is fired the first time. |
Returns
Promise<any> | HeatmapStyleLayer
this or a promise if a listener is not provided
Inherited from
setEventedParent()
setEventedParent(
parent?:Evented,data?:any):HeatmapStyleLayer
Defined in: src/util/evented.ts:176
Bubble all events fired by this instance of Evented to this parent instance of Evented.
Parameters
| Parameter | Type |
|---|---|
parent? |
Evented |
data? |
any |
Returns
HeatmapStyleLayer