StyleManagerInterface

interface StyleManagerInterface : ObservableInterface
Content copied to clipboard

Interface for managing style of the `map`.

Functions

addPersistentStyleCustomLayer
Link copied to clipboard
@NonNull
abstract fun addPersistentStyleCustomLayer(@NonNull layerId: String, @NonNull layerHost: CustomLayerHost, @Nullable layerPosition: LayerPosition): Expected<String, None>
Content copied to clipboard
Adds a new [style custom layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).
addPersistentStyleLayer
Link copied to clipboard
@NonNull
abstract fun addPersistentStyleLayer(@NonNull properties: Value, @Nullable layerPosition: LayerPosition): Expected<String, None>
Content copied to clipboard
Adds a new [style layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).
addStyleCustomGeometrySource
Link copied to clipboard
@NonNull
abstract fun addStyleCustomGeometrySource(@NonNull sourceId: String, @NonNull options: CustomGeometrySourceOptions): Expected<String, None>
Content copied to clipboard
Adds a custom geometry to be used in the style.
addStyleCustomLayer
Link copied to clipboard
@NonNull
abstract fun addStyleCustomLayer(@NonNull layerId: String, @NonNull layerHost: CustomLayerHost, @Nullable layerPosition: LayerPosition): Expected<String, None>
Content copied to clipboard
Adds a new [style custom layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).
addStyleImage
Link copied to clipboard
@NonNull
abstract fun addStyleImage(@NonNull imageId: String, scale: Float, @NonNull image: Image, sdf: Boolean, @NonNull stretchX: List<ImageStretches>, @NonNull stretchY: List<ImageStretches>, @Nullable content: ImageContent): Expected<String, None>
Content copied to clipboard
Adds an image to be used in the style.
addStyleLayer
Link copied to clipboard
@NonNull
abstract fun addStyleLayer(@NonNull properties: Value, @Nullable layerPosition: LayerPosition): Expected<String, None>
Content copied to clipboard
Adds a new [style layer](https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers).
addStyleModel
Link copied to clipboard
@NonNull
abstract fun addStyleModel(@NonNull modelId: String, @NonNull modelUri: String): Expected<String, None>
Content copied to clipboard
Adds a model to be used in the style.
addStyleSource
Link copied to clipboard
@NonNull
abstract fun addStyleSource(@NonNull sourceId: String, @NonNull properties: Value): Expected<String, None>
Content copied to clipboard
Adds a new [style source](https://docs.mapbox.com/mapbox-gl-js/style-spec/#sources).
getStyleAtmosphereProperty
Link copied to clipboard
@NonNull
abstract fun getStyleAtmosphereProperty(@NonNull property: String): StylePropertyValue
Content copied to clipboard
Gets the value of a style atmosphere property.
getStyleDefaultCamera
Link copied to clipboard
@NonNull
abstract fun getStyleDefaultCamera(): CameraOptions
Content copied to clipboard
Returns the map style's default camera, if any, or a default camera otherwise.
getStyleImage
Link copied to clipboard
@Nullable
abstract fun getStyleImage(@NonNull imageId: String): Image
Content copied to clipboard
Get an `image` from the style.
getStyleJSON
Link copied to clipboard
@NonNull
abstract fun getStyleJSON(): String
Content copied to clipboard
Get the JSON serialization string of the current style in use.
getStyleLayerProperties
Link copied to clipboard
@NonNull
abstract fun getStyleLayerProperties(@NonNull layerId: String): Expected<String, Value>
Content copied to clipboard
Gets style layer properties.
getStyleLayerProperty
Link copied to clipboard
@NonNull
abstract fun getStyleLayerProperty(@NonNull layerId: String, @NonNull property: String): StylePropertyValue
Content copied to clipboard
Gets the value of style layer property.
getStyleLayers
Link copied to clipboard
@NonNull
abstract fun getStyleLayers(): List<StyleObjectInfo>
Content copied to clipboard
Returns the existing style layers.
getStyleLightProperty
Link copied to clipboard
@NonNull
abstract fun getStyleLightProperty(@NonNull property: String): StylePropertyValue
Content copied to clipboard
Gets the value of a style light property.
@NonNull
abstract fun getStyleLightProperty(@NonNull id: String, @NonNull property: String): StylePropertyValue
Content copied to clipboard
getStyleLights
Link copied to clipboard
@NonNull
abstract fun getStyleLights(): List<StyleObjectInfo>
Content copied to clipboard
getStyleProjectionProperty
Link copied to clipboard
@NonNull
abstract fun getStyleProjectionProperty(@NonNull property: String): StylePropertyValue
Content copied to clipboard
Gets the value of a style projection property.
getStyleSourceProperties
Link copied to clipboard
@NonNull
abstract fun getStyleSourceProperties(@NonNull sourceId: String): Expected<String, Value>
Content copied to clipboard
Gets style source properties.
getStyleSourceProperty
Link copied to clipboard
@NonNull
abstract fun getStyleSourceProperty(@NonNull sourceId: String, @NonNull property: String): StylePropertyValue
Content copied to clipboard
Gets the value of style source property.
getStyleSources
Link copied to clipboard
@NonNull
abstract fun getStyleSources(): List<StyleObjectInfo>
Content copied to clipboard
Returns the existing style sources.
getStyleTerrainProperty
Link copied to clipboard
@NonNull
abstract fun getStyleTerrainProperty(@NonNull property: String): StylePropertyValue
Content copied to clipboard
Gets the value of a style terrain property.
getStyleTransition
Link copied to clipboard
@NonNull
abstract fun getStyleTransition(): TransitionOptions
Content copied to clipboard
Returns the map style's transition options.
getStyleURI
Link copied to clipboard
@NonNull
abstract fun getStyleURI(): String
Content copied to clipboard
Get the URI of the current style in use.
hasStyleImage
Link copied to clipboard
abstract fun hasStyleImage(@NonNull imageId: String): Boolean
Content copied to clipboard
Checks whether an image exists.
hasStyleModel
Link copied to clipboard
abstract fun hasStyleModel(@NonNull modelId: String): Boolean
Content copied to clipboard
Checks whether a model exists.
@NonNull
abstract fun invalidateStyleCustomGeometrySourceRegion(@NonNull sourceId: String, @NonNull bounds: CoordinateBounds): Expected<String, None>
Content copied to clipboard
Invalidate region for provided custom geometry source.
invalidateStyleCustomGeometrySourceTile
Link copied to clipboard
@NonNull
abstract fun invalidateStyleCustomGeometrySourceTile(@NonNull sourceId: String, @NonNull tileId: CanonicalTileID): Expected<String, None>
Content copied to clipboard
Invalidate tile for provided custom geometry source.
isStyleLayerPersistent
Link copied to clipboard
@NonNull
abstract fun isStyleLayerPersistent(@NonNull layerId: String): Expected<String, Boolean>
Content copied to clipboard
Checks if a style layer is persistent.
isStyleLoaded
Link copied to clipboard
abstract fun isStyleLoaded(): Boolean
Content copied to clipboard
Check if the style is completely loaded.
moveStyleLayer
Link copied to clipboard
@NonNull
abstract fun moveStyleLayer(@NonNull layerId: String, @Nullable layerPosition: LayerPosition): Expected<String, None>
Content copied to clipboard
Moves an existing style layer
removeStyleImage
Link copied to clipboard
@NonNull
abstract fun removeStyleImage(@NonNull imageId: String): Expected<String, None>
Content copied to clipboard
Removes an image from the style.
removeStyleLayer
Link copied to clipboard
@NonNull
abstract fun removeStyleLayer(@NonNull layerId: String): Expected<String, None>
Content copied to clipboard
Removes an existing style layer.
removeStyleModel
Link copied to clipboard
@NonNull
abstract fun removeStyleModel(@NonNull modelId: String): Expected<String, None>
Content copied to clipboard
Removes a model from the style.
removeStyleSource
Link copied to clipboard
@NonNull
abstract fun removeStyleSource(@NonNull sourceId: String): Expected<String, None>
Content copied to clipboard
Removes an existing style source.
setStyleAtmosphere
Link copied to clipboard
@NonNull
abstract fun setStyleAtmosphere(@NonNull properties: Value): Expected<String, None>
Content copied to clipboard
Sets the style global [atmosphere](https://docs.mapbox.com/mapbox-gl-js/style-spec/#fog) properties.
setStyleAtmosphereProperty
Link copied to clipboard
@NonNull
abstract fun setStyleAtmosphereProperty(@NonNull property: String, @NonNull value: Value): Expected<String, None>
Content copied to clipboard
Sets a value to the the style atmosphere property.
setStyleCustomGeometrySourceTileData
Link copied to clipboard
@NonNull
abstract fun setStyleCustomGeometrySourceTileData(@NonNull sourceId: String, @NonNull tileId: CanonicalTileID, @NonNull featureCollection: List<Feature>): Expected<String, None>
Content copied to clipboard
Set tile data of a custom geometry.
setStyleGeoJSONSourceData
Link copied to clipboard
@NonNull
@Deprecated
abstract fun setStyleGeoJSONSourceData(@NonNull sourceId: String, @NonNull data: GeoJSONSourceData): Expected<String, None>
Content copied to clipboard
@NonNull
abstract fun setStyleGeoJSONSourceData(@NonNull sourceId: String, @NonNull dataId: String, @NonNull data: GeoJSONSourceData): Expected<String, None>
Content copied to clipboard
setStyleJSON
Link copied to clipboard
abstract fun setStyleJSON(@NonNull json: String)
Content copied to clipboard
Load the style from a provided JSON string.
setStyleLayerProperties
Link copied to clipboard
@NonNull
abstract fun setStyleLayerProperties(@NonNull layerId: String, @NonNull properties: Value): Expected<String, None>
Content copied to clipboard
Sets style layer properties.
setStyleLayerProperty
Link copied to clipboard
@NonNull
abstract fun setStyleLayerProperty(@NonNull layerId: String, @NonNull property: String, @NonNull value: Value): Expected<String, None>
Content copied to clipboard
Sets a value to a style layer property.
setStyleLight
Link copied to clipboard
@NonNull
abstract fun setStyleLight(@NonNull properties: Value): Expected<String, None>
Content copied to clipboard
Sets the style global [light](https://docs.mapbox.com/mapbox-gl-js/style-spec/#light) properties.
setStyleLightProperty
Link copied to clipboard
@NonNull
abstract fun setStyleLightProperty(@NonNull property: String, @NonNull value: Value): Expected<String, None>
Content copied to clipboard
Sets a value to the the style light property.
@NonNull
abstract fun setStyleLightProperty(@NonNull id: String, @NonNull property: String, @NonNull value: Value): Expected<String, None>
Content copied to clipboard
setStyleLights
Link copied to clipboard
@NonNull
abstract fun setStyleLights(@NonNull lights: Value): Expected<String, None>
Content copied to clipboard
setStyleProjection
Link copied to clipboard
@NonNull
abstract fun setStyleProjection(@NonNull properties: Value): Expected<String, None>
Content copied to clipboard
Sets the map's [projection](https://docs.mapbox.com/mapbox-gl-js/style-spec/projection/).
setStyleProjectionProperty
Link copied to clipboard
@NonNull
abstract fun setStyleProjectionProperty(@NonNull property: String, @NonNull value: Value): Expected<String, None>
Content copied to clipboard
Sets a value to the the style projection property.
setStyleSourceProperties
Link copied to clipboard
@NonNull
abstract fun setStyleSourceProperties(@NonNull sourceId: String, @NonNull properties: Value): Expected<String, None>
Content copied to clipboard
Sets style source properties.
setStyleSourceProperty
Link copied to clipboard
@NonNull
abstract fun setStyleSourceProperty(@NonNull sourceId: String, @NonNull property: String, @NonNull value: Value): Expected<String, None>
Content copied to clipboard
Sets a value to a style source property.
setStyleTerrain
Link copied to clipboard
@NonNull
abstract fun setStyleTerrain(@NonNull properties: Value): Expected<String, None>
Content copied to clipboard
Sets the style global [terrain](https://docs.mapbox.com/mapbox-gl-js/style-spec/#terrain) properties.
setStyleTerrainProperty
Link copied to clipboard
@NonNull
abstract fun setStyleTerrainProperty(@NonNull property: String, @NonNull value: Value): Expected<String, None>
Content copied to clipboard
Sets a value to the the style terrain property.
setStyleTransition
Link copied to clipboard
abstract fun setStyleTransition(@NonNull transitionOptions: TransitionOptions)
Content copied to clipboard
Overrides the map style's transition options with user-provided options.
setStyleURI
Link copied to clipboard
abstract fun setStyleURI(@NonNull uri: String)
Content copied to clipboard
Load style from provided URI.
styleLayerExists
Link copied to clipboard
abstract fun styleLayerExists(@NonNull layerId: String): Boolean
Content copied to clipboard
Checks whether a given style layer exists.
styleSourceExists
Link copied to clipboard
abstract fun styleSourceExists(@NonNull sourceId: String): Boolean
Content copied to clipboard
Checks whether a given style source exists.
subscribe
Link copied to clipboard
abstract fun subscribe(@NonNull observer: Observer, @NonNull events: List<String>)
Content copied to clipboard
Subscribes an `observer` to a provided array of event types.
unsubscribe
Link copied to clipboard
abstract fun unsubscribe(@NonNull observer: Observer)
Content copied to clipboard
Unsubscribes an `observer` from all events.
abstract fun unsubscribe(@NonNull observer: Observer, @NonNull events: List<String>)
Content copied to clipboard
Unsubscribes an `observer` from a provided array of event types.
updateStyleImageSourceImage
Link copied to clipboard
@NonNull
abstract fun updateStyleImageSourceImage(@NonNull sourceId: String, @NonNull image: Image): Expected<String, None>
Content copied to clipboard
Updates the image of an [image style source](https://docs.mapbox.com/mapbox-gl-js/style-spec/#sources-image).

Inheritors

StyleInterface
Link copied to clipboard
CameraManagerInterface
Link copied to clipboard
StyleManager
Link copied to clipboard

Extensions

getLayer
Link copied to clipboard
fun StyleManagerInterface.getLayer(layerId: String): Layer?
Content copied to clipboard

Extension function to get a Layer provided by the Style Extension by layer id.

getLayerAs
Link copied to clipboard
inline fun <T : Layer> StyleManagerInterface.getLayerAs(layerId: String): T?
Content copied to clipboard

Tries to cast the Layer to T.

getSource
Link copied to clipboard
fun StyleManagerInterface.getSource(sourceId: String): Source?
Content copied to clipboard

Extension function to get a Source provided by the Style Extension by source id.

getSourceAs
Link copied to clipboard
inline fun <T : Source> StyleManagerInterface.getSourceAs(sourceId: String): T?
Content copied to clipboard

Tries to cast the Source to T.