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.

isReady

val TileSource<DataType>.isReady: Boolean

isStale

var isStale: Boolean

kind

open override var kind: DataSourceKind

type in MapsGL JS

maxZoom

var maxZoom: Float

maxZoom

val TileSource<DataType>.maxZoom: Float

metadata

lateinit var metadata: SourceMetadata<MetadataType>

metaDataNeeded

var metaDataNeeded: Int

metadataObserver

val metadataObserver: VariableObserver

metadataURL

var metadataURL: String?

minZoom

var minZoom: Float

minZoom

val TileSource<DataType>.minZoom: Float

needsMetadata

val TileSource<DataType>.needsMetadata: Boolean

passedObserver

lateinit var passedObserver: Observer<String>

pendingRequestedTiles

var pendingRequestedTiles: MutableList<String>

requests

val requests: <Error class: unknown class>

shouldTriggerLoadCompleteEvent

val shouldTriggerLoadCompleteEvent: Boolean = false

threadSafeIntervalMap

val threadSafeIntervalMap: ConcurrentHashMap<String, List<String>?>

threadSafeTileMap

val threadSafeTileMap: ConcurrentHashMap<String, Tile<DataType>>

tileCache

open override var tileCache: TileCache<DataType>

tileManager

open override var tileManager: TileRequestManager<DataType>

tiles

val TileSource<DataType>.tiles: TileCache<DataType>

tileSize

var tileSize: TileSize

tileSize

val TileSource<DataType>.tileSize: TileSize

tileURL

var tileURL: String?

timeRange

open override var timeRange: ClosedRange<Date>?

type

val type: String

type

val DataSource.type: DataSourceKind

Functions

addConsumer

open override fun addConsumer(consumer: DataSourceConsumer)

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

addToAnimationQueue

fun addToAnimationQueue(inputString: String)

adjustDateBySeconds

fun adjustDateBySeconds(dateString: String, offsetSeconds: Long): String?

Used by prepareTileRequest() to increment or decremnet the time and reformate it for sources with time offets

cleanup

fun cleanup()

contains

open fun contains(coord: TileCoord): Boolean

contains

fun <DataType : TileData> TileSource<DataType>.contains(coord: TileCoord): Boolean

dataRange

fun dataRange(channel: SampleChannel): ClosedRange<Double>

Returns the data range for the specified channel.

extractValidTimes

fun extractValidTimes(jsonString: String): List<String>

fetchMetadata

open suspend override fun fetchMetadata(startDate: Date?, endDate: Date?): Result<Unit>

Returns the metadata for the source, which can be loaded from a remote source.

getDataRange

fun getDataRange(band: ColorBand): ClosedRange<Double>

fun getDataRange(band: Int): ClosedRange<Double>

getImageColorFormat

fun getImageColorFormat(imageBytes: ByteArray): Bitmap.Config?

Test function to detect color format of image

getMetadata

fun getMetadata(band: ColorBand): DatasetType?

fun getMetadata(band: Int): DatasetType?

getMetadataURL

open override fun getMetadataURL(): URL?

getTileData

open fun getTileData(coord: TileCoord): Any?

init

fun <DataType : TileData> TileSource<DataType>.init(id: String, authenticator: Authenticator<MediaSession.Token>?)

intervalToURLTime

fun intervalToURLTime(intervalTime: String): String

convert from \"2025-04-22T03:49:31Z\" to 20250422030000

makeTileURL

fun makeTileURL(coord: TileCoord, variables: Map<String, Any>?): URL

metadata

fun metadata(forChannel: SampleChannel): EncodedDataset?

Returns the metadata for the specified channel, if available.

onLoadFailed

fun onLoadFailed()

onTileError

fun onTileError(tile: TileType, error: Error)

onTileLoaded

suspend fun onTileLoaded(tile: TileType, intervals: List<String>?, mode: Int)

Backfills the edges of the tile with its neighbors' data and vice versa. This mirrors the logic found in the JavaScript SDK for seamless tile stitching.

parseTile

suspend fun parseTile(tile: TileType, data: ByteArray, headers: <Error class: unknown class><Any, Any>?): Bitmap

prepareTileRequest

open fun prepareTileRequest(request: URLRequest, timeString: String?)

fun prepareTileRequest(request: URLRequest, timeString: String?, intervals: List<String>?)

publisher

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

removeConsumer

open override fun removeConsumer(layerId: String)

Removes a consumer

removeFromAnimationQueue

fun removeFromAnimationQueue(inputString: String)

requestTiles

open suspend override fun requestTiles(coord: TileCoord, options: TileRequestOptions, currentDate: String, fromAnimation: Boolean, intervals: List<String>?): Any

setObserver

fun setObserver(observer: Observer<String>, layerID: String)

shouldRequestTile

fun shouldRequestTile(tile: TileType, reload: Boolean): Boolean

shouldRequestTile

fun <DataType : TileData> TileSource<DataType>.shouldRequestTile(tile: TileType, reload: Boolean): Boolean

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

trigger

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