Mapbox Style Manager

open fun addGeoJSONSourceFeatures(sourceId: String, dataId: String, features: List<Feature>): Expected<String, None>

Add additional features to a GeoJSON style source.

addImage

fun addImage(imageId: String, bitmap: Bitmap): Expected<String, None>

fun addImage(imageId: String, image: Image): Expected<String, None>

fun addImage(imageId: String, bitmap: Bitmap, sdf: Boolean): Expected<String, None>

addPersistentStyleCustomLayer

fun addImage(imageId: String, image: Image, sdf: Boolean): Expected<String, None>

Adds an image to be used in the style. This API can also be used for updating an image. If the image id was already added, it gets replaced by the new image.

open fun addPersistentStyleCustomLayer(layerId: String, layerHost: CustomLayerHost, layerPosition: LayerPosition?): Expected<String, None>

Adds a new style custom layer.

addPersistentStyleLayer

addStyleCustomGeometrySource

open fun addPersistentStyleLayer(properties: Value, layerPosition: LayerPosition?): Expected<String, None>

Adds a new style layer.

open fun addStyleCustomGeometrySource(sourceId: String, options: CustomGeometrySourceOptions): Expected<String, None>

Adds a custom geometry to be used in the style. To add the data, implement the CustomGeometrySourceOptions.Builder.fetchTile@CallSuper @MainThread open function callback in the options and call setStyleCustomGeometrySourceTileData

addStyleCustomLayer

addStyleCustomRasterSource

open fun addStyleCustomLayer(layerId: String, layerHost: CustomLayerHost, layerPosition: LayerPosition?): Expected<String, None>

Adds a new style custom layer.

open fun addStyleCustomRasterSource(sourceId: String, options: CustomRasterSourceOptions): Expected<String, None>

Note! This is an experimental feature. It can be changed or removed in future versions.

addStyleImage

open fun addStyleImage(imageId: String, scale: Float, image: Image, sdf: Boolean, stretchX: List<ImageStretches>, stretchY: List<ImageStretches>, content: ImageContent?): Expected<String, None>

Adds an image to be used in the style. This API can also be used for updating an image. If the image for a given imageId was already added, it gets replaced by the new image.

addStyleImportFromJSON

open fun addStyleImportFromJSON(importId: String, json: String, config: HashMap<String, Value>?, importPosition: ImportPosition?): Expected<String, None>

Adds new import to current style, loaded from a JSON string.

addStyleImportFromURI

open fun addStyleImportFromURI(importId: String, uri: String, config: HashMap<String, Value>?, importPosition: ImportPosition?): Expected<String, None>

Adds new import to current style, loaded from an URI.

addStyleLayer

open fun addStyleLayer(parameters: Value, position: LayerPosition?): Expected<String, None>

Adds a new style layer.

open fun addStyleModel(modelId: String, modelUri: String): Expected<String, None>

Adds a model to be used in the style. This API can also be used for updating a model. If the model for a given modelId was already added, it gets replaced by the new model.

addStyleSource

getStyleAtmosphereProperty

open fun addStyleSource(sourceId: String, properties: Value): Expected<String, None>

Adds a new style source. Note: When adding a geojson source, this method does not synchronously parse the GeoJSON data. The events API shall be used to make sure the provided GeoJSON data is valid. In case the GeoJSON is valid, a MapLoaded event will be propagated. In case of errors, a MapLoadingError event will be propagated instead.

open fun getFeaturesets(): List<FeaturesetDescriptor>

Returns the available featuresets in the currently loaded style.

open fun getStyleAtmosphereProperty(property: String): StylePropertyValue

Gets the value of a style atmosphere property.

open fun getStyleGlyphURL(): String

Get the glyph URL of the current style in use.

getStyleImage

getStyleImportConfigProperties

open fun getStyleImage(imageId: String): Image?

Get an image from the style.

getStyleImportConfigProperty

open fun getStyleImportConfigProperties(importId: String): Expected<String, HashMap<String, StylePropertyValue>>

Gets style import config.

open fun getStyleImportConfigProperty(importId: String, config: String): Expected<String, StylePropertyValue>

Gets the value of style import config.

getStyleImports

open fun getStyleImports(): List<StyleObjectInfo>

Returns the existing style imports.

getStyleImportSchema

open fun getStyleImportSchema(importId: String): Expected<String, Value>

Gets style import schema.

getStyleLayerProperties

open fun getStyleLayerProperties(layerId: String): Expected<String, Value>

Gets style layer properties.

getStyleLayerProperty

open fun getStyleLayerProperty(layerId: String, property: String): StylePropertyValue

Gets the value of style layer property.

getStyleLightProperty

open fun getStyleLightProperty(id: String, property: String): StylePropertyValue

Gets the value of the style light property.

getStyleLights

getStyleProjectionProperty

