HeatMapLayer class

Represent the density of data using different colors (HeatMap).

Extends

Constructors

HeatMapLayer(string | Source, string, HeatMapLayerOptions)

Constructs a new HeatMapLayer..

Properties

metadata

A property for associating custom data with the layer.

Methods

getId()

Gets the id of the layer

getOptions()

Gets the options of the heat map layer.

getSource()

Gets the source provided when creating the layer.

setOptions(HeatMapLayerOptions)

Sets the options of the heat map 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.

Property Details

metadata

A property for associating custom data with the layer.

metadata?: any

Property Value

any

Method Details

getId()

Gets the id of the layer

function getId()

Returns

string

getOptions()

Gets the options of the heat map layer.

function getOptions()

Returns

getSource()

Gets the source provided when creating the layer.

function getSource()

Returns

string | Source

setOptions(HeatMapLayerOptions)

Sets the options of the heat map layer.

function setOptions(options: HeatMapLayerOptions)

Parameters