mapsglmaps/com.xweather.mapsgl.sources/TileSource

TileSource

abstract class TileSource<DataType : TileData> : DataSource

TileSource.kt

Author

by Jason Suto on 12/12/23.

Inheritors

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
var bounds: LatLonBounds?
Link copied to clipboard
Link copied to clipboard
open override val eventDispatcher: EventDispatcher
Link copied to clipboard
abstract val id: String

The unique identifier for the data source.

Link copied to clipboard
open val isEncoded: Boolean = false
Link copied to clipboard
Link copied to clipboard
open override 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.

Link copied to clipboard
Link copied to clipboard
abstract val kind: DataSourceKind

type in MapsGL JS

Link copied to clipboard
var maxZoom: Float
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
var minZoom: Float
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
abstract val tileCache: TileCache<DataType>
Link copied to clipboard
open var tileManager: TileRequestManager<DataType>
Link copied to clipboard
val TileSource<DataType>.tiles: TileCache<DataType>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
var tileURL: String?
Link copied to clipboard
abstract var timeRange: ClosedRange<Date>?
Link copied to clipboard

Functions

Link copied to clipboard
abstract fun addConsumer(consumer: DataSourceConsumer)

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

Link copied to clipboard
fun addToAnimationQueue(inputString: String)
Link copied to clipboard
fun adjustDateBySeconds(dateString: String, offsetSeconds: Long): String?

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

Link copied to clipboard
open fun contains(coord: TileCoord): Boolean
Link copied to clipboard
fun <DataType : TileData> TileSource<DataType>.contains(coord: TileCoord): Boolean
Link copied to clipboard
open suspend fun fetchMetadata(startDate: Date?, endDate: Date?)

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

Link copied to clipboard
open fun getMetadataURL(): URL?
Link copied to clipboard
open fun getTileData(coord: TileCoord): Any?
Link copied to clipboard
fun <DataType : TileData> TileSource<DataType>.init(id: String, authenticator: Authenticator<MediaSession.Token>?)
Link copied to clipboard
fun intervalToURLTime(intervalTime: String): String

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

Link copied to clipboard
fun makeTileURL(coord: TileCoord, variables: Map<String, Any>?): URL
Link copied to clipboard
fun onLoadFailed()
Link copied to clipboard
fun onTileError(tile: TileType, error: Error)
Link copied to clipboard
suspend fun parseTile(tile: TileType, data: ByteArray, headers: <Error class: unknown class><Any, Any>?): Bitmap
Link copied to clipboard
inline fun <EventType : Event> EventSource.publisher(eventType: Class<EventType>): Flow<EventType>
Link copied to clipboard
abstract fun removeConsumer(layerId: String)

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

Link copied to clipboard
fun removeFromAnimationQueue(inputString: String)
Link copied to clipboard
abstract suspend fun requestTiles(coord: TileCoord, options: TileRequestOptions, currentDate: String, fromAnimation: Boolean, intervals: List<String>? = null): Any
Link copied to clipboard
fun shouldRequestTile(tile: TileType, reload: Boolean): Boolean
Link copied to clipboard
Link copied to clipboard
inline suspend fun <EventType : Event> EventSource.subscribe(eventType: Class<EventType>, crossinline handler: (EventType) -> Unit)
Link copied to clipboard