HeatmapLayer

A heatmap.

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

See also

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

HeatmapLayer
Link copied to clipboard

the ID of the layer

fun HeatmapLayer(layerId: String, sourceId: String)

Types

Companion
Link copied to clipboard

Static variables and methods.

object Companion

Functions

bindTo
Link copied to clipboard

Bind the layer to the Style.

override fun bindTo(delegate: StyleInterface)

Bind the layer to the map controller.

open override fun bindTo(delegate: StyleInterface, position: LayerPosition?)
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
filter
Link copied to clipboard

Set the filter property

open override fun filter(filter: Expression): HeatmapLayer
getCachedLayerProperties
Link copied to clipboard
override fun getCachedLayerProperties(): Value
hashCode
Link copied to clipboard
open override fun hashCode(): Int
heatmapColor
Link copied to clipboard

Set the HeatmapColor property

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

Set the HeatmapIntensity property

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

Set the HeatmapIntensity property transition options

open override fun heatmapIntensityTransition(options: StyleTransition): HeatmapLayer
open override fun heatmapIntensityTransition(block: StyleTransition.Builder.() -> Unit): HeatmapLayer
heatmapOpacity
Link copied to clipboard

Set the HeatmapOpacity property

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

Set the HeatmapOpacity property transition options

open override fun heatmapOpacityTransition(options: StyleTransition): HeatmapLayer
open override fun heatmapOpacityTransition(block: StyleTransition.Builder.() -> Unit): HeatmapLayer
heatmapRadius
Link copied to clipboard

Set the HeatmapRadius property

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

Set the HeatmapRadius property transition options

open override fun heatmapRadiusTransition(options: StyleTransition): HeatmapLayer
open override fun heatmapRadiusTransition(block: StyleTransition.Builder.() -> Unit): HeatmapLayer
heatmapWeight
Link copied to clipboard

Set the HeatmapWeight property

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

Set the maxzoom property

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

Set the minzoom property

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

Set the sourceLayer property

open override fun sourceLayer(sourceLayer: String): HeatmapLayer
toString
Link copied to clipboard
open override fun toString(): String
updateProperty
Link copied to clipboard
override fun updateProperty(property: PropertyValue<*>)
visibility
Link copied to clipboard

Set the Visibility property

open override fun visibility(visibility: Visibility): HeatmapLayer

Properties

filter
Link copied to clipboard

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

val filter: Expression?
heatmapColor
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.

val heatmapColor: Expression?
heatmapIntensity
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.

val heatmapIntensity: Double?
heatmapIntensityAsExpression
Link copied to clipboard

This is an Expression representation of "heatmap-intensity".

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

val heatmapIntensityAsExpression: Expression?
heatmapIntensityTransition
Link copied to clipboard

Transition options for HeatmapIntensity.

val heatmapIntensityTransition: StyleTransition?
heatmapOpacity
Link copied to clipboard

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

val heatmapOpacity: Double?
heatmapOpacityAsExpression
Link copied to clipboard

This is an Expression representation of "heatmap-opacity".

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

val heatmapOpacityAsExpression: Expression?
heatmapOpacityTransition
Link copied to clipboard

Transition options for HeatmapOpacity.

val heatmapOpacityTransition: StyleTransition?
heatmapRadius
Link copied to clipboard

Radius of influence of one heatmap point in pixels. Increasing the value makes the heatmap smoother, but less detailed.

val heatmapRadius: Double?
heatmapRadiusAsExpression
Link copied to clipboard

This is an Expression representation of "heatmap-radius".

Radius of influence of one heatmap point in pixels. Increasing the value makes the heatmap smoother, but less detailed.

val heatmapRadiusAsExpression: Expression?
heatmapRadiusTransition
Link copied to clipboard

Transition options for HeatmapRadius.

val heatmapRadiusTransition: StyleTransition?
heatmapWeight
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.

val heatmapWeight: Double?
heatmapWeightAsExpression
Link copied to clipboard

This is an Expression representation of "heatmap-weight".

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.

val heatmapWeightAsExpression: Expression?
layerId
Link copied to clipboard

the ID of the layer

open override val layerId: String
layerProperties
Link copied to clipboard

Properties of this layer.

override val layerProperties: HashMap<String, PropertyValue<*>>
maxZoom
Link copied to clipboard

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

Range: minimum: 0 maximum: 24

open override val maxZoom: Double?
minZoom
Link copied to clipboard

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

Range: minimum: 0 maximum: 24

open override val minZoom: Double?
sourceId
Link copied to clipboard

the ID of the source

val sourceId: String
sourceLayer
Link copied to clipboard

Source layer.

val sourceLayer: String?
visibility
Link copied to clipboard

Visibility of the layer.

open override val visibility: Visibility?