mapsglmaps/com.xweather.mapsgl.sources/GeoJSONSource

GeoJSONSource

class GeoJSONSource(val id: String) : TileSource<VectorData>

Runtime GeoJSON data source for map layers that consume geographic features (points, lines, polygons).

Instances are created when you call com.xweather.mapsgl.map.MapController.addSource with a com.xweather.mapsgl.sources.source.spec.GeoJSONSourceDescriptor. Retrieve the same instance with com.xweather.mapsgl.map.MapController.getSource and cast to GeoJSONSource to update a remote url, assign in-memory data, or refresh after changes.

Remote URL: set url to a template string. makeDataURL expands {startDate} and {endDate} from timeRange (ISO-style via com.xweather.mapsgl.utils.replaceVars), URL-encodes values, and—when authenticator is an XweatherAuthenticator—merges {accessKey}, {clientId}, {clientSecret} and the documentation segment [CLIENT_ID]_[CLIENT_SECRET] like tile sources. If the descriptor omitted com.xweather.mapsgl.sources.source.spec.GeoJSONSourceDescriptor.authenticator, com.xweather.mapsgl.map.MapController.addSource attaches com.xweather.mapsgl.weather.WeatherService.authenticator automatically.

Inline data: set data to a Mapbox FeatureCollection (for example from FeatureCollection.fromJson(...)). You can use this together with or instead of a remote url, depending on your pipeline.

Events: onLoadStart, onLoadComplete, and related signals fire around load lifecycle (see each property).

Constructors

GeoJSONSource

constructor(id: String)

Properties

_shouldTriggerLoadCompleteEvent

var _shouldTriggerLoadCompleteEvent: Boolean

animTileList

val animTileList: MutableList<String>

attribution

var attribution: String?

Optional attribution string for map credits.

authenticator

var authenticator: Authenticator?

Optional authenticator for remote requests. When this is an XweatherAuthenticator, credential placeholders in url are expanded in makeDataURL.

bounds

var bounds: LatLonBounds?

data

var data: FeatureCollection?

Parsed GeoJSON features served directly by the app, or null when using only url. Assigning a new value notifies onDataChange and pushes geometry to the map style when this source is bound (see pushGeoJsonToMapStyle).

datasets

open var datasets: List<DatasetType>

eventDispatcher

open override val eventDispatcher: EventDispatcher

open override val id: String

Stable identifier matching the descriptor and any layers that reference this source.

isEncoded

open val isEncoded: Boolean

isLoading

var isLoading: Boolean

isReady

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.

isReady

val TileSource<DataType>.isReady: Boolean

kind

open override val 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

metadataURL

var metadataURL: String?

minZoom

var minZoom: Float

minZoom

val TileSource<DataType>.minZoom: Float

needsMetadata

val TileSource<DataType>.needsMetadata: Boolean

onDataChange

val onDataChange: Signal<Unit>

Dispatched when data or derived features change.

onLoadComplete

val onLoadComplete: Signal<Unit>

Dispatched when a load operation finishes successfully.

onLoadStart

val onLoadStart: Signal<Unit>

Dispatched when a load operation begins.

onMetadataError

val onMetadataError: Signal<Unit>

Dispatched when metadata loading fails (reserved for future metadata support).

onMetadataLoad

val onMetadataLoad: Signal<Unit>

Dispatched when metadata has been parsed (reserved for future metadata support).

onMetadataLoadStart

val onMetadataLoadStart: Signal<Unit>

Dispatched when metadata fetch starts (reserved for future metadata support).

tileCache

open override var tileCache: TileCache<DataType>

tileManager

open var tileManager: TileRequestManager<VectorData>

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>?

Active time window merged into URL variables as startDate and endDate when building a request URL.

type

val DataSource.type: DataSourceKind

url

var url: String?

Remote GeoJSON endpoint template, or null if the source is driven only by data. Placeholders follow com.xweather.mapsgl.utils.replaceVars (e.g. {startDate}, {endDate}).

validTimes

var validTimes: List<Date>?

Optional list of valid observation times for time-enabled GeoJSON products (product-specific).

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

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 override fun getMetadataURL(): URL?

Metadata is not implemented for this source type; calling this method throws kotlin.NotImplementedError.

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

invalidate

fun invalidate()

Requests clients and the map stack to drop cached geometry for this source after url or data changes. Full cache invalidation is still being wired; call this whenever you mutate URL or feature data.

makeDataURL

fun makeDataURL(variables: Map<String, Any> = emptyMap()): URL?

Builds a resolved HTTP(S) URL from url and the given variables, merged with timeRange bounds and XweatherAuthenticator.appendTileCredentialVariables when applicable. Values are URL-encoded.

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

open override fun removeConsumer(layerId: String)

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

removeFromAnimationQueue

fun removeFromAnimationQueue(inputString: String)

requestTiles

open suspend override fun requestTiles(coord: TileCoord, options: TileRequestOptions, currentDate: String, fromAnimation: Boolean, intervals: List<String>?): 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)

GeoJSONSource

See also

Constructors

Properties

Functions