Style

class Style : StyleInterface

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 getStyleAsync() method on MapboxMap.

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

Types

Companion

object Companion

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

OnStyleLoaded

fun fun interface OnStyleLoaded

Callback to be invoked when a style has finished loading.

Functions

addImage

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

Adds an image to be used in the style.

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

Adds an image to be used in the style.

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

Adds an image to be used in the style.

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

Adds an image to be used in the style.

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.

addStyleCustomLayer

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

Adds a new style custom layer.

addStyleImage

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.

addStyleLayer

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

Adds a new style layer.

addStyleSource

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

Adds a new style source.

getStyleDefaultCamera

open override fun getStyleDefaultCamera(): CameraOptions

Returns the map style's default camera, if any, or a default camera otherwise.

getStyleImage

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

Get an image from the style.

getStyleJSON

open override fun getStyleJSON(): String

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

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 \p property.

getStyleLayers

open override fun getStyleLayers(): List<StyleObjectInfo>

Returns the existing style layers.

getStyleLightProperty

open override fun getStyleLightProperty(property: String): StylePropertyValue

Gets the value of a style light property.

getStyleSourceProperties

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

Gets style source parameters.

getStyleSourceProperty

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

Gets the value of style source property.

getStyleSources

open override fun getStyleSources(): List<StyleObjectInfo>

Returns the existing style sources.

getStyleSourcesAttribution

fun getStyleSourcesAttribution(): List<String>

Returns the current sources metadata.

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.

getStyleURI

open override fun getStyleURI(): String

Get the URI of the current Mapbox Style in use.

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.

isStyleLayerPersistent

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

Checks if a style layer is persistent.

isStyleLoaded

open override fun isStyleLoaded(): Boolean

Check if the style is completely loaded.

moveStyleLayer

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

Moves an existing style layer.

removeStyleImage

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

Removes an image from the style.

removeStyleLayer

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

Removes an existing style layerRuntime style layers are valid until they are either removed or a new style is loaded.

removeStyleSource

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

Removes an existing style source.

setStyleCustomGeometrySourceTileData

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

Set tile data of a custom geometry.

setStyleJSON

open override fun setStyleJSON(json: String)

Load the style from a provided JSON string.

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.

setStyleLight

open override fun setStyleLight(parameters: Value): Expected<String, None>

Sets the style global light source properties.

setStyleLightProperty

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

Sets a value to the the style light property.

setStyleSourceProperties

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

Sets style source parameters.

setStyleSourceProperty

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

Sets a value to a style source property.

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>

Gets 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.

setStyleURI

open override fun setStyleURI(uri: String)

Load style from provided URI.

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.

open override fun subscribe(observer: Observer, events: MutableList<String>)

Subscribes an Observer to a provided list of event types.

unsubscribe

open override fun unsubscribe(observer: Observer)

Unsubscribes an Observer from all events.

open override fun unsubscribe(observer: Observer, events: MutableList<String>)

Unsubscribes an Observer from a provided list of event types.

updateStyleImageSourceImage

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

Updates the image of an image style source.

Properties

pixelRatio

open override val pixelRatio: Float

the scale ratio of the style, default the device pixel ratio