HeatmapLayer
HeatmapLayer¶
- HeatmapLayer is a style layer that renders one or more filled circles on the map.
Props¶
| Prop | Type | Default | Required | Description |
|---|---|---|---|---|
| style | HeatmapLayerStyleProps |
none |
false |
Customizable style attributes |
| sourceID | `` | VietmapGL.StyleSource.DefaultSourceID |
false |
visibility¶
Name
visibility
Description Whether this layer is displayed.
Type
enum
Default Value
visible
Supported Values
**visible - The layer is shown.
none - The layer is not shown.
heatmapRadius¶
Name
heatmapRadius
Description Radius of influence of one heatmap point in pixels. Increasing the value makes the heatmap smoother, but less detailed.
Type
number
Default Value
30
Units
pixels
Minimum
1
Expression
Parameters: zoom, feature, feature-state
heatmapRadiusTransition¶
Name
heatmapRadiusTransition
Description
The transition affecting any changes to this layer’s heatmapRadius propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}
heatmapWeight¶
Name
heatmapWeight
Description A measure of how much an individual point contributes to the heatmap. A value of 10 would be equivalent to having 10 points of weight 1 in the same spot. Especially useful when combined with clustering.
Type
number
Default Value
1
Minimum
0
Expression
Parameters: zoom, feature, feature-state
heatmapIntensity¶
Name
heatmapIntensity
Description
Similar to heatmapWeight but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level.
Type
number
Default Value
1
Minimum
0
Expression
Parameters: zoom
heatmapIntensityTransition¶
Name
heatmapIntensityTransition
Description
The transition affecting any changes to this layer’s heatmapIntensity propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}
heatmapColor¶
Name
heatmapColor
Description
Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses ["heatmapDensity"] as input.
Type
color
Default Value
interpolate,linear,heatmap-density,0,rgba(0, 0, 255, 0),0.1,royalblue,0.3,cyan,0.5,lime,0.7,yellow,1,red
Expression
Parameters: heatmap-density
heatmapOpacity¶
Name
heatmapOpacity
Description The global opacity at which the heatmap layer will be drawn.
Type
number
Default Value
1
Minimum
0
Maximum
1
Expression
Parameters: zoom
heatmapOpacityTransition¶
Name
heatmapOpacityTransition
Description
The transition affecting any changes to this layer’s heatmapOpacity propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}