mapsglmaps/com.xweather.mapsgl.sources/DataSource

DataSource

interface DataSource : EventSource

Runtime data provider backing one or more com.xweather.mapsgl.layers.tile.MapLayer instances.

Created from a com.xweather.mapsgl.sources.source.spec.SourceDescriptor via com.xweather.mapsgl.map.MapController.addSource. Subtypes include raster, encoded grid, vector, and GeoJSON sources.

Inheritors

Properties

eventDispatcher

abstract val eventDispatcher: EventDispatcher

abstract val id: String

Same id as the registered style source / descriptor.

abstract var isReady: Boolean

true when metadata (and any bootstrap work) is available so layers can request tiles safely.

abstract val kind: DataSourceKind

High-level source family (raster, encoded, vector, …).

abstract var timeRange: ClosedRange<Date>?

Optional interval filter for time-series products; drives tile requests with timeline state.

val DataSource.type: DataSourceKind

Alias for DataSource.kind (matches JS naming type).

Functions

abstract fun addConsumer(consumer: DataSourceConsumer)

Register a layer that should receive updates when this source loads or changes.

inline fun <EventType : Event> EventSource.publisher(eventType: Class<EventType>): Flow<EventType>

abstract fun removeConsumer(layerId: String)

Unregister a layer previously added with addConsumer.

inline suspend fun <EventType : Event> EventSource.subscribe(eventType: Class<EventType>, crossinline handler: (EventType) -> Unit)

fun <EventType : Event> EventSource.trigger(event: EventType)