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

Style

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.

class Style : StyleInterface

Types

Companion

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

object Companion

OnStyleLoaded

Callback to be invoked when a style has finished loading.

fun fun interface OnStyleLoaded

Functions

addImage

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.

The image can be used in icon-image, fill-pattern, and line-pattern.

See https://www.mapbox.com/mapbox-gl-js/style-spec/#layout-symbol-icon-image See https://www.mapbox.com/mapbox-gl-js/style-spec/#paint-line-line-pattern See https://www.mapbox.com/mapbox-gl-js/style-spec/#paint-fill-fill-pattern

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

Adds a new style custom layer.

Note: This is an experimental API and is a subject to change.

Whenever a new style is being parsed and currently used style has persistent layers, an engine will try to do following:

keep the persistent layer at its relative position
keep the source used by a persistent layer
keep images added through addStyleImage method

In cases when a new style has the same layer, source or image resource, style's resources would be used instead and MapLoadingError event will be emitted.

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

addPersistentStyleLayer

Adds a new style layer.

Note: This is an experimental API and is a subject to change.

Whenever a new style is being parsed and currently used style has persistent layers, an engine will try to do following:

keep the persistent layer at its relative position
keep the source used by a persistent layer
keep images added through addStyleImage method

In cases when a new style has the same layer, source or image resource, style's resources would be used instead and MapLoadingError event will be emitted.

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

addStyleCustomGeometrySource

Adds a custom geometry to be used in the style. To add the data, implement the fetchTileFunction callback in the options and call setStyleCustomGeometrySourceTileData()

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

addStyleCustomLayer

Adds a new style custom layer.

style-spec#layers

Runtime style layers are valid until they are either removed or a new style is loaded.

Note: Custom layers are only valid on OpenGL rendering backend. Attempting to add a custom layer on Metal rendering backend results in undefined behavior.

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

addStyleImage

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.

The image can be used in icon-image, fill-pattern, and line-pattern.

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

addStyleLayer

Adds a new style layer.

See https://docs.mapbox.com/mapbox-gl-js/style-spec/#layers

Runtime style layers are valid until they are either removed or a new style is loaded.

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

addStyleSource

Adds a new style source.

See https://docs.mapbox.com/mapbox-gl-js/style-spec/#sources

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

equals

open operator override fun equals(other: Any?): Boolean

getStyleDefaultCamera

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

The style default camera is re-evaluated when a new style is loaded.

open override fun getStyleDefaultCamera(): CameraOptions

getStyleImage

Get an image from the style.

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

getStyleJSON

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

open override fun getStyleJSON(): String

getStyleLayerProperties

Gets style layer properties.

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

getStyleLayerProperty

Gets the value of style layer \p property.

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

getStyleLayers

Returns the existing style layers.

open override fun getStyleLayers(): List<StyleObjectInfo>

getStyleLightProperty

Gets the value of a style light property.

open override fun getStyleLightProperty(property: String): StylePropertyValue

getStyleSourceProperties

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

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

getStyleSourceProperty

Gets the value of style source property.

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

getStyleSources

Returns the existing style sources.

open override fun getStyleSources(): List<StyleObjectInfo>

getStyleSourcesAttribution

Returns the current sources metadata.

fun getStyleSourcesAttribution(): List<String>

getStyleTerrainProperty

Get the value of a style terrain property.

open override fun getStyleTerrainProperty(property: String): StylePropertyValue

getStyleTransition

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 overriden via setStyleTransition, but the options are reset once a new style has been loaded.

The style transition is re-evaluated when a new style is loaded.

open override fun getStyleTransition(): TransitionOptions

getStyleURI

Get the URI of the current Mapbox Style in use.

open override fun getStyleURI(): String

hashCode

open override fun hashCode(): Int

invalidateStyleCustomGeometrySourceRegion

Invalidate region for provided custom geometry source.

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

invalidateStyleCustomGeometrySourceTile

Invalidate tile for provided custom geometry source.

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

isStyleLayerPersistent

Checks if a style layer is persistent.

Note: This is an experimental API and is a subject to change.

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

isStyleLoaded

Check if the style is completely loaded.

open override fun isStyleLoaded(): Boolean

moveStyleLayer

Moves an existing style layer.

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

removeStyleImage

Removes an image from the style.

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

removeStyleLayer

Removes an existing style layer

Runtime style layers are valid until they are either removed or a new style is loaded.

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

removeStyleSource

Removes an existing style source.

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

setStyleCustomGeometrySourceTileData

Set tile data of a custom geometry.

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

setStyleJSON

Load the style from a provided JSON string.

attention This method should be called on the same thread where Map object is initialized.

open override fun setStyleJSON(json: String)

setStyleLayerProperties

Sets style layer metadata.

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

setStyleLayerProperty

Sets a value to a style layer property.

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

setStyleLight

Sets the style global light source properties.

See https://docs.mapbox.com/mapbox-gl-js/style-spec/#light

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

setStyleLightProperty

Sets a value to the the style light property.

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

setStyleSourceProperties

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 \sa https://docs.mapbox.com/mapbox-gl-js/style-spec/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.

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

setStyleSourceProperty

Sets a value to a style source property.

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

setStyleTerrain

Sets the style global terrain source properties.

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

setStyleTerrainProperty

Gets the value of a style terrain property.

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

setStyleTransition

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

The style transition is re-evaluated when a new style is loaded.

open override fun setStyleTransition(transitionOptions: TransitionOptions)

setStyleURI

Load style from provided URI.

This is an asynchronous call. In order to get result of this operation please use OnStyleLoadedListener, OnStyleDataLoadedListener or OnMapLoadErrorListener. In case of successful style load you should get notified by OnStyleLoadedListener.

And in case of error @see MapLoadError#StyleLoadError will be generated.

\attention This method should be called on the same thread where @see Map object is initialized.

open override fun setStyleURI(uri: String)

styleLayerExists

Checks whether a given style layer exists.

Runtime style layers are valid until they are either removed or a new style is loaded.

open override fun styleLayerExists(layerId: String): Boolean

styleSourceExists

Checks whether a given style source exists.

open override fun styleSourceExists(sourceId: String): Boolean

Subscribes an Observer to a provided list of event types. Observable will hold a strong reference to an Observer instance, therefore, in order to stop receiving notifications, caller must call unsubscribe with an Observer instance used for an initial subscription.

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

toString

open override fun toString(): String

unsubscribe

Unsubscribes an Observer from all events.

open override fun unsubscribe(observer: Observer)

Unsubscribes an Observer from a provided list of event types.

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

updateStyleImageSourceImage

Updates the image of an image style source.

See https://docs.mapbox.com/mapbox-gl-js/style-spec/#sources-image

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

Properties

pixelRatio

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

open override val pixelRatio: Float