HeatmapLayer

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

A heatmap.

See also

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

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

Types

Companion
Link copied to clipboard
object Companion

Static variables and methods.

Functions

bindTo
Link copied to clipboard
fun bindTo(delegate: StyleInterface)

Bind the layer to the Style.

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

Bind the layer to the map controller.

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

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

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

heatmapIntensityTransition
Link copied to clipboard
open override fun heatmapIntensityTransition(options: StyleTransition): HeatmapLayer

Set the HeatmapIntensity property transition options

open override fun heatmapIntensityTransition(block: StyleTransition.Builder.() -> Unit): HeatmapLayer
heatmapOpacity
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.

heatmapOpacityTransition
Link copied to clipboard
open override fun heatmapOpacityTransition(options: StyleTransition): HeatmapLayer

Set the HeatmapOpacity property transition options

open override fun heatmapOpacityTransition(block: StyleTransition.Builder.() -> Unit): HeatmapLayer
heatmapRadius
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.

heatmapRadiusTransition
Link copied to clipboard
open override fun heatmapRadiusTransition(options: StyleTransition): HeatmapLayer

Set the HeatmapRadius property transition options

open override fun heatmapRadiusTransition(block: StyleTransition.Builder.() -> Unit): HeatmapLayer
heatmapWeight
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.

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

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

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

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

Whether this layer is displayed.

Properties

filter
Link copied to clipboard
val filter: Expression?

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

heatmapColor
Link copied to clipboard
val heatmapColor: Expression?

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

heatmapIntensity
Link copied to clipboard
val heatmapIntensity: Double?

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

heatmapIntensityAsExpression
Link copied to clipboard
val heatmapIntensityAsExpression: Expression?

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

heatmapIntensityTransition
Link copied to clipboard
val heatmapIntensityTransition: StyleTransition?

Transition options for HeatmapIntensity.

heatmapOpacity
Link copied to clipboard
val heatmapOpacity: Double?

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

heatmapOpacityAsExpression
Link copied to clipboard
val heatmapOpacityAsExpression: Expression?

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

heatmapOpacityTransition
Link copied to clipboard
val heatmapOpacityTransition: StyleTransition?

Transition options for HeatmapOpacity.

heatmapRadius
Link copied to clipboard
val heatmapRadius: Double?

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.

heatmapRadiusAsExpression
Link copied to clipboard
val heatmapRadiusAsExpression: Expression?

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.

heatmapRadiusTransition
Link copied to clipboard
val heatmapRadiusTransition: StyleTransition?

Transition options for HeatmapRadius.

heatmapWeight
Link copied to clipboard
val heatmapWeight: Double?

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.

heatmapWeightAsExpression
Link copied to clipboard
val heatmapWeightAsExpression: Expression?

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.

layerId
Link copied to clipboard
open override val layerId: String
maxZoom
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.

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

sourceId
Link copied to clipboard
val sourceId: String
sourceLayer
Link copied to clipboard
val sourceLayer: String?

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

visibility
Link copied to clipboard
open override val visibility: Visibility?

Whether this layer is displayed.