| Prop | Type | Default | Required | Description |
|---|---|---|---|---|
| id | string |
none |
true |
A string that uniquely identifies the source in the style to which it is added. |
| sourceID | string |
MapboxGL.StyleSource.DefaultSourceID |
false |
The source from which to obtain the data to style. If the source has not yet been added to the current style, the behavior is undefined. Inferred from parent source only if the layer is a direct child to it. |
| sourceLayerID | string |
none |
false |
Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style. |
| aboveLayerID | string |
none |
false |
Inserts a layer above aboveLayerID. |
| belowLayerID | string |
none |
false |
Inserts a layer below belowLayerID |
| layerIndex | number |
none |
false |
Inserts a layer at a specified index |
| filter | array |
none |
false |
Filter only the features in the source layer that satisfy a condition that you define |
| minZoomLevel | number |
none |
false |
The minimum zoom level at which the layer gets parsed and appears. |
| maxZoomLevel | number |
none |
false |
The maximum zoom level at which the layer gets parsed and appears. |
| style | union |
none |
false |
Customizable style attributes |
visibility
Whether this layer is displayed.
enum
visible
visible - The layer is shown.
none - The layer is not shown.
heatmapRadius
Radius of influence of one heatmap point in pixels. Increasing the value makes the heatmap smoother, but less detailed.
number
30
pixels
1
Parameters: zoom, feature, feature-state
heatmapRadiusTransition
The transition affecting any changes to this layer’s heatmapRadius propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
heatmapWeight
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.
number
1
0
Parameters: zoom, feature, feature-state
heatmapIntensity
Similar to heatmapWeight but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level.
number
1
0
Parameters: zoom
heatmapIntensityTransition
The transition affecting any changes to this layer’s heatmapIntensity propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
heatmapColor
Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses ["heatmapDensity"] as input.
color
interpolate,linear,heatmap-density,0,rgba(0, 0, 255, 0),0.1,royalblue,0.3,cyan,0.5,lime,0.7,yellow,1,red
Parameters: heatmap-density
heatmapOpacity
The global opacity at which the heatmap layer will be drawn.
number
1
0
1
Parameters: zoom
heatmapOpacityTransition
The transition affecting any changes to this layer’s heatmapOpacity propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}