mapsglmaps/com.xweather.mapsgl.layers.spec/HeatmapLayerDescriptor

HeatmapLayerDescriptor

data class HeatmapLayerDescriptor(var id: String, var source: String, var sourceLayer: String? = null, var paint: HeatmapLayerPaint = HeatmapLayerPaint( heatmap = HeatmapPaint() ), var filter: Expression? = null, var stencilOnly: Boolean = false) : VectorLayerDescriptor<HeatmapLayerPaint> , LayerEventEmitter

Descriptor for a Mapbox heatmap layer: point density visualized as a color ramp, backed by vector or GeoJSON point data.

Add the source first, then com.xweather.mapsgl.map.MapController.addLayer. paint (HeatmapLayerPaint) maps to Mapbox heatmap-color, heatmap-weight, heatmap-intensity, heatmap-radius, and heatmap-opacity.

Use sourceLayer for MVT point layers; null for GeoJSON when the source is a single feature collection of points.

See also

Constructors

Link copied to clipboard
constructor(id: String, source: String, sourceLayer: String? = null, paint: HeatmapLayerPaint = HeatmapLayerPaint( heatmap = HeatmapPaint() ), filter: Expression? = null, stencilOnly: Boolean = false)

Properties

Link copied to clipboard
open override var filter: Expression?

Optional feature filter.

Link copied to clipboard
open override var id: String

Unique layer id.

Link copied to clipboard
open override var paint: HeatmapLayerPaint

Heatmap ramp, radius, intensity, and weight.

Link copied to clipboard
open override var source: String

Point-capable vector or GeoJSON source id.

Link copied to clipboard
open override var sourceLayer: String?

MVT layer name, or null for GeoJSON.

Link copied to clipboard
open override var stencilOnly: Boolean

When true, MapsGL does not register a Mapbox fill / line / circle / symbol / heatmap style layer. The com.xweather.mapsgl.layers.tile.VectorTileLayer still exists for tile/GeoJSON consumers, MVT fetch (e.g. com.xweather.mapsgl.map.mapbox.GlStencilCustomMaskCoordinator), and GLES stencil mesh build in com.xweather.mapsgl.renderers.TileLayerRenderer — only screen drawing via Mapbox paint is skipped.

Link copied to clipboard
open override val type: LayerType

Functions

Link copied to clipboard
open override fun off(eventName: String)
Link copied to clipboard
open override fun on(eventName: String, callback: (Any?) -> Unit)
Link copied to clipboard
open override fun trigger(eventName: String, data: Any?)