HeatmapLayerDsl

interface HeatmapLayerDsl

This Interface contains all the functions that will be exposed to Koltin DSL.

Separated the DSL receiver class to this interface to avoid IDE code suggestion for property getters.

Functions

filter
Link copied to clipboard
abstract 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
abstract 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
abstract fun heatmapIntensity(heatmapIntensity: Expression): HeatmapLayer
abstract fun heatmapIntensity(heatmapIntensity: Double = 1.0): 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
abstract fun heatmapIntensityTransition(options: StyleTransition): HeatmapLayer
abstract fun heatmapIntensityTransition(block: StyleTransition.Builder.() -> Unit): HeatmapLayer

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

heatmapOpacity
Link copied to clipboard
abstract fun heatmapOpacity(heatmapOpacity: Expression): HeatmapLayer
abstract fun heatmapOpacity(heatmapOpacity: Double = 1.0): HeatmapLayer

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

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

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

heatmapRadius
Link copied to clipboard
abstract fun heatmapRadius(heatmapRadius: Expression): HeatmapLayer
abstract fun heatmapRadius(heatmapRadius: Double = 30.0): HeatmapLayer

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

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

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

heatmapWeight
Link copied to clipboard
abstract fun heatmapWeight(heatmapWeight: Expression): HeatmapLayer
abstract fun heatmapWeight(heatmapWeight: Double = 1.0): 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
abstract 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
abstract 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
abstract 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
abstract fun visibility(visibility: Visibility): HeatmapLayer

Whether this layer is displayed.

Inheritors

HeatmapLayer
Link copied to clipboard