Package-level declarations

Types

Link copied to clipboard
data class AccessToken(var accessToken: String, val expires: Date, val tokenType: String)

Cached access token plus expiry, parsed from the Xweather token response.

Link copied to clipboard

Accumulation layers MapsGL JS ships (MapsGL JS 1.8.5) which have no LayerCode on Android.

Link copied to clipboard
data class AirQualityHealthIndexDataset(var code: String = "air-quality_AQHI-Canada_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..20.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class AirQualityIndexAirNowDataset(var code: String = "air-quality_AQI-AirNow_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..500.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class AirQualityIndexCAIDataset(var code: String = "air-quality_AQI-CAI_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..500.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class AirQualityIndexCAQIDataset(var code: String = "air-quality_AQI-CAQI_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..200.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class AirQualityIndexChinaDataset(var code: String = "air-quality_AQI-China_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..500.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class AirQualityIndexEAQIDataset(var code: String = "air-quality_AQI-EAQI_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..150.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class AirQualityIndexIndiaDataset(var code: String = "air-quality_AQI-India_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..500.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class AirQualityIndexUBADAQIDataset(var code: String = "air-quality_AQI-UBA-DAQI_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..125.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class AirQualityIndexUKDAQIDataset(var code: String = "air-quality_AQI-UK-DAQI_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..10.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
interface Authenticator

Signs MapsGL / AMP HTTP requests with XweatherAccount credentials.

Link copied to clipboard

Thrown when XweatherAuthenticator cannot obtain a usable token.

Link copied to clipboard

Modified BaseEncodedConfiguration to support both Sample and Particle layers. It uses a generic L constrained to LayerDescriptor to handle both types.

Link copied to clipboard

Example of a Particle implementation

Link copied to clipboard
data class BoundingBox(val north: Int, val west: Int, val south: Int, val east: Int)
Link copied to clipboard
data class CarbonMonoxideDataset(var code: String = "air-quality_CO_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..1000.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class CloudCoverDataset(var code: String = "weather-surface_TCDC_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..100.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
Link copied to clipboard
data class ColorValue<T>(val value: T, val color: Color, val label: String? = null)
Link copied to clipboard

Weather product that expands to multiple WeatherLayerConfiguration layers (stacked fills, icons, labels).

Link copied to clipboard

Custom gridded layers that mirror non-generated JS SDK specs.

Link copied to clipboard
sealed class DataColorScale
Link copied to clipboard
Link copied to clipboard
data class DewPointDataset(var code: String = "weather-surface_DPT_2-HTGL", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = -84.44..32.22, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class EncodedDataGroup(var id: String, var datasets: List<EncodedDataset>)
Link copied to clipboard
interface EncodedDataset
Link copied to clipboard
data class FeelsLikeDataset(var code: String = "weather-surface_APTMP_2-HTGL", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = -62.22..54.44, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class HailSevereProbabilityDataset(var code: String = "hail-threats-archive-{region}_POSH_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..100.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null, var region: String) : EncodedDataset
Link copied to clipboard
data class HailSizeDataset(var code: String = "hail-threats-archive-{region}_MESH_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..101.6, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null, var region: String) : EncodedDataset
Link copied to clipboard
data class HumidityDataset(var code: String = "weather-surface_RH_2-HTGL", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..100.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class LightningDensityCloudtoGroundDataset(var code: String = "lightning-density-archive-{region}_LIGHTNING-STRIKES-CG_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..10.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null, var region: String) : EncodedDataset
Link copied to clipboard
data class LightningDensityIntraCloudDataset(var code: String = "lightning-density-archive-{region}_LIGHTNING-STRIKES-IC_0-EATM", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..10.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null, var region: String) : EncodedDataset
Link copied to clipboard

Source and layer descriptors for the PowerLayerCode products.

Link copied to clipboard

Weather sources and layers that are not in the generated files.

Link copied to clipboard
data class MeanSeaLevelPressureDataset(var code: String = "weather-surface_PRMSL_0-MSL", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 950.0..1060.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class NitrogenDioxideDataset(var code: String = "air-quality_NO2_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..100.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class NitrogenMonoxideDataset(var code: String = "air-quality_NO_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..100.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class OceanCurrentDataset(var code: String = "marine_{component}OGRD_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = -3.0864..3.0864, var noData: Double? = 0.0, var timeOffset: TimeIntervalSeconds? = null, var component: VectorComponent) : EncodedDataset
Link copied to clipboard

Time-series operation products, added with addOperationLayer.

Link copied to clipboard
data class OzoneDataset(var code: String = "air-quality_O3_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..300.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class ParticulateMatter10Dataset(var code: String = "air-quality_PM10_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..1000.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class ParticulateMatter25Dataset(var code: String = "air-quality_PM2P5_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..300.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard

The power layers MapsGL JS ships (MapsGL JS 1.8.1 / 1.8.5).

Link copied to clipboard

LayerCode configurations for the PowerLayerCode products, so they can be added with addWeatherLayer as in MapsGL JS. Each one wraps the ManualWeatherLayers descriptors, so the layer has one definition however it is added. Added by the 2026-10-06 additive regeneration: the generator now emits these codes.

Link copied to clipboard
data class PrecipitationRateDataset(var code: String = "weather-surface_PRATE_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..inToMMRate(5.0), var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class PrecipitationTypeDataset(var code: String = "weather-surface_PTYPE_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..255.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class RadarDbzArchiveDataset(var code: String = "radar-composite_REFC_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..87.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class RadarDbzDataset(var code: String = "precip_REFC_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..87.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class RadarDbzNowcastDataset(var code: String = "nowcast-composite_REFC_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..87.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class RadarPrecipitationRateArchiveDataset(var code: String = "radar-composite_PRATE_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..0.11696, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class RadarPrecipitationRateDataset(var code: String = "precip_PRATE_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..0.11696, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class RadarPrecipitationRateNowcastDataset(var code: String = "nowcast-composite_PRATE_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..0.11696, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class RadarPrecipitationTypeArchiveDataset(var code: String = "radar-composite_PTYPESMPL_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..255.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class RadarPrecipitationTypeDataset(var code: String = "precip_PTYPESMPL_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..255.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class RadarPrecipitationTypeNowcastDataset(var code: String = "nowcast-composite_PTYPESMPL_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..255.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard

Shorthand for image/raster products (satellite geocolor, visible, …) with RasterLayerDescriptor.maskLayerIds.

Link copied to clipboard
data class RoadRiskHydroplaneDataset(var code: String = "hydroplaneRisk_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..0.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class RoadRiskLowVisibilityFogDataset(var code: String = "roadRiskFog_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..0.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class RoadRiskLowVisibilitySnowDataset(var code: String = "roadRiskSnow_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..0.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class RoadRiskRolloverDataset(var code: String = "roadRiskRollover_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..0.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class RoadSummaryDataset(var code: String = "roadSeverity_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..0.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class RoadSurfaceDataset(var code: String = "roadCondition_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..0.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class RoadTemperatureDataset(var code: String = "roadTemperature_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = -62.22..54.44, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class RoadTemperatureFreezeDataset(var code: String = "roadTemperature_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = -62.22..54.44, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard

Shorthand for encoded-grid sample products (temperature, radar, …).

Link copied to clipboard
data class SeaSurfaceTemperatureDataset(var code: String = "marine_WTMP_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = -90.0..70.0, var noData: Double? = 0.0, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class SnowDepthDataset(var code: String = "forecast_SNOD_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..7.9248, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class SnowRateDataset(var code: String = "weather-surface_PRATE_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..inToMMRate(3.0), var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset

Precipitation rate scaled for the derived snow / sleet / ice products.

Link copied to clipboard
data class SulfurDioxideDataset(var code: String = "air-quality_SO2_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..100.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class SurgeDataset(var code: String = "marine_SURGE_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..5.0, var noData: Double? = 0.0, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class SwellDirectionDataset(var code: String = "marine_SWDIR_{level}-SEQ", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..359.0, var noData: Double? = 0.0, var timeOffset: TimeIntervalSeconds? = null, var level: MaritimeSurgeLevel) : EncodedDataset
Link copied to clipboard
data class SwellHeightDataset(var code: String = "marine_SWELL_{level}-SEQ", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..15.0, var noData: Double? = 0.0, var timeOffset: TimeIntervalSeconds? = null, var level: MaritimeSurgeLevel) : EncodedDataset
Link copied to clipboard
data class SwellPeriodDataset(var code: String = "marine_SWPER_{level}-SEQ", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..24.0, var noData: Double? = 0.0, var timeOffset: TimeIntervalSeconds? = null, var level: MaritimeSurgeLevel) : EncodedDataset
Link copied to clipboard
data class TemperatureDataset(var code: String = "weather-surface_TMP_2-HTGL", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = -62.22..54.44, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class TideDataset(var code: String = "marine_TIDE_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = -12.192..12.192, var noData: Double? = 0.0, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class UVIndexDataset(var code: String = "conditions_UVI_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..12.0, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard

Shorthand for vector-backed circle layers (e.g. point observations).

Link copied to clipboard
Link copied to clipboard
data class VisibilityDataset(var code: String = "weather-surface_VIS_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..16093.4, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class WaveDirectionDataset(var code: String = "marine_DIRPW_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..359.0, var noData: Double? = 0.0, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class WaveHeightDataset(var code: String = "marine_HTSGW_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..15.0, var noData: Double? = 0.0, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard
data class WavePeriodDataset(var code: String = "marine_PERPW_0-SFC", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..24.0, var noData: Double? = 0.0, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard

Marker for all weather configuration entries exposed by WeatherService.

Link copied to clipboard
Link copied to clipboard

Typed weather-layer configuration pairing one data source with one render layer.

Link copied to clipboard
data class WeatherLayerMetadata(val id: String, val title: String, val description: String, val type: String, val imageUrl: URL, val animatable: Boolean, val categories: List<String>, val dataRange: String, val dataCoverage: List<String>, val updateInterval: String)
Link copied to clipboard

Stroke thickness defaults for built-in weather vector line layers (parity with @xweather/mapsgl JS registry).

Link copied to clipboard
class WeatherService(val account: XweatherAccount)

High-level factory/service for MapsGL weather products and source descriptors.

Link copied to clipboard
Link copied to clipboard
data class WindDataset(var code: String = "weather-surface_{component}GRD_10-HTGL", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = -53.64..53.64, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null, var component: VectorComponent) : EncodedDataset
Link copied to clipboard
data class WindGustDataset(var code: String = "weather-surface_GUST_10-HTGL", var band: ColorBand? = null, var dataRange: ClosedRange<Double> = 0.0..53.64, var noData: Double? = null, var timeOffset: TimeIntervalSeconds? = null) : EncodedDataset
Link copied to clipboard

Request authenticator used by WeatherService and source descriptors.

Properties

Link copied to clipboard

iOS WeatherService.LayerCode.mapTimeExempt / ignoresMapTimeFilter parity.

Link copied to clipboard
Link copied to clipboard
const val TAG: String

Functions

Link copied to clipboard

Adds one of the accumulation layers.

Link copied to clipboard

Adds one of the time-series operation layers.

Link copied to clipboard

Adds one of the power layers.

Link copied to clipboard

Applies stroke thickness to a single vector line weather configuration (parity with JS addWeatherLayer(..., { paint: { stroke: { thickness } } })).

Link copied to clipboard

Recurses into composite configs and sets line stroke thickness on every child that is a line layer.