HeatmapLayer

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

A heatmap.

See also

The online documentation

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

HeatmapLayer

fun HeatmapLayer(layerId: String, sourceId: String)

Types

Companion

object Companion

Static variables and methods.

Functions

bindTo

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

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

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

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

open override fun heatmapIntensityTransition(options: StyleTransition): HeatmapLayer

Set the HeatmapIntensity property transition options

open override fun heatmapIntensityTransition(block: StyleTransition.Builder.() -> Unit): HeatmapLayer

DSL for heatmapIntensityTransition.

heatmapOpacity

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

open override fun heatmapOpacityTransition(options: StyleTransition): HeatmapLayer

Set the HeatmapOpacity property transition options

open override fun heatmapOpacityTransition(block: StyleTransition.Builder.() -> Unit): HeatmapLayer

DSL for heatmapOpacityTransition.

heatmapRadius

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

open override fun heatmapRadiusTransition(options: StyleTransition): HeatmapLayer

Set the HeatmapRadius property transition options

open override fun heatmapRadiusTransition(block: StyleTransition.Builder.() -> Unit): HeatmapLayer

DSL for heatmapRadiusTransition.

heatmapWeight

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

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

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

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

open override fun visibility(visibility: Visibility): HeatmapLayer

Whether this layer is displayed.

Properties

filter

val filter: Expression?

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

heatmapColor

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

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

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

val heatmapIntensityTransition: StyleTransition?

Transition options for HeatmapIntensity.

heatmapOpacity

val heatmapOpacity: Double?

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

heatmapOpacityAsExpression

val heatmapOpacityAsExpression: Expression?

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

heatmapOpacityTransition

val heatmapOpacityTransition: StyleTransition?

Transition options for HeatmapOpacity.

heatmapRadius

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

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

val heatmapRadiusTransition: StyleTransition?

Transition options for HeatmapRadius.

heatmapWeight

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

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

open override val layerId: String

maxZoom

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

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

val sourceId: String

sourceLayer

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

open override val visibility: Visibility?

Whether this layer is displayed.