HeatmapLayer

class HeatmapLayer(val layerId: String, val sourceId: String) : Layer, HeatmapLayerDsl

A heatmap.

See also

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

Link copied to clipboard
fun HeatmapLayer(layerId: String, sourceId: String)

Types

Link copied to clipboard
object Companion

Static variables and methods.

Functions

Link copied to clipboard
fun bindTo(delegate: MapboxStyleManager)

Bind the layer to the Style.

open override fun bindTo(delegate: MapboxStyleManager, position: LayerPosition?)

Bind the layer to the map controller.

Link copied to clipboard
open override fun filter(filter: Expression): HeatmapLayer

A filter is a property at the layer level that determines which features should be rendered in a style layer.

Link copied to clipboard
open override fun heatmapColor(heatmapColor: Expression): HeatmapLayer

Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses ["heatmap-density"] as input.

Link copied to clipboard
open override fun heatmapIntensity(heatmapIntensity: Expression): HeatmapLayer
open override fun heatmapIntensity(heatmapIntensity: Double): HeatmapLayer

Similar to heatmap-weight but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level.

Link copied to clipboard

Set the HeatmapIntensity property transition options

Link copied to clipboard
open override fun heatmapOpacity(heatmapOpacity: Expression): HeatmapLayer
open override fun heatmapOpacity(heatmapOpacity: Double): HeatmapLayer

The global opacity at which the heatmap layer will be drawn.

Link copied to clipboard

Set the HeatmapOpacity property transition options

Link copied to clipboard
open override fun heatmapRadius(heatmapRadius: Expression): HeatmapLayer
open override fun heatmapRadius(heatmapRadius: Double): HeatmapLayer

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.

Link copied to clipboard

Set the HeatmapRadius property transition options

Link copied to clipboard
open override fun heatmapWeight(heatmapWeight: Expression): HeatmapLayer
open override fun heatmapWeight(heatmapWeight: Double): HeatmapLayer

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.

Link copied to clipboard
open override fun maxZoom(maxZoom: Double): HeatmapLayer

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

Link copied to clipboard
open override fun minZoom(minZoom: Double): HeatmapLayer

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

Link copied to clipboard
open override fun slot(slot: String): HeatmapLayer

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.

Link copied to clipboard
open override fun sourceLayer(sourceLayer: String): HeatmapLayer

A source layer is an individual layer of data within a vector source. A vector source can have multiple source layers.

Link copied to clipboard
open override fun visibility(visibility: Expression): HeatmapLayer
open override fun visibility(visibility: Visibility): HeatmapLayer

Whether this layer is displayed.

Properties

Link copied to clipboard

A filter is a property at the layer level that determines which features should be rendered in a style layer.

Link copied to clipboard

Defines the color of each pixel based on its density value in a heatmap. Should be an expression that uses ["heatmap-density"] as input.

Link copied to clipboard

Similar to heatmap-weight but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level.

Link copied to clipboard

Similar to heatmap-weight but controls the intensity of the heatmap globally. Primarily used for adjusting the heatmap based on zoom level.

Link copied to clipboard

Transition options for HeatmapIntensity.

Link copied to clipboard

The global opacity at which the heatmap layer will be drawn.

Link copied to clipboard

The global opacity at which the heatmap layer will be drawn.

Link copied to clipboard

Transition options for HeatmapOpacity.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Transition options for HeatmapRadius.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
open override val layerId: String
Link copied to clipboard
open override val maxZoom: Double?

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

Link copied to clipboard
open override val minZoom: Double?

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

Link copied to clipboard
open override val slot: String?

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.

Link copied to clipboard
Link copied to clipboard

A source layer is an individual layer of data within a vector source. A vector source can have multiple source layers.

Link copied to clipboard
open override val visibility: Visibility?

Whether this layer is displayed.

Link copied to clipboard

Whether this layer is displayed.

Extensions

Link copied to clipboard

Get the persistent property as Boolean.