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

HeatmapLayerState

@Stable

class HeatmapLayerState

The state holder for HeatmapLayer's layer properties.

Constructors

HeatmapLayerState

fun HeatmapLayerState()

Construct an default HeatmapLayerState.

Properties

filter

var filter: 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.

heatmapColor

var heatmapColor: ColorValue

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

var heatmapIntensity: DoubleValue

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

var heatmapIntensityTransition: Transition

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

heatmapOpacity

var heatmapOpacity: DoubleValue

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

heatmapOpacityTransition

var heatmapOpacityTransition: Transition

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

heatmapRadius

var heatmapRadius: DoubleValue

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

var heatmapRadiusTransition: Transition

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

heatmapWeight

var heatmapWeight: DoubleValue

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.

maxZoom

var maxZoom: LongValue

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

minZoom

var minZoom: LongValue

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

sourceLayer

var sourceLayer: StringValue

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

visibility

var visibility: VisibilityValue

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

HeatmapLayerState

See also

Constructors

Properties