open fun getStyleLights(): MutableList<StyleObjectInfo>

Gets added lights to the style.

open fun getStyleProjectionProperty(property: String): StylePropertyValue

Gets the value of a style projection property.

fun getStyleRainProperty(property: String): StylePropertyValue

Gets the value of a style rain property.

fun getStyleSnowProperty(property: String): StylePropertyValue

Gets the value of a style snow property.

getStyleSourceProperties

open fun getStyleSourceProperties(sourceId: String): Expected<String, Value>

Gets style source properties.

getStyleSourceProperty

open fun getStyleSourceProperty(sourceId: String, property: String): StylePropertyValue

Gets the value of style source property.

getStyleTerrainProperty

open fun getStyleTerrainProperty(property: String): StylePropertyValue

Gets the value of a style terrain property.

getStyleTransition

open fun getStyleTransition(): TransitionOptions

Returns the map style's transition options. By default, the style parser will attempt to read the style default transition options, if any, fallback-ing to an immediate transition otherwise. Transition options can be overridden via setStyleTransition, but the options are reset once a new style has been loaded.

hasStyleImage

invalidateStyleCustomGeometrySourceRegion

open fun hasStyleImage(imageId: String): Boolean

Checks whether an image exists.

open fun hasStyleModel(modelId: String): Boolean

Checks whether a model exists.

invalidateStyleCustomGeometrySourceTile

open fun invalidateStyleCustomGeometrySourceRegion(sourceId: String, coordinateBounds: CoordinateBounds): Expected<String, None>

Invalidate region for provided custom geometry source.

open fun invalidateStyleCustomGeometrySourceTile(sourceId: String, tileId: CanonicalTileID): Expected<String, None>

Invalidate tile for provided custom geometry source.

isStyleLayerPersistent

open fun isStyleLayerPersistent(layerId: String): Expected<String, Boolean>

Checks if a style layer is persistent.

isStyleLoaded

open fun isStyleLoaded(): Boolean

Check if the style is completely loaded.

moveStyleImport

open fun moveStyleImport(importId: String, importPosition: ImportPosition?): Expected<String, None>

Moves import to position before another import, specified with beforeId. Order of imported styles corresponds to order of their layers.

moveStyleLayer

removeGeoJSONSourceFeatures

open fun moveStyleLayer(layerId: String, layerPosition: LayerPosition?): Expected<String, None>

Moves an existing style layer

open fun removeGeoJSONSourceFeatures(sourceId: String, dataId: String, featureIds: List<String>): Expected<String, None>

Remove features from a GeoJSON style source.

removeStyleImage

open fun removeStyleImage(imageId: String): Expected<String, None>

Removes an image from the style.

removeStyleImport

open fun removeStyleImport(importId: String): Expected<String, None>

Removes an existing style import.

removeStyleLayer

open fun removeStyleLayer(layerId: String): Expected<String, None>

Removes an existing style layer.

open fun removeStyleModel(modelId: String): Expected<String, None>

Removes a model from the style.

removeStyleSource

removeStyleSourceUnchecked

open fun removeStyleSource(sourceId: String): Expected<String, None>

Removes an existing style source.

@RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

open fun removeStyleSourceUnchecked(sourceId: String): Expected<String, None>

Removes an existing style source without checking if it's being used by any other component.

setStyleAtmosphere

setStyleAtmosphereProperty

open fun setStyleAtmosphere(properties: Value): Expected<String, None>

Sets the style global atmosphere properties.

setStyleCustomGeometrySourceTileData

open fun setStyleAtmosphereProperty(property: String, value: Value): Expected<String, None>

Sets a value to the the style atmosphere property.

setStyleCustomRasterSourceTileData

open fun setStyleCustomGeometrySourceTileData(sourceId: String, tileId: CanonicalTileID, featureCollection: MutableList<Feature>): Expected<String, None>

Set tile data of a custom geometry.

setStyleGeoJSONSourceData

open fun setStyleCustomRasterSourceTileData(sourceId: String, tiles: List<CustomRasterSourceTileData>): Expected<String, None>

Note! This is an experimental feature. It can be changed or removed in future versions.

setStyleImportConfigProperties

open fun setStyleGeoJSONSourceData(sourceId: String, dataId: String, data: GeoJSONSourceData): Expected<String, None>

Set geojson source data. Call may take significant time for parsing and marshalling depending on the data size.

open fun setStyleGlyphURL(url: String)

Load the style glyphs from a provided URL.

setStyleImportConfigProperty

open fun setStyleImportConfigProperties(importId: String, configs: HashMap<String, Value>): Expected<String, None>

Sets style import config. This method can be used to perform batch update for a style import configurations.

open fun setStyleImportConfigProperty(importId: String, config: String, value: Value): Expected<String, None>

Sets a value to a style import config.

setStyleLayerProperties

