mapsglmaps/com.xweather.mapsgl.sources.source.spec/GeoJSONSourceDescriptor

GeoJSONSourceDescriptor

data class GeoJSONSourceDescriptor(val id: String, var url: String? = null, var metadataUrl: String? = null, var minZoom: Float? = null, var maxZoom: Float? = null, var bounds: LatLonBounds? = null, var tileSize: TileSize? = null, var attribution: String? = null, var authenticator: XweatherAuthenticator? = null, var bundledAssetPath: String? = null) : SourceDescriptor

Configuration for a GeoJSON-backed source. At runtime, com.xweather.mapsgl.map.MapController.addSource creates a com.xweather.mapsgl.sources.GeoJSONSource; use com.xweather.mapsgl.map.MapController.getSource and cast to that type to set com.xweather.mapsgl.sources.GeoJSONSource.data or adjust com.xweather.mapsgl.sources.GeoJSONSource.url after registration.

Provide GeoJSON in one of four ways:

data — inline features assigned on the descriptor before com.xweather.mapsgl.map.MapController.addSource.
bundledAssetPath — path under the host app's src/main/assets/ (loaded on com.xweather.mapsgl.map.MapController.addSource).
Assign com.xweather.mapsgl.sources.GeoJSONSource.data after addSource (inline JSON via com.mapbox.geojson.FeatureCollection.fromJson, or an asset path via com.xweather.mapsgl.sources.GeoJSONSource.parseJsonOrAsset).
url — remote GeoJSON endpoint template.

Constructors

GeoJSONSourceDescriptor

constructor(id: String)

In-memory GeoJSON only — assign data before com.xweather.mapsgl.map.MapController.addSource, or com.xweather.mapsgl.sources.GeoJSONSource.data after it. Prefer this constructor over default-arg GeoJSONSourceDescriptor(id = …) when linking against a minified AAR.

constructor(id: String, bundledAssetPath: String)

Loads GeoJSON from bundledAssetPath under the host app's src/main/assets/ when the source is added. Example: GeoJSONSourceDescriptor("countries", "geojson/conus.geojson").

constructor(id: String, url: String? = null, metadataUrl: String? = null, minZoom: Float? = null, maxZoom: Float? = null, bounds: LatLonBounds? = null, tileSize: TileSize? = null, attribution: String? = null, authenticator: XweatherAuthenticator? = null, bundledAssetPath: String? = null)