mapsglmaps/com.xweather.mapsgl.data.series/TimeSeriesDataProvider

TimeSeriesDataProvider

abstract class TimeSeriesDataProvider<TileLayer>(val layer: TileLayer) : EventDispatcher

A helper class that performs remote data loading requests for data required by a TimeSeriesAnimator instance. An instance of this class must provide a loader function which is responsible for performing the data request and preparing it for the requested time intervals from the series.

Inheritors

TiledTimeSeriesDataProvider

Constructors

TimeSeriesDataProvider

constructor(layer: TileLayer)

Properties

var _isDirty: Boolean

val eventFlow: MutableSharedFlow<Event>

val hasLoaded: Boolean

interleaveRequests

var interleaveRequests: Boolean

Whether to interleave (stagger) requests for multiple time intervals.

val isDirty: Boolean

val isLoading: Boolean

val isReady: Boolean

var jIsLoading: Boolean

var jPendingCount: Int

open val layer: TileLayer

maxIntervalsPerRequest

var maxIntervalsPerRequest: Int

The maximum number of time intervals to request data for in a single request. Requests will be split into multiple requests if the number of intervals needed exceeds this value.

open val TAG: String

Functions

dataStateForIntervals

abstract fun dataStateForIntervals(intervals: MutableList<TimeInterval>): Map<String, Boolean>

Returns a map of time intervals to a boolean value indicating whether the data for the interval is available as determined by the data provider.

open fun dispose()

open fun invalidate()

Resets the state of the data provider, marking it as dirty and clearing any loaded data or existing requests.

abstract suspend fun loadData(intervals: MutableList<TimeInterval> = mutableListOf())

Loads the data for the specified time intervals.

fun off(event: String, listener: (Any) -> Unit)

fun on(event: String, listener: (Any) -> Unit)

fun onLoadStart(intervals: Array<Date>)

Called when the data provider is about to start loading data for a set of time intervals.

fun setNeedsUpdate()

Marks the data provider as needing an update, which will trigger a new data request on the next update cycle.

fun trigger(event: Event)

fun trigger(event: String)

fun trigger(event: Event, valueMap: Map<String, Tile<TileData>>)

fun trigger(event: TimeSeriesEvent, dates: Array<Date>)

fun trigger(event: Event, intervalArray: MutableList<TimeInterval>, placeHolder: Int)

Renamed from trigger in js since type-erasure caused signature clash

fun triggerAny(event: String, data: Any)

fun triggerDates(event: String, dates: Map<String, Date>)

triggerDatesArray

fun triggerDatesArray(event: String, dates: Array<Date>)

triggerDatesList

fun triggerDatesList(event: String, dates: List<Date>)