open fun setStyleLayerProperties(layerId: String, properties: Value): Expected<String, None>

Sets style layer properties. This method can be used to perform batch update for a style layer properties. The structure of a provided properties value must conform to a format for a corresponding layer type. Modification of a layer id and/or a layer type (https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/#type) is not allowed.

setStyleLayerProperty

open fun setStyleLayerProperty(layerId: String, property: String, value: Value): Expected<String, None>

Sets a value to a style layer property.

setStyleLightProperty

open fun setStyleLightProperty(id: String, property: String, value: Value): Expected<String, None>

Sets a value to the light property.

setStyleLights

open fun setStyleLights(lights: Value): Expected<String, None>

Sets lights to the style.

setStyleProjection

setStyleProjectionProperty

open fun setStyleProjection(properties: Value): Expected<String, None>

Sets the map's projection. If called with NULL, the map will reset to Mercator.

open fun setStyleProjectionProperty(property: String, value: Value): Expected<String, None>

Sets a value to the the style projection property.

fun setStyleRain(properties: Value): Expected<String, None>

Experimental. Sets the style global rain properties.

fun setStyleRainProperty(property: String, value: Value): Expected<String, None>

Experimental. Sets the style global rain property.

open fun setStyleSnow(properties: Value): Expected<String, None>

Experimental. Sets the style global snow properties.

open fun setStyleSnowProperty(property: String, value: Value): Expected<String, None>

Experimental. Sets the style global snow property.

setStyleSourceProperties

open fun setStyleSourceProperties(sourceId: String, properties: Value): Expected<String, None>

Sets style source properties.

setStyleSourceProperty

open fun setStyleSourceProperty(sourceId: String, property: String, value: Value): Expected<String, None>

Sets a value to a style source property. Note: When setting the "data" property of a geojson source, this method does not synchronously parse the GeoJSON data. The events API shall be used to make sure the provided GeoJSON data is valid. In case the GeoJSON is valid, a MapLoaded event will be propagated. In case of errors, a MapLoadingError event will be propagated instead.

setStyleTerrain

open fun setStyleTerrain(properties: Value): Expected<String, None>

Sets the style global terrain properties.

setStyleTerrainProperty

open fun setStyleTerrainProperty(property: String, value: Value): Expected<String, None>

Sets a value to the the style terrain property.

setStyleTransition

open fun setStyleTransition(transitionOptions: TransitionOptions)

Overrides the map style's transition options with user-provided options.

styleLayerExists

open fun styleLayerExists(layerId: String): Boolean

Checks whether a given style layer exists.

styleSourceExists

updateGeoJSONSourceFeatures

open fun styleSourceExists(sourceId: String): Boolean

Checks whether a given style source exists.

updateStyleImageSourceImage

open fun updateGeoJSONSourceFeatures(sourceId: String, dataId: String, features: List<Feature>): Expected<String, None>

Update existing features in a GeoJSON style source.

updateStyleImportWithJSON

open fun updateStyleImageSourceImage(sourceId: String, image: Image): Expected<String, None>

Updates the image of an image style source.

open fun updateStyleImportWithJSON(importId: String, json: String, config: HashMap<String, Value>?): Expected<String, None>

Updates an existing import in the style. The function replaces the content of the import, with the content loaded from the provided data value. The configuration values of the import are merged with the configuration provided in the update.

updateStyleImportWithURI

open fun updateStyleImportWithURI(importId: String, uri: String, config: HashMap<String, Value>?): Expected<String, None>

Updates an existing import in the style. The function replaces the content of the import, with the content loaded from the provided URI. The configuration values of the import are merged with the configuration provided in the update.

Properties

mapLoadingErrorDelegate

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

val mapLoadingErrorDelegate: MapLoadingErrorDelegate

For internal usage.

pixelRatio

val pixelRatio: Float

Current pixel ratio.

styleDefaultCamera

@get:CallSuper

@get:MainThread

open val styleDefaultCamera: CameraOptions

Returns the map style's default camera, if any, or a default camera otherwise. The map style's default camera is defined as follows:

styleJSON

@get:CallSuper

@get:MainThread

open val styleJSON: String

Get the JSON serialization string of the current style in use.

styleLayers

@get:CallSuper

@get:MainThread

open val styleLayers: List<StyleObjectInfo>

Returns the existing style layers.

styleManager

@get:RestrictTo(value = [RestrictTo.Scope.LIBRARY_GROUP_PREFIX])

val styleManager: StyleManager

Native style manager instance.

styleSlots

@get:CallSuper

@get:MainThread

open val styleSlots: List<String>

Returns the ordered slot identifiers of current style and its imports.

styleSources

@get:CallSuper

@get:MainThread

open val styleSources: List<StyleObjectInfo>

Returns the existing style sources.

styleURI

@get:CallSuper

@get:MainThread

open val styleURI: String

Get the URI of the current style in use.

Inheritors

MapboxMap

Style

Extensions

addImage

fun MapboxStyleManager.addImage(image: StyleContract.StyleImageExtension)

Extension function to add an image provided by the Style Extension to the Style.

addImage9Patch

fun MapboxStyleManager.addImage9Patch(image: StyleContract.StyleImageExtension)

Extension function to add 9-patch image provided by the Style Extension to the Style.

@JvmOverloads

fun MapboxStyleManager.addImage9Patch(imageId: String, bitmap: Bitmap, scale: Float = pixelRatio, sdf: Boolean = false): Expected<String, None>

Adds an 9-patch image to be used in the style. X-stretches, Y-stretches and padding will be calculated from Bitmap.getNinePatchChunk.

addLayer

fun MapboxStyleManager.addLayer(layer: StyleContract.StyleLayerExtension)

Extension function to add a Layer provided by the Style Extension to the Style.

addLayerAbove

fun MapboxStyleManager.addLayerAbove(layer: StyleContract.StyleLayerExtension, above: String?)

Extension function to add a Layer provided by the Style Extension to the Style.

addLayerAt

fun MapboxStyleManager.addLayerAt(layer: StyleContract.StyleLayerExtension, index: Int?)

Extension function to add a Layer provided by the Style Extension to the Style.

addLayerBelow

fun MapboxStyleManager.addLayerBelow(layer: StyleContract.StyleLayerExtension, below: String?)

Extension function to add a Layer provided by the Style Extension to the Style.

addModel

fun MapboxStyleManager.addModel(model: StyleContract.StyleModelExtension)

Extension function to add a model provided by the Style Extension to the Style.

addPersistentLayer

@JvmOverloads

fun MapboxStyleManager.addPersistentLayer(layer: Layer, position: LayerPosition? = null)

Add layer to the style persistently.

addSource

fun MapboxStyleManager.addSource(source: StyleContract.StyleSourceExtension)

Extension function to add a Source provided by the Style Extension to the Style.

getAtmosphere

fun MapboxStyleManager.getAtmosphere(): Atmosphere

Extension function to get the atmosphere provided by the Style Extension.

getLayer

fun MapboxStyleManager.getLayer(layerId: String): Layer?

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

getLayerAs

inline fun <T : Layer> MapboxStyleManager.getLayerAs(layerId: String): T?

Tries to cast the Layer to T.

getLight

fun MapboxStyleManager.getLight(lightId: String): Light?

Extension function to get 3D Light that has been applied to the style.

getProjection

fun MapboxStyleManager.getProjection(): Projection?

Extension function to get the projection provided by the Style Extension.

getRain

fun MapboxStyleManager.getRain(): Rain

Extension function to get the Rain provided by the Style Extension.

getSnow

fun MapboxStyleManager.getSnow(): Snow

Extension function to get the Snow provided by the Style Extension.

getSource

fun MapboxStyleManager.getSource(sourceId: String): Source?

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

getSourceAs

inline fun <T : Source> MapboxStyleManager.getSourceAs(sourceId: String): T?

Tries to cast the Source to T.

getTerrain

fun MapboxStyleManager.getTerrain(sourceId: String): Terrain

Extension function to get the terrain provided by the Style Extension.

localizeLabels

@JvmOverloads

fun MapboxStyleManager.localizeLabels(locale: Locale, layerIds: List<String>? = null)

Extension function to localize style labels

removeAtmosphere

fun MapboxStyleManager.removeAtmosphere()

Removes atmosphere from style if it was set.

removeRain

fun MapboxStyleManager.removeRain()

Removes rain from style if it was set.

removeSnow

fun MapboxStyleManager.removeSnow()

Removes snow from style if it was set.

removeTerrain

fun MapboxStyleManager.removeTerrain()

Removes terrain from style if it was set.

setAtmosphere

fun MapboxStyleManager.setAtmosphere(atmosphere: StyleContract.StyleAtmosphereExtension)

Extension function to set the Atmosphere provided by the Style Extension to the Style.

setLight

fun MapboxStyleManager.setLight(ambientLight: AmbientLight, directionalLight: DirectionalLight)

Extension function to add dynamic light to the Style. dynamic light is built from AmbientLight and DirectionalLight.

fun MapboxStyleManager.setLight(flatLight: FlatLight)

Extension function to add the FlatLight to the Style.

setLights

fun MapboxStyleManager.setLights(lights: List<Light>)

Extension function to add list of lights.

setProjection

fun MapboxStyleManager.setProjection(projection: Projection)

Extension function to set the Projection provided by the Style Extension to the Style.

setRain

fun MapboxStyleManager.setRain(rain: StyleContract.StyleRainExtension)

Extension function to set the Rain provided by the Style Extension to the Style.

setSnow