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

ParticleLayerDescriptor

data class ParticleLayerDescriptor(var id: String, var source: String, var quality: DataQuality = DataQuality.exact, var paint: ParticleLayerPaint = ParticleLayerPaint( sample = SamplePaint(), particle = ParticlePaint() ), var mask: MaskLayerKind = MaskLayerKind.NONE, var maskLayerIds: List<String> = emptyList(), var maskLayerId: String? = null, var layerMask: LayerMaskSpec? = null, var stencilLayerMask: StencilLayerMaskSpec? = null, var maskCountryIso3166Alpha2: String? = null, var timing: LayerTiming? = null) : BitmapLayerDescriptor<ParticleLayerPaint> , LayerEventEmitter

Particle field over an encoded vector sample. Pair with an com.xweather.mapsgl.sources.source.spec.EncodedSourceDescriptor.

Constructors

constructor(id: String, source: String, quality: DataQuality = DataQuality.exact, paint: ParticleLayerPaint = ParticleLayerPaint( sample = SamplePaint(), particle = ParticlePaint() ), mask: MaskLayerKind = MaskLayerKind.NONE, maskLayerIds: List<String> = emptyList(), maskLayerId: String? = null, layerMask: LayerMaskSpec? = null, stencilLayerMask: StencilLayerMaskSpec? = null, maskCountryIso3166Alpha2: String? = null, timing: LayerTiming? = null)

Properties

open override var id: String

Stable layer id (Mapbox style layer id and MapsGL registry key).

layerMask

var layerMask: LayerMaskSpec?

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

mask

open override var mask: MaskLayerKind

maskCountryIso3166Alpha2

open override var maskCountryIso3166Alpha2: String?

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

maskLayerId

var maskLayerId: String?

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