mapbox-maps-android/com.mapbox.maps.extension.compose.style.layers.generated/HeatmapLayer

HeatmapLayer

@MapboxExperimental
@Composable
fun HeatmapLayer(sourceState: SourceState, layerId: String = remember { generateRandomLayerId("heatmap") }, heatmapColor: ColorValue = ColorValue.INITIAL, heatmapIntensity: DoubleValue = DoubleValue.INITIAL, heatmapIntensityTransition: Transition = Transition.INITIAL, heatmapOpacity: DoubleValue = DoubleValue.INITIAL, heatmapOpacityTransition: Transition = Transition.INITIAL, heatmapRadius: DoubleValue = DoubleValue.INITIAL, heatmapRadiusTransition: Transition = Transition.INITIAL, heatmapWeight: DoubleValue = DoubleValue.INITIAL, visibility: VisibilityValue = VisibilityValue.INITIAL, minZoom: LongValue = LongValue.INITIAL, maxZoom: LongValue = LongValue.INITIAL, sourceLayer: StringValue = StringValue.INITIAL, filter: Filter = Filter.INITIAL)

A heatmap.

See also

Parameters

sourceState

the source that drives this layer.

layerId

the ID of the layer, by default, a random id will be generated with UUID.

heatmapColor

Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses ["heatmap-density"] as input. 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"].

heatmapIntensity

Similar to heatmap-weight but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level. Default value: 1. Minimum value: 0.

heatmapIntensityTransition

Defines the transition of heatmapIntensity. Default value: 1. Minimum value: 0.

heatmapOpacity

The global opacity at which the heatmap layer will be drawn. Default value: 1. Value range: 0, 1

heatmapOpacityTransition

Defines the transition of heatmapOpacity. Default value: 1. Value range: 0, 1

heatmapRadius

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. Default value: 30. Minimum value: 1.

heatmapRadiusTransition

Defines the transition of heatmapRadius. Default value: 30. Minimum value: 1.

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. Default value: 1. Minimum value: 0.

visibility

Whether this layer is displayed. Default value: "visible".

minZoom

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden. Value range: 0, 24

maxZoom

The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden. Value range: 0, 24

sourceLayer

Layer to use from a vector tile source. Required for vector tile sources; prohibited for all other source types, including GeoJSON sources.

filter

An expression specifying conditions on source features. Only features that match the filter are displayed. Zoom expressions in filters are only evaluated at integer zoom levels. The ["feature-state", ...] expression is not supported in filter expressions. The ["pitch"] and ["distance-from-center"] expressions are supported only for filter expressions on the symbol layer.