mapsglmaps/com.xweather.mapsgl.style

Package-level declarations

Types

Anchor

data class Anchor(val rawValue: String)

Style-JSON string for icon-anchor / text-anchor (e.g. "center").

AnchorOffset

data class AnchorOffset(val x: Double, val y: Double)

Two-component offset serialized as [x, y] for icon-offset / text-offset.

Celcius

data class Celcius(val start: Double, val endInclusive: Double) : TypedRange<Double>

CircleLayerPaint

data class CircleLayerPaint(var opacity: Float = 1.0f, var fill: FillPaint = FillPaint(), var stroke: StrokePaint = StrokePaint(), var circle: CirclePaint) : VectorLayerPaint

Paint for com.xweather.mapsgl.layers.spec.CircleLayerDescriptor: disc fill, inset stroke, and radius.

CirclePaint

class CirclePaint(color: StyleValue<Color> = StyleValue.Constant(Color.Red), var radius: StyleValue<Double> = StyleValue.Constant(6.0), var sortKey: StyleValue<Double>? = null, var eventEmitter: LayerEventEmitter? = null) : Paint

Circle disc styling. radius is the outer radius including an inset StrokePaint on CircleLayerPaint. Used by CircleLayerPaint.circle.

CircleStyleSpec

data class CircleStyleSpec(val radius: Int)

ColorEntry

data class ColorEntry(val color: Int, val position: Double, val value: Double)

ColorLookupTable

class ColorLookupTable(inputStops: List<Any>, val range: ClosedRange<Double>, val interpolate: Boolean = true, val interval: Double = 0.0, var roundDown: Boolean = false)

Color lookup table.

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

ColorRampResult

data class ColorRampResult(val stops: List<ColorRampResult.Entry>, val valueForPosition: (position: Double) -> Double, val positionForValue: (value: Double) -> Double)

A data class that holds the result of generating a color ramp from a ColorScale. It contains the generated color stops and functions to map between values and positions.

ColorScale

class ColorScale

ColorScaleLegendDisabled

class ColorScaleLegendDisabled

A ColorScale maps numeric values to a color palette.

ColorScaleOptions

data class ColorScaleOptions(var stops: List<Any> = emptyList(), var positions: List<Double>? = null, var interval: Double = 0.0, var range: ClosedRange<Double>? = null, var normalized: Boolean = false, var interpolate: Boolean = true, var masks: List<ColorMaskOptions>? = null, var roundDown: Boolean = false)

Color ramp for encoded/sample layers: stops, optional positions, data range, and interpolation flags. Nested masks select a scale from a discrete band (e.g. precip type).

ColorScaleSpec

data class ColorScaleSpec(val stops: List<Number>, val positions: List<Number>, val interval: Int, val range: ValueRange, val normalized: Boolean, val interpolate: Boolean)

Color-scale specification (stops, positions, interval, range) used when building ColorScaleOptions.

ColorStop

data class ColorStop(val value: Double, val color: Color)

ColorStopLegendDisabled

data class ColorStopLegendDisabled(val value: Double, val color: Color)

Defines a value/color pair for a ColorScale.

ContourLayerPaint

data class ContourLayerPaint(var opacity: Float = 1.0f, var sample: SamplePaint, var contour: ContourPaint) : LayerPaint

Paint for com.xweather.mapsgl.layers.spec.ContourLayerDescriptor: sampled field plus isoline style.

ContourPaint

class ContourPaint(colorScale: ColorScaleOptions = ColorScaleOptions(), var multiband: Boolean = false, var meld: Boolean = true, var eventEmitter: LayerEventEmitter? = null, var interval: StyleValue<Double> = StyleValue.Constant(2.0), var majorInterval: StyleValue<Double> = StyleValue.Constant(10.0), var width: StyleValue<Double> = StyleValue.Constant(1.0), var majorWidth: StyleValue<Double> = StyleValue.Constant(3.0), var scale: StyleValue<Double> = StyleValue.Constant(1.0), var offset: StyleValue<Double> = StyleValue.Constant(0.0)) : Paint

