mapsglmaps/com.xweather.mapsgl.sources/TileSource

TileSource

abstract class TileSource<DataType : TileData> : DataSource

Base DataSource for tiled products: URL templates, zoom range, metadata, and a TileRequestManager.

Subtypes fetch raster PNGs, MVT bytes, or encoded grids. Layers use the shared tile cache and valid-time metadata to request Tile instances for the current viewport and timeline.

Parameters

DataType

Parsed tile payload (raster bitmap, encoded buffer, decoded features, …).

Inheritors

Constructors

TileSource

constructor()

Properties

_shouldTriggerLoadCompleteEvent

var _shouldTriggerLoadCompleteEvent: Boolean

animTileList

val animTileList: MutableList<String>

bounds

var bounds: LatLonBounds?

datasets

open var datasets: List<DatasetType>

eventDispatcher

open override val eventDispatcher: EventDispatcher

abstract val id: String

Same id as the registered style source / descriptor.

isEncoded

open val isEncoded: Boolean = false

isLoading

var isLoading: Boolean

isReady

open override var isReady: Boolean

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

isReady

val TileSource<DataType>.isReady: Boolean

kind

abstract val kind: DataSourceKind

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

maxZoom

var maxZoom: Float

maxZoom

val TileSource<DataType>.maxZoom: Float

metadata

lateinit var metadata: SourceMetadata<MetadataType>

metaDataNeeded

var metaDataNeeded: Int

metadataURL

var metadataURL: String?

minZoom

var minZoom: Float

minZoom

val TileSource<DataType>.minZoom: Float

needsMetadata

val TileSource<DataType>.needsMetadata: Boolean

ownerMapSessionId

var ownerMapSessionId: Long

com.xweather.mapsgl.map.MapController.mapSessionId that owns in-flight / ready tile bookkeeping.

tileCache

abstract val tileCache: TileCache<DataType>

tileManager

open 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

abstract var timeRange: ClosedRange<Date>?

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

type

val DataSource.type: DataSourceKind

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

Functions

addConsumer

abstract fun addConsumer(consumer: DataSourceConsumer)

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

contains

open fun contains(coord: TileCoord): Boolean

contains

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

fetchMetadata

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

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

getMetadataURL

open fun getMetadataURL(): URL?

getTileData

open fun getTileData(coord: TileCoord): Any?

init

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

intervalToIsoPathTime

fun intervalToIsoPathTime(intervalTime: String): String

Plain ISO-8601 for URL path {time} segments (encoded tile GET). Cache keys and POST validTimes still use bracketed ["…"] strings.

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

onLoadFailed

fun onLoadFailed()

onTileError

fun onTileError(tile: TileType, error: Error)

parseTile

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

publisher

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

removeConsumer

abstract fun removeConsumer(layerId: String)

Unregister a layer previously added with addConsumer.

removeFromAnimationQueue

fun removeFromAnimationQueue(inputString: String)

requestTiles

abstract suspend fun requestTiles(coord: TileCoord, options: TileRequestOptions, currentDate: String, fromAnimation: Boolean, intervals: List<String>? = null, trackDownloadProgress: Boolean = true): Any

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)