mapsglmaps/com.xweather.mapsgl.weather/WeatherService

WeatherService

class WeatherService(val account: XweatherAccount)

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

WeatherService centralizes:

account-aware authentication (authenticator) for MapsGL/AMP requests,
sprite/style bootstrapping via loadStyles,
optional product metadata loading via loadLayerMetadata,
construction of source descriptors for raster, encoded, vector, AMP vector, and GeoJSON endpoints,
and convenient static product builders in the companion object (for example Temperatures, Radar, RoadMotorway).

Typical flow:

Create service with XweatherAccount.
Call loadStyles once the map object is available.
Build weather layer configurations (for example through companion product functions).
Register resulting sources/layers with MapController.

See also

WeatherLayerConfiguration

WeatherConfigurations

LayerCodes

Constructors

constructor(account: XweatherAccount)

Types

object Companion

Properties

val account: XweatherAccount

Account credentials used to sign and build weather API requests.

val authenticator: XweatherAuthenticator

Shared request authenticator used by descriptor factories that require MapsGL auth.

var isStyleLoaded: Boolean

true when loadStyles completes with no sprite generation/download failures.

val style: MapStyle

Sprite/style loader used by loadStyles.

Functions

loadLayerMetadata

suspend fun loadLayerMetadata(): Result<List<WeatherLayerMetadata>>

Fetches user-facing weather product metadata from layerMetadataURLPath.

suspend fun loadStyles(map: ImageRegisteringMap, dpr: Float = 1.0f)

Loads SDK sprite sheets and registers generated fallback assets used by weather symbol layers.

makeAmpVectorSourceDescriptor

fun makeAmpVectorSourceDescriptor(code: String): VectorSourceDescriptor

Creates an AMP vector source descriptor for a weather product code using default id format wx::<code>.

fun makeAmpVectorSourceDescriptor(id: String, code: String): VectorSourceDescriptor

Creates an AMP vector tile source descriptor.

makeEncodedSourceDescriptor

fun makeEncodedSourceDescriptor(group: EncodedDataGroup): EncodedSourceDescriptor

Creates an encoded source descriptor from a grouped dataset definition.

fun makeEncodedSourceDescriptor(id: String, datasets: List<EncodedDataset>): EncodedSourceDescriptor

Creates a MapsGL encoded source descriptor for one or more encoded datasets.

makeGeoJSONSourceDescriptor

fun makeGeoJSONSourceDescriptor(id: String, route: String, params: Map<String, Any> = emptyMap()): GeoJSONSourceDescriptor

Creates a GeoJSON source descriptor for an Xweather Data API route.

makeRasterSourceDescriptor

fun makeRasterSourceDescriptor(code: String): ImageSourceDescriptor

Creates a raster source descriptor for a weather product code using default id format wx::raster.<code>.

fun makeRasterSourceDescriptor(id: String, code: String): ImageSourceDescriptor

Creates a raster image source descriptor for tile-based weather imagery.

makeVectorSourceDescriptor

fun makeVectorSourceDescriptor(code: String): VectorSourceDescriptor

Creates a vector source descriptor for a weather product code using default id format wx::<code>.

fun makeVectorSourceDescriptor(id: String, code: String): VectorSourceDescriptor

Creates a MapsGL vector tile source descriptor.