Isoline (contour) styling on top of SamplePaint: interval, major interval, line widths, and value offset / scale. Used by ContourLayerPaint.

ContourStyleSpec

data class ContourStyleSpec(val interval: Int, val majorInterval: Int, val width: Int, val majorWidth: Int, val scale: Int, val offset: Int)

DataColorScale

class DataColorScale(config: Map<String, Any> = emptyMap())

Expression

data class Expression(val raw: Any)

Mapbox style expression wrapper: a JSON-serializable tree (usually a List whose first element is the operator) compatible with the Mapbox expression spec.

ExpressionOperation

data class ExpressionOperation(val dataRange: ValueRange, val value: (Map<String, Int>) -> Int, val chunk: String)

Fahrenheit

data class Fahrenheit(val start: Double, val endInclusive: Double) : TypedRange<Double>

FillLayerPaint

data class FillLayerPaint(var opacity: Float = 1.0f, var fill: FillPaint, var stroke: StrokePaint? = StrokePaint(thickness = StyleValue.Constant(0.0))) : VectorLayerPaint

Paint for com.xweather.mapsgl.layers.spec.FillLayerDescriptor: polygon fill plus optional outline stroke.

FillPaint

class FillPaint(color: StyleValue<Color> = StyleValue.Constant(Color.Red), var pattern: StyleValue<String>? = null, var opacity: StyleValue<Double> = StyleValue.Constant(1.0), var eventEmitter: LayerEventEmitter? = null, var sortKey: StyleValue<String>? = null, var sortDirection: SortDirection = SortDirection.ASCENDING) : Paint

Polygon fill color, optional pattern, opacity, and sort key. Used by FillLayerPaint and as the fill block on CircleLayerPaint / SymbolLayerPaint.

FillStyleSpec

data class FillStyleSpec(val opacity: Double)

GridLayerPaint

data class GridLayerPaint(var opacity: Float = 1.0f, var fill: FillPaint? = defaultGridFill(), var stroke: StrokePaint? = null, var icon: IconPaint = IconPaint(), var text: List<TextPaint> = emptyList(), var grid: GridPaint = GridPaint(spacing = 20.0), var sample: SamplePaint? = null, var symbol: SymbolPlacementPaint = SymbolPlacementPaint(allowOverlap = StyleValue.Constant(true))) : VectorLayerPaint

Paint for com.xweather.mapsgl.layers.spec.GridLayerDescriptor: sampled encoded values plus instanced icons (arrows/barbs) at a grid spacing.

GridPaint

class GridPaint(var spacing: Double = 20.0) : Paint

Grid spacing in logical px from style/JS.

GridStyleSpec

data class GridStyleSpec(val size: Int, val spacing: Int)

HeatmapLayerPaint

data class HeatmapLayerPaint(var opacity: Float = 1.0f, var heatmap: HeatmapPaint) : VectorLayerPaint

Paint for com.xweather.mapsgl.layers.spec.HeatmapLayerDescriptor.

HeatmapPaint

data class HeatmapPaint(var color: StyleValue<Color> = defaultHeatmapColor(), var intensity: StyleValue<Double> = StyleValue.Constant(1.0), var radius: StyleValue<Double> = StyleValue.Constant(10.0), var weight: StyleValue<Double> = StyleValue.Constant(1.0), var blur: StyleValue<Double> = StyleValue.Constant(1.0)) : Paint

Heatmap kernel styling (Mapbox heatmap-*). Used by HeatmapLayerPaint.

HeatmapStyleSpec

data class HeatmapStyleSpec(val color: List<Number>, val radius: Int, val blur: Int, val intensity: Int, val weight: Int, val opacity: Double)

IconAtlas

data class IconAtlas(val ids: List<String>, val interval: Double)

Icon atlas (parity with JS icon.atlas / Apple IconAtlasPaint: ordered ids and a data-value interval used to pick an index via floor(value / interval)).

IconPaint

