Skip to main content

HeatmapLayer

Mapbox spec: heatmap

import { HeatmapLayer } from '@rnmapbox/maps';

HeatmapLayer

HeatmapLayer is a style layer that renders one or more filled circles on the map.

props

id

string

required A string that uniquely identifies the source in the style to which it is added.

existing

boolean

The id refers to en existing layer in the style. Does not create a new layer.

sourceID

string

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.

defaults to: Mapbox.StyleSource.DefaultSourceID

sourceLayerID

string

Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style.

aboveLayerID

string

Inserts a layer above aboveLayerID.

belowLayerID

string

Inserts a layer below belowLayerID

layerIndex

number

Inserts a layer at a specified index

filter

FilterExpression

Filter only the features in the source layer that satisfy a condition that you define

minZoomLevel

number

The minimum zoom level at which the layer gets parsed and appears.

maxZoomLevel

number

The maximum zoom level at which the layer gets parsed and appears.

slot

'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

style

HeatmapLayerStyleProps

Customizable style attributes

styles


visibility

Name: visibility

Mapbox spec: 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.

Expression

Parameters: ``


heatmapRadius

Name: heatmapRadius

Mapbox spec: heatmap-radius

Description

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.

Type

number

Default Value

30

Units

pixels

Minimum

1

Expression

Parameters: zoom, feature, feature-state, measure-light


heatmapRadiusTransition

Name: heatmapRadiusTransition

Description

The transition affecting any changes to this layer’s heatmapRadius property.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


heatmapWeight

Name: heatmapWeight

Mapbox spec: heatmap-weight

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, measure-light


heatmapIntensity

Name: heatmapIntensity

Mapbox spec: heatmap-intensity

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 property.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


heatmapColor

Name: heatmapColor

Mapbox spec: heatmap-color

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

Mapbox spec: heatmap-opacity

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 property.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}