mapsglmaps/com.xweather.mapsgl.sources/DataSource

DataSource

interface DataSource : EventSource

Inheritors

TileSource

Properties

eventDispatcher

abstract val eventDispatcher: EventDispatcher

abstract val id: String

The unique identifier for the data source.

isReady

abstract var isReady: Boolean

Indicates whether the data source is ready to be used by consuming layers, which may be false if data has not been loaded from a remote source yet or the data has not been fully prepared for rendering.

kind

abstract val kind: DataSourceKind

type in MapsGL JS

timeRange

abstract var timeRange: ClosedRange<Date>?

type

val DataSource.type: DataSourceKind

Functions

addConsumer

abstract fun addConsumer(consumer: DataSourceConsumer)

Adds a map layer as a consumer of the data source.

publisher

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

removeConsumer

abstract fun removeConsumer(layerId: String)

Removes a map layer as a consumer of the data source.

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

trigger

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