class IconPaint(allowOverlap: StyleValue<Boolean> = StyleValue.Constant(true), image: StyleValue<String>? = null, size: StyleValue<Double>? = null, iconSize: IconSize? = null, atlas: IconAtlas? = null, anchor: StyleValue<Anchor> = StyleValue.Constant(Anchor.CENTER), offset: StyleValue<AnchorOffset> = StyleValue.Constant(AnchorOffset()), padding: StyleValue<Double> = StyleValue.Constant(0.0), rotation: Double = 0.0, rotationUsesDataDirection: Boolean = false, scale: StyleValue<Double>? = null, type: String? = null, spin: Boolean = false, spinDegreesPerSecond: Float = 180.0f, shader: String? = null, factor: StyleValue<Double>? = null, placement: SymbolPlacementPaint? = null, source: IconSourcePaint? = null) : Paint

Icon style options (Apple IconPaint). Prefer placement / source for new code; named constructor parameters (image, atlas, allowOverlap, …) remain supported for existing call sites.

IconSize

class IconSize(width: Float, height: Float)

Width and height in the same units as MapsGL JS icon.size — pixel dimensions for the laid-out symbol quad (see web SymbolStore.layoutIcon: w/h from PaintStyle.iconSize).

IconSourcePaint

sealed class IconSourcePaint

How an icon image is resolved (Apple IconSourcePaint).

LayerPaint

interface LayerPaint

Layer-level paint: opacity plus type-specific nested paint blocks.

LineCap

enum LineCap : Enum<LineCap>

How the start and end of an open line string are terminated. Maps to Mapbox line-cap and is serialized from StrokePaint.lineCap / LineLayerPaint via StyleJSON.

LineJoin

enum LineJoin : Enum<LineJoin>

How connected line segments meet at a vertex. Maps to Mapbox line-join and is serialized from StrokePaint.lineJoin / LineLayerPaint via StyleJSON.

LineLayerPaint

data class LineLayerPaint(var opacity: Float = 1.0f, var stroke: StrokePaint) : VectorLayerPaint

Paint model for vector line layers.

Paint

interface Paint

Marker for paint models used in a single render pass (fill, stroke, sample, particle, …).

PaintStyleSpec

interface PaintStyleSpec

ParticleDensity

enum ParticleDensity : Enum<ParticleDensity>

How densely particles are spawned. COUNT uses ParticlePaint.count instead of a density preset.

ParticleKind

enum ParticleKind : Enum<ParticleKind>

Particle glyph: disc, bar, or arrow (JS/Apple particle.type).

ParticleLayerPaint

data class ParticleLayerPaint(var opacity: Float = 1.0f, var sample: SamplePaint, var particle: ParticlePaint) : LayerPaint

Paint for com.xweather.mapsgl.layers.spec.ParticleLayerDescriptor: sampled vector field plus particles.

ParticlePaint

class ParticlePaint(var kind: ParticleKind = ParticleKind.CIRCLE, var density: ParticleDensity = ParticleDensity.NORMAL, var count: Int = 0, var size: Size = Size(2), var speed: Double = 1.0, var trails: Boolean = true, var trailsFade: Double = 0.97, var dropRate: Double = 0.01, var dropRateBump: Double = 0.01) : Paint

Animated particle field styling (kind, density, size, speed, trails). Used by ParticleLayerPaint together with a SamplePaint that supplies the vector field.

ParticleStyleSpec

data class ParticleStyleSpec(val count: Int, val density: ParticleDensity, val size: Int, val speed: Int, val trails: Boolean, val trailsFade: Int, val dropRate: Int, val dropRateBump: Int)

ParticleTrailLength

class ParticleTrailLength(val value: Float)

RasterLayerPaint

data class RasterLayerPaint(var opacity: Float = 1.0f, var raster: RasterPaint) : LayerPaint

Paint for com.xweather.mapsgl.layers.spec.RasterLayerDescriptor.

RasterPaint

class RasterPaint : Paint

Paint for raster/image tiles (PNG/JPEG). Opacity and other layer-level options live on RasterLayerPaint; this block is the raster-specific slot.

RasterStyleSpec

data class RasterStyleSpec(val opacity: Double)

SampleLayerPaint

data class SampleLayerPaint(var opacity: Float = 1.0f, var sample: SamplePaint) : LayerPaint

