HeatMapLayer class
Represent the density of data using different colors (HeatMap).
- Extends
Constructors
Heat |
Constructs a new HeatMapLayer.. |
Inherited Properties
metadata | A property for associating custom data with the layer. |
Methods
get |
Gets the options of the heat map layer. |
get |
Gets the source provided when creating the layer. |
set |
Sets the options of the heat map layer. |
Inherited Methods
get |
Gets the id of the layer |
get |
Gets the map that the layer is currently added to, or null. |
on |
Initialization method for the layer which is called when added to the map. |
on |
Method that is called when the layer is removed from the map. Should perform any necessary cleanup for the layer. |
Constructor Details
HeatMapLayer(string | Source, string, HeatMapLayerOptions)
Constructs a new HeatMapLayer..
new HeatMapLayer(source: string | Source, id?: string, options?: HeatMapLayerOptions)
Parameters
- source
-
string | Source
The id or instance of a data source which the layer will render.
- id
-
string
The id of the layer. If not specified a random one will be generated.
- options
- HeatMapLayerOptions
The options of the line layer.
Inherited Property Details
metadata
A property for associating custom data with the layer.
metadata?: any
Property Value
any
Inherited From Layer.metadata
Method Details
getOptions()
Gets the options of the heat map layer.
function getOptions(): HeatMapLayerOptions
Returns
getSource()
Gets the source provided when creating the layer.
function getSource(): string | Source
Returns
string | Source
setOptions(HeatMapLayerOptions)
Sets the options of the heat map layer.
function setOptions(options: HeatMapLayerOptions)
Parameters
- options
- HeatMapLayerOptions
Inherited Method Details
getId()
getMap()
Gets the map that the layer is currently added to, or null.
function getMap(): Map
Returns
Inherited From Layer.getMap
onAdd(Map)
Initialization method for the layer which is called when added to the map.
function onAdd(map: Map)
Parameters
- map
- Map
The map the layer has been added to.
Inherited From Layer.onAdd
onRemove()
Method that is called when the layer is removed from the map. Should perform any necessary cleanup for the layer.
function onRemove()
Inherited From Layer.onRemove