mapbox-maps-android/com.mapbox.maps/MapboxStyleManager

MapboxStyleManager

open class MapboxStyleManager

Wrapper class for StyleManager allowing to expose style related methods for MapboxMap.

Functions

addGeoJSONSourceFeatures

@AnyThread

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

Add additional features to a GeoJSON style source.

addPersistentStyleCustomLayer

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

Adds a new style custom layer.

addPersistentStyleLayer

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

Adds a new style layer.

addStyleCustomGeometrySource

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.fetchTileFunction callback in the options and call setStyleCustomGeometrySourceTileData

addStyleCustomLayer

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

Adds a new style custom layer.

addStyleCustomRasterSource

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

fun addStyleImage(imageId: String, scale: Float, image: Image, sdf: Boolean, stretchX: MutableList<ImageStretches>, stretchY: MutableList<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.

addStyleLayer

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

Adds a new style layer.

addStyleSource

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.

getStyleAtmosphereProperty

fun getStyleAtmosphereProperty(property: String): StylePropertyValue

Gets the value of a style atmosphere property.

getStyleImage

fun getStyleImage(imageId: String): Image?

Get an image from the style.

getStyleImportConfigProperties

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

Gets style import config.

getStyleImportConfigProperty

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

Gets the value of style import config.

getStyleImports

fun getStyleImports(): List<StyleObjectInfo>

Returns the existing style imports.

getStyleImportSchema

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

Gets style import schema.

getStyleLayerProperties

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

Gets style layer properties.

getStyleLayerProperty

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

Gets the value of style layer property.

getStyleLayers

fun getStyleLayers(): List<StyleObjectInfo>

Returns the existing style layers.

getStyleProjectionProperty

fun getStyleProjectionProperty(property: String): StylePropertyValue

Gets the value of a style projection property.

getStyleSourceProperties

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

Gets style source properties.

getStyleSourceProperty

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

Gets the value of style source property.

getStyleSources

fun getStyleSources(): List<StyleObjectInfo>

Returns the existing style sources.

getStyleTerrainProperty

fun getStyleTerrainProperty(property: String): StylePropertyValue

Gets the value of a style terrain property.

getStyleTransition

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

fun hasStyleImage(imageId: String): Boolean

Checks whether an image exists.

invalidateStyleCustomGeometrySourceRegion

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

Invalidate region for provided custom geometry source.

invalidateStyleCustomGeometrySourceTile

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

Invalidate tile for provided custom geometry source.

invalidateStyleCustomRasterSourceRegion

fun invalidateStyleCustomRasterSourceRegion(sourceId: String, bounds: CoordinateBounds): Expected<String, None>

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

invalidateStyleCustomRasterSourceTile

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

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

isStyleLayerPersistent

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

Checks if a style layer is persistent.

isStyleLoaded

fun isStyleLoaded(): Boolean

Check if the style is completely loaded.

moveStyleLayer

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

Moves an existing style layer

removeGeoJSONSourceFeatures

@AnyThread

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

Remove features from a GeoJSON style source.

removeStyleImage

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

Removes an image from the style.

removeStyleImport

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

Removes an existing style import.

removeStyleLayer

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

Removes an existing style layer.

removeStyleSource

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

Removes an existing style source.

setStyleAtmosphere

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

Sets the style global atmosphere properties.

setStyleAtmosphereProperty

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

Sets a value to the the style atmosphere property.

setStyleCustomGeometrySourceTileData

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

Set tile data of a custom geometry.

setStyleCustomRasterSourceTileData

fun setStyleCustomRasterSourceTileData(sourceId: String, tileId: CanonicalTileID, image: Image?): Expected<String, None>

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

setStyleImportConfigProperties

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.

setStyleImportConfigProperty

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

Sets a value to a style import config.

setStyleLayerProperties

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

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

Sets a value to a style layer property.

setStyleProjection

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

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

setStyleProjectionProperty

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

Sets a value to the the style projection property.

setStyleSourceProperties

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

Sets style source properties.

setStyleSourceProperty

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