Mapbox spec: heatmap
import { HeatmapLayer } from '@rnmapbox/maps';
HeatmapLayerHeatmapLayer is a style layer that renders one or more filled circles on the map.
stringrequired A string that uniquely identifies the source in the style to which it is added.
booleanThe id refers to en existing layer in the style. Does not create a new layer.
stringThe 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.
defaults to: Mapbox.StyleSource.DefaultSourceID
stringIdentifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style.
stringInserts a layer above aboveLayerID.
stringInserts a layer below belowLayerID
numberInserts a layer at a specified index
FilterExpressionFilter only the features in the source layer that satisfy a condition that you define
numberThe minimum zoom level at which the layer gets parsed and appears.
numberThe maximum zoom level at which the layer gets parsed and appears.
'bottom' | 'middle' | 'top'The slot this layer is assigned to. If specified, and a slot with that name exists, it will be placed at that position in the layer order.
v11 only
HeatmapLayerStylePropsCustomizable style attributes
Name: visibility
Mapbox spec: visibility
Whether this layer is displayed.
enum
visible
visible - The layer is shown.
none - The layer is not shown.
Parameters: ``
Name: heatmapRadius
Mapbox spec: heatmap-radius
Radius of influence of one heatmap point in pixels. Increasing the value makes the heatmap smoother, but less detailed. queryRenderedFeatures on heatmap layers will return points within this radius.
number
30
pixels
1
Parameters: zoom, feature, feature-state, measure-light
Name: heatmapRadiusTransition
The transition affecting any changes to this layer’s heatmapRadius property.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: heatmapWeight
Mapbox spec: heatmap-weight
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, measure-light
Name: heatmapIntensity
Mapbox spec: heatmap-intensity
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
Name: heatmapIntensityTransition
The transition affecting any changes to this layer’s heatmapIntensity property.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: heatmapColor
Mapbox spec: heatmap-color
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
Name: heatmapOpacity
Mapbox spec: heatmap-opacity
The global opacity at which the heatmap layer will be drawn.
number
1
0
1
Parameters: zoom
Name: heatmapOpacityTransition
The transition affecting any changes to this layer’s heatmapOpacity property.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}