mapsglmaps/com.xweather.mapsgl.weather

Package-level declarations

Types

data class AccessToken(var accessToken: String, val expires: Date, val tokenType: String)

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

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

AirQualityIndexAirNowDataset

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

AirQualityIndexCAIDataset

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

AirQualityIndexCAQIDataset

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

AirQualityIndexChinaDataset

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

AirQualityIndexEAQIDataset

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

AirQualityIndexIndiaDataset

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

AirQualityIndexUBADAQIDataset

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

AirQualityIndexUKDAQIDataset

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

Authenticator

interface Authenticator

Signs MapsGL / AMP HTTP requests with XweatherAccount credentials.

AuthenticatorError

enum AuthenticatorError : Enum<AuthenticatorError>

AuthenticatorException

class AuthenticatorException(val error: AuthenticatorError) : Throwable

Thrown when XweatherAuthenticator cannot obtain a usable token.

BaseEncodedConfiguration

abstract class BaseEncodedConfiguration<L : LayerDescriptor<*>> : WeatherLayerConfiguration<EncodedSourceDescriptor, L>

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

BaseVectorConfiguration

abstract class BaseVectorConfiguration<S : SourceDescriptor, L : LayerDescriptor<*>> : WeatherLayerConfiguration<S, L>

Example of a Particle implementation

BoundingBox

data class BoundingBox(val north: Int, val west: Int, val south: Int, val east: Int)

CarbonMonoxideDataset

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

CloudCoverDataset

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

ColorScales

object ColorScales

ColorValue

data class ColorValue<T>(val value: T, val color: Color, val label: String? = null)

CompositeWeatherLayerConfiguration

interface CompositeWeatherLayerConfiguration : WeatherConfiguration

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

CustomGriddedLayers

object CustomGriddedLayers

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

DataColorScale

sealed class DataColorScale

DatasetGroups

object DatasetGroups

DewPointDataset

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

EncodedDataGroup

data class EncodedDataGroup(var id: String, var datasets: List<EncodedDataset>)

EncodedDataset

interface EncodedDataset

FeelsLikeDataset

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

HailSevereProbabilityDataset

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

HailSizeDataset

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

HumidityDataset

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

LayerCode

enum LayerCode : Enum<LayerCode>

Weather product ids passed to com.xweather.mapsgl.map.MapController.addWeatherLayer.

LegendCode

enum LegendCode : Enum<LegendCode>

LightningDensityCloudtoGroundDataset

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

LightningDensityIntraCloudDataset

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

MaritimeSurgeLevel

enum MaritimeSurgeLevel : Enum<MaritimeSurgeLevel>

MeanSeaLevelPressureDataset

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

NitrogenDioxideDataset

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

NitrogenMonoxideDataset

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

OceanCurrentDataset

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

OzoneDataset

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

ParticulateMatter10Dataset

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

ParticulateMatter25Dataset

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

PrecipitationRateDataset

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

PrecipitationTypeDataset

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

RadarDbzArchiveDataset

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

RadarDbzDataset

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

RadarDbzNowcastDataset

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

RadarPrecipitationRateArchiveDataset

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

RadarPrecipitationRateDataset

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

RadarPrecipitationRateNowcastDataset

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

RadarPrecipitationTypeArchiveDataset

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

RadarPrecipitationTypeDataset

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

RadarPrecipitationTypeNowcastDataset

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

RasterConfiguration

typealias RasterConfiguration = WeatherLayerConfiguration<ImageSourceDescriptor, RasterLayerDescriptor>

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

RoadRiskHydroplaneDataset

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

RoadRiskLowVisibilityFogDataset

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

RoadRiskLowVisibilitySnowDataset

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

RoadRiskRolloverDataset

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

RoadSummaryDataset

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

RoadSurfaceDataset

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

RoadTemperatureDataset

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

RoadTemperatureFreezeDataset

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

SampleConfiguration

typealias SampleConfiguration = WeatherLayerConfiguration<EncodedSourceDescriptor, SampleLayerDescriptor>

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

SeaSurfaceTemperatureDataset

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

SnowDepthDataset

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

SulfurDioxideDataset

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

SurgeDataset

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

SwellDirectionDataset

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

SwellHeightDataset

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

SwellPeriodDataset

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

TemperatureDataset

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

TideDataset

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

UVIndexDataset

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

VCircleConfiguration

typealias VCircleConfiguration = WeatherLayerConfiguration<VectorSourceDescriptor, CircleLayerDescriptor>

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

VectorComponent

enum VectorComponent : Enum<VectorComponent>

VisibilityDataset

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

WaveDirectionDataset

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

WaveHeightDataset

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

WavePeriodDataset

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

WeatherConfiguration

interface WeatherConfiguration

Marker for all weather configuration entries exposed by WeatherService.

WeatherConfigurations

class WeatherConfigurations

WeatherLayerConfiguration

interface WeatherLayerConfiguration<S : SourceDescriptor, L : LayerDescriptor<*>> : WeatherConfiguration

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

WeatherLayerMetadata

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)

WeatherLayerStrokeDefaults

object WeatherLayerStrokeDefaults

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

WeatherService

class WeatherService(val account: XweatherAccount)

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

WeatherSource

object WeatherSource

WindDataset

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

WindGustDataset

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

XweatherAuthenticator

class XweatherAuthenticator(account: XweatherAccount, server: URL) : Authenticator, EventSource

Request authenticator used by WeatherService and source descriptors.

Properties

ignoresMapTimeFilter

val LayerCode.ignoresMapTimeFilter: Boolean

iOS WeatherService.LayerCode.mapTimeExempt / ignoresMapTimeFilter parity.

regionBoundingBox

val regionBoundingBox: Map<String, BoundingBox>

TAG

const val TAG: String

Functions

setLineStrokeThickness

fun WeatherConfiguration.setLineStrokeThickness(thickness: Double)

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

setLineStrokeThicknessOnAllLineLayers

fun WeatherConfiguration.setLineStrokeThicknessOnAllLineLayers(thickness: Double)

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