mapsglmaps/com.xweather.mapsgl.style/ColorMaskOptions

ColorMaskOptions

data class ColorMaskOptions(val channel: ColorBand, val value: Int, val colorscale: ColorScaleOptions = ColorScaleOptions(), val drawRange: ClosedRange<Double>? = null)

Per-band mask entry for a multi-scale colorscale (JS/Apple colorscale.masks).

Used when a single sample channel carries the data value and another band (e.g. green) holds discrete mask codes that select which nested colorscale to apply.

Constructors

Link copied to clipboard
constructor(channel: ColorBand, value: Int, colorscale: ColorScaleSpec, drawRange: ClosedRange<Double>? = null)

Builds a mask entry from a ColorScaleSpec, the type colorscale had through 1.6.0.

constructor(channel: ColorBand, value: Int, colorscale: ColorScaleOptions = ColorScaleOptions(), drawRange: ClosedRange<Double>? = null)

Properties

Link copied to clipboard
val channel: ColorBand

Raster band that stores the mask code (Apple band / JS channel).

Link copied to clipboard
val colorscale: ColorScaleOptions

Color scale for samples matching this mask. Merged over the parent colorscale when incomplete.

Link copied to clipboard
val drawRange: ClosedRange<Double>? = null

Optional draw-range override for this mask (JS drawRange).

Link copied to clipboard
val value: Int

Discrete mask code in that band (e.g. radar ptype 1 rain / 2 snow / 3 mix).