Paint for com.xweather.mapsgl.layers.spec.SampleLayerDescriptor (encoded color field).

SamplePaint

class SamplePaint(var expression: SampleExpression = SampleExpression.NUMBER, var channel: List<ColorBand> = listOf(ColorBand.red), var quality: DataQuality = DataQuality.exact, var interpolation: InterpolationMode = InterpolationMode.BICUBIC, var smoothing: Float = 0.0f, var offset: Float = 0.0f, var drawRange: ClosedRange<Double>? = null, colorScale: ColorScaleOptions = ColorScaleOptions(), var multiband: Boolean = false, var meld: Boolean = true, var encodedScalarNormMax: Double? = null, var eventEmitter: LayerEventEmitter? = null) : Paint, ColorSampling

Paint for sampled encoded-grid values: interpolation, color mapping, draw range, and timeline blending (meld). Used by SampleLayerPaint, ContourLayerPaint, and ParticleLayerPaint.

SampleStyleSpec

data class SampleStyleSpec(val expressionOperation: Partial<ExpressionOperation>, val channel: SampleChannel, val quality: DataQuality, val interpolation: InterpolationMode, val smoothing: Int, val colorscale: Partial<ColorScaleSpec>, val opacity: Double, val multiband: Boolean, val offset: Int, val meld: Boolean, val drawRange: ValueRange)

SortDirection

enum SortDirection : Enum<SortDirection>

Direction a FillPaint.sortKey orders features (Apple SortDirection / Mapbox *-sort-key).

StrokePaint

data class StrokePaint(var color: StyleValue<Color> = StyleValue.Constant(Color.Red), var opacity: StyleValue<Double> = StyleValue.Constant(1.0), var thickness: StyleValue<Double> = StyleValue.Constant(1.0), var lineJoin: StyleValue<LineJoin> = StyleValue.Constant(LineJoin.ROUND), var lineCap: StyleValue<LineCap> = StyleValue.Constant(LineCap.ROUND), var miterLimit: StyleValue<Double> = StyleValue.Constant(2.0)) : Paint

Stroke style shared by line-capable paint types (for example LineLayerPaint, FillLayerPaint.stroke, and CircleLayerPaint.stroke).

StrokeStyleSpec

data class StrokeStyleSpec(val opacity: Double, val thickness: Int, val lineJoin: LineJoin)

StyleColor

sealed class StyleColor

Color value accepted in style serialization: Compose Color, hex, or rgba(...) string.

StyleValue

sealed class StyleValue<out T>

Paint or layout property value: either a constant literal or a Mapbox-style expression.

SymbolLayerPaint

data class SymbolLayerPaint(var opacity: Float = 1.0f, var fill: FillPaint? = null, var stroke: StrokePaint? = null, var icon: IconPaint = IconPaint(), var text: List<TextPaint> = emptyList(), var rank: SymbolRank? = null, var pitchWithMap: Boolean = true, var rotateWithMap: Boolean = true) : VectorLayerPaint

Paint for com.xweather.mapsgl.layers.spec.SymbolLayerDescriptor: icon, optional text list, fill/stroke, rank.

SymbolPlacementPaint

data class SymbolPlacementPaint(var allowOverlap: StyleValue<Boolean> = StyleValue.Constant(false), var anchor: StyleValue<Anchor> = StyleValue.Constant(Anchor.CENTER), var offset: StyleValue<AnchorOffset> = StyleValue.Constant(AnchorOffset()), var padding: StyleValue<Double> = StyleValue.Constant(0.0), var rotation: StyleValue<Double> = StyleValue.Constant(0.0), var rotateWithMap: Boolean = false, var pitchWithMap: Boolean = false)

Shared symbol placement options (Apple SymbolPlacementPaint). Used by IconPaint.placement and GridLayerPaint.symbol.

SymbolRank

data class SymbolRank(val property: String, val direction: SymbolRankDirection = SymbolRankDirection.ASC)

MapsGL JS symbol.rank: feature property used to order symbols before placement / draw.

SymbolRankDirection

