M/style/Heatmap~Heatmap


import Heatmap from 'M/style/Heatmap';

Main constructor of the class. Creates a style heatmap with parameters specified by the user

new Heatmap(attribute, options, vendorOptions)

facade/js/style/Heatmap.js, line 37
Name Type Description
attribute string | function

The feature attribute to use for the weight or a function that returns a weight from a feature. Weight values should range from 0 to 1 (and values outside will be clamped to that range). Default is weight. Required.

options Mx.HeatmapStyleOptions

options style

vendorOptions object

vendorOptions style

Extends

  • M.Style

Members

module:M/style/Heatmap~Heatmap.DEFAULT_OPTIONS

Default options of style heatmap

attribute_{string} {function}

Methods

drawGeometryToCanvas(vectorContext)

facade/js/style/Heatmap.js, line 223

This function draws the style on the canvas

Name Type Description
vectorContext CanvasRenderingContext2D

context of style canvas

getAttributeName(){string|function}

facade/js/style/Heatmap.js, line 109

This function returns the attribute of heatmap style

getBlurSize(){number}

facade/js/style/Heatmap.js, line 187

This function returns the blur of heatmap style

getGradient(){Array.<string>}

facade/js/style/Heatmap.js, line 133

This function returns the gradient of heatmap style

getRadius(){number}

facade/js/style/Heatmap.js, line 164

This function returns the radius of heatmap style

setAttributeName(attribute)

facade/js/style/Heatmap.js, line 120

This function sets the attribute of heatmap style

Name Type Description
attribute string | function

The attribute of heatmap style

setBlurSize(blur)

facade/js/style/Heatmap.js, line 198

This function sets the blur of heatmap style

Name Type Description
blur number

setGradient(gradient)

facade/js/style/Heatmap.js, line 144

This function sets the gradient of heatmap style

Name Type Description
gradient Array.<string>

setRadius(radius)

facade/js/style/Heatmap.js, line 175

This function sets the radius of heatmap style

Name Type Description
radius number

toJSON(){object}

facade/js/style/Heatmap.js, line 257

This function implements the mechanism to generate the JSON of this instance

unapply(layer)

facade/js/style/Heatmap.js, line 97

This function remove the style to specified layer

Name Type Description
layer M.Layer.Vector

Layer where to apply choropleth style

updateCanvas()

facade/js/style/Heatmap.js, line 244

This function updates the canvas of style