mapsglmaps/com.xweather.mapsgl.style

Package-level declarations

Types

Anchor

data class Anchor(val rawValue: String)

AnchorOffset

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

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

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

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: ColorScaleSpec)

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)

ColorScaleSpec

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

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

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)) : Paint

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: holds a JSON-serializable tree (usually a List with an operator in the first element, or a nested structure) compatible with Mapbox’s 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

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) : Paint

FillStyleSpec

data class FillStyleSpec(val opacity: Double)

GridLayerPaint

data class GridLayerPaint(var opacity: Float = 1.0f, var fill: FillPaint? = FillPaint( color = StyleValue.Expression( Expression.rgb( Expression.toNumber(Expression.get("shaderR")), Expression.toNumber(Expression.get("shaderG")), Expression.toNumber(Expression.get("shaderB")), ), ), ), var stroke: StrokePaint? = null, var icon: IconPaint = IconPaint(), var text: List<TextPaint> = emptyList(), var grid: GridPaint = GridPaint(spacing = 20.0), var sample: SamplePaint? = null) : VectorLayerPaint

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

HeatmapPaint

data class HeatmapPaint(var color: StyleValue<Color> = StyleValue.Expression( Expression.interpolate( listOf("heatmap-density"), listOf( 0.0 to "rgba(0, 0, 0, 0)", 0.2 to "rgba(0, 0, 255, 0.2)", 0.45 to "rgba(0, 255, 0, 0.5)", 0.85 to "rgba(255, 255, 0, 1)", 1.0 to "rgba(255, 0, 0, 1)" ) ) ), var intensity: StyleValue<Double> = StyleValue.Constant(2.0), var radius: StyleValue<Double> = StyleValue.Constant(20.0), var weight: StyleValue<Double> = StyleValue.Constant(2.0)) : Paint

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 intervalMs: Double)

Wind barb sprite atlas (parity with JS icon.atlas: ordered ids and speed step in m/s per index).

IconPaint

data class IconPaint(var allowOverlap: StyleValue<Boolean> = StyleValue.Constant(false), var image: StyleValue<String>? = null, var size: StyleValue<Double>? = null, var iconSize: IconSize? = null, var atlas: IconAtlas? = null, 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: Double = 0.0, var rotationUsesDataDirection: Boolean = false) : Paint

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

LayerPaint

interface LayerPaint

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

PaintStyleSpec

interface PaintStyleSpec

ParticleDensity

enum ParticleDensity : Enum<ParticleDensity>

ParticleKind

enum ParticleKind : Enum<ParticleKind>

ParticleLayerPaint

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

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

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

RasterPaint

class RasterPaint : Paint

RasterStyleSpec

data class RasterStyleSpec(val opacity: Double)

SampleLayerPaint

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

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

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)

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(2.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

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()) : VectorLayerPaint

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)

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

TextStyleSpec

interface TextStyleSpec

TextTransform

data class TextTransform(val rawValue: String)

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

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.

getClosestInterval

fun getClosestInterval(value: Double, int: Double): Double

lerp

fun lerp(start: Double, stop: Double, fraction: Double): Double

makeJSONObject

fun makeJSONObject(value: Any?): Any?

roundedDownToMultiple

fun Double.roundedDownToMultiple(multiple: Double): Double

roundedUpToMultiple

fun Double.roundedUpToMultiple(multiple: Double): Double

toDoubleRange

fun ClosedRange<Float>?.toDoubleRange(): ClosedRange<Double>?

toRGBAString

fun Color.toRGBAString(): String