enum SymbolRankDirection : Enum<SymbolRankDirection>

Sort direction for SymbolRank.property (JS symbol.rank.direction).

SymbolStyleSpec

data class SymbolStyleSpec(val size: Size, val offset: Point, val rotation: Double, val animated: Boolean, val shader: String, val uniforms: Map<String, Any>, val factor: Double, val pitchWithMap: Boolean, val rotateWithMap: Boolean, val billboard: Boolean, val atlas: TextureAtlas)

TextFormatOptions

data class TextFormatOptions(var fontScale: Double? = null, var textFont: List<String>? = null, var textColor: Color? = null)

Per-span formatting options for Mapbox format expressions built with Expression.Companion.format.

TextJustification

data class TextJustification(val rawValue: String)

Style-JSON string for text-justify (e.g. "center").

TextPaint

data class TextPaint(var allowOverlap: StyleValue<Boolean> = StyleValue.Constant(false), var value: StyleValue<String>, var size: StyleValue<Double>? = null, var font: StyleValue<List<String>>? = null, var weight: StyleValue<String>? = null, var color: StyleValue<Color> = StyleValue.Constant(Color.Black), var outlineColor: StyleValue<Color>? = null, var opacity: StyleValue<Double> = StyleValue.Constant(1.0), var align: StyleValue<TextJustification> = StyleValue.Constant(TextJustification.CENTER), var transform: StyleValue<TextTransform> = StyleValue.Constant(TextTransform.NONE), var anchor: StyleValue<Anchor> = StyleValue.Constant(Anchor.CENTER), var offset: StyleValue<AnchorOffset> = StyleValue.Constant(AnchorOffset(0.0, 0.0)), var padding: StyleValue<Double> = StyleValue.Constant(0.0), var rotation: StyleValue<Double> = StyleValue.Constant(0.0), var letterSpacing: StyleValue<Double>? = null, var lineHeight: StyleValue<Double>? = null, var maxWidth: StyleValue<Double>? = null) : Paint

Text styling for symbol layers (Mapbox text-* properties). Multiple TextPaint entries on SymbolLayerPaint.text become stacked labels.

TextStyleSpec

interface TextStyleSpec

TextTransform

data class TextTransform(val rawValue: String)

Style-JSON string for text-transform (e.g. "uppercase").

TextureAtlas

data class TextureAtlas(val columns: Int, val rows: Int, val interval: Int, val sdfMax: ValueRange?, val sdfSoft: ValueRange?)

TextureAtlasItem

data class TextureAtlasItem(val x: Int, val y: Int, val width: Int, val height: Int, val anchorX: Int, val anchorY: Int, val mask: Boolean)

TypedRange

open class TypedRange<T>(val start: Double, val endInclusive: Double) : ClosedRange<Double>

VectorLayerPaint

interface VectorLayerPaint : LayerPaint

Vector (fill/line/circle/symbol/heatmap) paint that can emit Mapbox StyleJSON via asStyleJSON.

Properties

SupportedSymbolAnchors

val SupportedSymbolAnchors: <Error class: unknown class>

TAG

const val TAG: String

Functions

colorScaleRangeForMagnitudeLookup

fun colorScaleRangeForMagnitudeLookup(expression: SampleExpression, range: ClosedRange<Double>): ClosedRange<Double>

Color LUT / sampleDataMin/sampleDataMax span for encoded layers. VECTOR wind speed is non-negative; u/v decoding uses the dataset range in the renderer.

colorStopBandsFromOptionsStops

fun colorStopBandsFromOptionsStops(stops: List<Any>): List<List<ColorStop>>?

If stops is multiband (listOf(band0, band1, …) each band a list of ColorStop), returns those bands. Otherwise null (flat single-band list).

colorStopsFromOptionsStops

fun colorStopsFromOptionsStops(stops: List<Any>): List<ColorStop>

ColorScaleOptions.stops is either a flat List of ColorStop (typical encoded layers) or, for multiband radar, a list of per-band stop lists. CPU ColorScale and bar legends use the first band (reflectivity / red), matching TileLayerRenderer multiband sampling.