mapbox-maps-android/com.mapbox.maps/Style

Style

class Style : MapboxStyleManager

The general class to interact with Styles in the Modular Mapbox Maps SDK for Android. It exposes the entry point for all methods related to the Style. You cannot instantiate Style object directly, rather, you must obtain one from the getStyle(onStyleLoaded) method on MapboxMap.

Note: Similar to a View object, a Style should only be read and modified from the main thread.

Types

object Companion

A convenience object to access the style ID strings of the professionally-designed map styles made by Mapbox.

fun interface OnStyleLoaded

Callback to be invoked when a style has finished loading.

Functions

addGeoJSONSourceFeatures

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

Add additional features to a GeoJSON style source.

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>

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

addPersistentStyleCustomLayer

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

Adds a new style custom layer.

addPersistentStyleLayer

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

Adds a new style layer.

addStyleCustomGeometrySource

open override 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.fetchTile@MainThread override function callback in the options and call setStyleCustomGeometrySourceTileData

addStyleCustomLayer

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

Adds a new style custom layer.

addStyleCustomRasterSource

@MapboxExperimental

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

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

open override 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 id was already added, it gets replaced by the new image.

addStyleImportFromJSON

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

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

Adds a new style layer.

@MapboxExperimental

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

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

Adds a new style source.

getStyleAtmosphereProperty

open override fun getStyleAtmosphereProperty(property: String): StylePropertyValue

Gets the value of a style atmosphere property.

open override fun getStyleImage(imageId: String): Image?

Get an image from the style.

getStyleImportConfigProperties

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

Gets style import config.

getStyleImportConfigProperty

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

Gets the value of style import config.

getStyleImports

open override fun getStyleImports(): List<StyleObjectInfo>

Returns the existing style imports.

getStyleImportSchema

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

Gets style import schema.

getStyleLayerProperties

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

Gets style layer properties.

getStyleLayerProperty

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

Gets the value of style layer property.

getStyleLightProperty

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

Gets the value of the style light property.

open override fun getStyleLights(): MutableList<StyleObjectInfo>

Gets added lights to the style.

getStyleProjectionProperty

open override fun getStyleProjectionProperty(property: String): StylePropertyValue

Gets the value of a style projection property.

getStyleSourceProperties

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

Gets style source parameters. In order to convert returned value to a json string please take a look at Value.toJson.

getStyleSourceProperty

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

Gets the value of style source property.

getStyleTerrainProperty

open override fun getStyleTerrainProperty(property: String): StylePropertyValue

Get the value of a style terrain property.

getStyleTransition

open override 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, fallbacking to an immediate transition otherwise. Transition options can be overridden via setStyleTransition, but the options are reset once a new style has been loaded.

open override fun hasStyleImage(imageId: String): Boolean

Checks whether an image exists.

@MapboxExperimental

open override fun hasStyleModel(modelId: String): Boolean

Checks whether a model exists.

invalidateStyleCustomGeometrySourceRegion

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

Invalidate region for provided custom geometry source.

invalidateStyleCustomGeometrySourceTile

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

Invalidate tile for provided custom geometry source.

invalidateStyleCustomRasterSourceRegion

@MapboxExperimental

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

@MapboxExperimental

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

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

Checks if a style layer is persistent.

open override fun isStyleLoaded(): Boolean

Check if the style is completely loaded.

fun isValid(): Boolean

Whether the Style instance is valid.

moveStyleImport

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

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

Moves an existing style layer.

removeGeoJSONSourceFeatures

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

Remove features from a GeoJSON style source.

removeStyleImage

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

Removes an image from the style.

removeStyleImport

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

Removes an existing style import.

removeStyleLayer

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

Removes an existing style layer

removeStyleModel

@MapboxExperimental

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

Removes a model from the style.

removeStyleSource

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

Removes an existing style source.

removeStyleSourceUnchecked

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

setStyleAtmosphere

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

Sets the style global atmosphere properties.

setStyleAtmosphereProperty

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

Sets a value to the the style atmosphere property.

setStyleCustomGeometrySourceTileData

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

Set tile data of a custom geometry.

setStyleCustomRasterSourceTileData

@MapboxExperimental

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

setStyleGeoJSONSourceData

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

setStyleImportConfigProperties

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

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

Sets a value to a style import config.

setStyleLayerProperties

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

Sets style layer metadata.

setStyleLayerProperty

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

Sets a value to a style layer property.

setStyleLightProperty

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

Sets a value to the light property.

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

Sets lights to the style.

setStyleProjection

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

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

setStyleProjectionProperty

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

Sets a value to the the style projection property.

setStyleSourceProperties

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

Sets style source parameters. This method can be used to perform batch update for a style source parameters. The structure of a provided parameters value must conform to Style Specification - Sources format for a corresponding source type. Modification of a source type https://docs.mapbox.com/mapbox-gl-js/style-spec/sources/#type is not allowed.

setStyleSourceProperty

open override 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 override fun setStyleTerrain(properties: Value): Expected<String, None>

Sets the style global terrain source properties.

setStyleTerrainProperty

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

Sets the value of a style terrain property.

setStyleTransition

open override fun setStyleTransition(transitionOptions: TransitionOptions)

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

styleLayerExists

open override fun styleLayerExists(layerId: String): Boolean

Checks whether a given style layer exists.

styleSourceExists

open override fun styleSourceExists(sourceId: String): Boolean

Checks whether a given style source exists.

updateGeoJSONSourceFeatures

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

Update existing features in a GeoJSON style source.

updateStyleImageSourceImage

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

Updates the image of an image style source.

updateStyleImportWithJSON

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

val mapLoadingErrorDelegate: MapLoadingErrorDelegate

val pixelRatio: Float

styleDefaultCamera

@get:MainThread

open override val styleDefaultCamera: CameraOptions

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

@get:MainThread

open override val styleJSON: String

Get the JSON serialization string of the current Mapbox Style in use.

@get:MainThread

open override val styleLayers: List<StyleObjectInfo>

Returns the existing style layers.

val styleManager: StyleManager

@MapboxExperimental

@get:MainThread

open override val styleSlots: List<String>

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

@get:MainThread

open override val styleSources: List<StyleObjectInfo>

Returns the existing style sources.

@get:MainThread

open override val styleURI: String

Get the styleURI of the current Mapbox Style in use.

Extensions

fun MapboxStyleManager.addImage(image: StyleContract.StyleImageExtension)

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

fun MapboxStyleManager.addImage9Patch(image: StyleContract.StyleImageExtension)

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

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.

fun MapboxStyleManager.addLayer(layer: StyleContract.StyleLayerExtension)

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

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

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

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

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

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

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

@MapboxExperimental

fun MapboxStyleManager.addModel(model: StyleContract.StyleModelExtension)

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

addPersistentLayer

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

Add layer to the style persistently.

fun MapboxStyleManager.addSource(source: StyleContract.StyleSourceExtension)

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

fun MapboxStyleManager.getAtmosphere(): Atmosphere

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

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

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

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

Tries to cast the Layer to T.

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

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

fun MapboxStyleManager.getProjection(): Projection?

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

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

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

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

Tries to cast the Source to T.

fun MapboxStyleManager.getTerrain(sourceId: String): Terrain

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

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.

fun MapboxStyleManager.removeTerrain()

Removes terrain from style if it was set.

fun MapboxStyleManager.setAtmosphere(atmosphere: StyleContract.StyleAtmosphereExtension)

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

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.

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

Extension function to add list of lights.

fun MapboxStyleManager.setProjection(projection: Projection)

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

fun MapboxStyleManager.setTerrain(terrain: StyleContract.StyleTerrainExtension)

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