RasterLayerDescriptor

data class RasterLayerDescriptor(var id: String, var source: String, var quality: DataQuality = DataQuality.exact, var paint: RasterLayerPaint = RasterLayerPaint( raster = RasterPaint() ), var maskLayerIds: List<String> = emptyList(), var maskLayerId: String? = null, var layerMask: LayerMaskSpec? = null, var stencilLayerMask: StencilLayerMaskSpec? = null) : BitmapLayerDescriptor<RasterLayerPaint> , LayerEventEmitter

Constructors

Link copied to clipboard
constructor(id: String, source: String, quality: DataQuality = DataQuality.exact, paint: RasterLayerPaint = RasterLayerPaint( raster = RasterPaint() ), maskLayerIds: List<String> = emptyList(), maskLayerId: String? = null, layerMask: LayerMaskSpec? = null, stencilLayerMask: StencilLayerMaskSpec? = null)

Properties

Link copied to clipboard
open override var id: String
Link copied to clipboard

JS-style mask convenience; takes precedence over maskLayerIds and maskLayerId when provided.

Link copied to clipboard
open override var mask: MaskLayerKind
Link copied to clipboard
open override var maskCountryIso3166Alpha2: String?

When mask is MaskLayerKind.COUNTRY, ISO 3166-1 alpha-2 (e.g. "US", "ES"). Ignored for other mask kinds.

Link copied to clipboard

Single mask layer id shorthand (JS mask: "layerId" on a layer). Lowest precedence among stencil mask fields: after stencilLayerMask, layerMask, and maskLayerIds.

Link copied to clipboard

JS-style convenience for custom stencil masks: mask: { layerIds: ["admin-mask"] }

Link copied to clipboard
open override var paint: RasterLayerPaint
Link copied to clipboard
open override var quality: DataQuality
Link copied to clipboard
open override var source: String
Link copied to clipboard

Advanced custom stencil mask configuration. Takes precedence over maskLayerIds when set.

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?)