mapbox-maps-android/com.mapbox.maps.extension.style/StyleInterface

StyleInterface

Defines the style interface that can be used to interact with the map's style.

interface StyleInterface : StyleManagerInterface

Functions

addImage

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

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

layout-symbol-icon-image

paint-line-line-pattern

paint-fill-fill-pattern

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

addPersistentStyleCustomLayer

@NonNull()

abstract override fun addPersistentStyleCustomLayer(@NonNull() p0: String, @NonNull() p1: CustomLayerHost, @Nullable() p2: LayerPosition?): Expected<String, None>

addPersistentStyleLayer

@NonNull()

abstract override fun addPersistentStyleLayer(@NonNull() p0: Value, @Nullable() p1: LayerPosition?): Expected<String, None>

addStyleCustomGeometrySource

@NonNull()

abstract override fun addStyleCustomGeometrySource(@NonNull() p0: String, @NonNull() p1: CustomGeometrySourceOptions): Expected<String, None>

addStyleCustomLayer

@NonNull()

abstract override fun addStyleCustomLayer(@NonNull() p0: String, @NonNull() p1: CustomLayerHost, @Nullable() p2: LayerPosition?): Expected<String, None>

addStyleImage

@NonNull()

abstract override fun addStyleImage(@NonNull() p0: String, p1: Float, @NonNull() p2: Image, p3: Boolean, @NonNull() p4: MutableList<ImageStretches>, @NonNull() p5: MutableList<ImageStretches>, @Nullable() p6: ImageContent?): Expected<String, None>

addStyleLayer

@NonNull()

abstract override fun addStyleLayer(@NonNull() p0: Value, @Nullable() p1: LayerPosition?): Expected<String, None>

addStyleSource

@NonNull()

abstract override fun addStyleSource(@NonNull() p0: String, @NonNull() p1: Value): Expected<String, None>

equals

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

getStyleDefaultCamera

@NonNull()

abstract override fun getStyleDefaultCamera(): CameraOptions

getStyleImage

@Nullable()

abstract override fun getStyleImage(@NonNull() p0: String): Image?

getStyleJSON

@NonNull()

abstract override fun getStyleJSON(): String

getStyleLayerProperties

@NonNull()

abstract override fun getStyleLayerProperties(@NonNull() p0: String): Expected<String, Value>

getStyleLayerProperty

@NonNull()

abstract override fun getStyleLayerProperty(@NonNull() p0: String, @NonNull() p1: String): StylePropertyValue

getStyleLayers

@NonNull()

abstract override fun getStyleLayers(): MutableList<StyleObjectInfo>

getStyleLightProperty

@NonNull()

abstract override fun getStyleLightProperty(@NonNull() p0: String): StylePropertyValue

getStyleSourceProperties

@NonNull()

abstract override fun getStyleSourceProperties(@NonNull() p0: String): Expected<String, Value>

getStyleSourceProperty

@NonNull()

abstract override fun getStyleSourceProperty(@NonNull() p0: String, @NonNull() p1: String): StylePropertyValue

getStyleSources

@NonNull()

abstract override fun getStyleSources(): MutableList<StyleObjectInfo>

getStyleTerrainProperty

@NonNull()

abstract override fun getStyleTerrainProperty(@NonNull() p0: String): StylePropertyValue

getStyleTransition

@NonNull()

abstract override fun getStyleTransition(): TransitionOptions

getStyleURI

@NonNull()

abstract override fun getStyleURI(): String

hashCode

open override fun hashCode(): Int

invalidateStyleCustomGeometrySourceRegion

@NonNull()

abstract override fun invalidateStyleCustomGeometrySourceRegion(@NonNull() p0: String, @NonNull() p1: CoordinateBounds): Expected<String, None>

invalidateStyleCustomGeometrySourceTile

@NonNull()

abstract override fun invalidateStyleCustomGeometrySourceTile(@NonNull() p0: String, @NonNull() p1: CanonicalTileID): Expected<String, None>

isStyleLayerPersistent

@NonNull()

abstract override fun isStyleLayerPersistent(@NonNull() p0: String): Expected<String, Boolean>

isStyleLoaded

abstract override fun isStyleLoaded(): Boolean

moveStyleLayer

@NonNull()

abstract override fun moveStyleLayer(@NonNull() p0: String, @Nullable() p1: LayerPosition?): Expected<String, None>

removeStyleImage

@NonNull()

abstract override fun removeStyleImage(@NonNull() p0: String): Expected<String, None>

removeStyleLayer

@NonNull()

abstract override fun removeStyleLayer(@NonNull() p0: String): Expected<String, None>

removeStyleSource

@NonNull()

abstract override fun removeStyleSource(@NonNull() p0: String): Expected<String, None>

setStyleCustomGeometrySourceTileData

@NonNull()

abstract override fun setStyleCustomGeometrySourceTileData(@NonNull() p0: String, @NonNull() p1: CanonicalTileID, @NonNull() p2: MutableList<Feature>): Expected<String, None>

setStyleJSON

abstract override fun setStyleJSON(@NonNull() p0: String)

setStyleLayerProperties

@NonNull()

abstract override fun setStyleLayerProperties(@NonNull() p0: String, @NonNull() p1: Value): Expected<String, None>

setStyleLayerProperty

@NonNull()

abstract override fun setStyleLayerProperty(@NonNull() p0: String, @NonNull() p1: String, @NonNull() p2: Value): Expected<String, None>

setStyleLight

@NonNull()

abstract override fun setStyleLight(@NonNull() p0: Value): Expected<String, None>

setStyleLightProperty

@NonNull()

abstract override fun setStyleLightProperty(@NonNull() p0: String, @NonNull() p1: Value): Expected<String, None>

setStyleSourceProperties

@NonNull()

abstract override fun setStyleSourceProperties(@NonNull() p0: String, @NonNull() p1: Value): Expected<String, None>

setStyleSourceProperty

@NonNull()

abstract override fun setStyleSourceProperty(@NonNull() p0: String, @NonNull() p1: String, @NonNull() p2: Value): Expected<String, None>

setStyleTerrain

@NonNull()

abstract override fun setStyleTerrain(@NonNull() p0: Value): Expected<String, None>

setStyleTerrainProperty

@NonNull()

abstract override fun setStyleTerrainProperty(@NonNull() p0: String, @NonNull() p1: Value): Expected<String, None>

setStyleTransition

abstract override fun setStyleTransition(@NonNull() p0: TransitionOptions)

setStyleURI

abstract override fun setStyleURI(@NonNull() p0: String)

styleLayerExists

abstract override fun styleLayerExists(@NonNull() p0: String): Boolean

styleSourceExists

abstract override fun styleSourceExists(@NonNull() p0: String): Boolean

abstract override fun subscribe(@NonNull() p0: Observer, @NonNull() p1: MutableList<String>)

toString

open override fun toString(): String

unsubscribe

abstract override fun unsubscribe(@NonNull() p0: Observer)

abstract override fun unsubscribe(@NonNull() p0: Observer, @NonNull() p1: MutableList<String>)

updateStyleImageSourceImage

@NonNull()

abstract override fun updateStyleImageSourceImage(@NonNull() p0: String, @NonNull() p1: Image): Expected<String, None>

Properties

pixelRatio

The pixel ratio of the current display for the map to be rendered on, this value is initialised and can be overwritten at the Map's initialisation period.

abstract val pixelRatio: Float

Inheritors

Style

Extensions

addImage

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

fun StyleInterface.addImage(image: StyleContract.StyleImageExtension)

addImage9Patch

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

fun StyleInterface.addImage9Patch(image: StyleContract.StyleImageExtension)

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

@JvmOverloads()

fun StyleInterface.addImage9Patch(imageId: String, bitmap: Bitmap, scale: Float, sdf: Boolean): Expected<String, None>

addLayer

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

fun StyleInterface.addLayer(layer: StyleContract.StyleLayerExtension)

addLayerAbove

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

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

addLayerAt

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

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

addLayerBelow

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

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

addPersistentLayer

Add layer to the style persistently.

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.

@JvmOverloads()

fun StyleInterface.addPersistentLayer(layer: Layer, position: LayerPosition?)

addSource

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

fun StyleInterface.addSource(source: StyleContract.StyleSourceExtension)

getLight

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

fun StyleInterface.getLight(): Light

getTerrain

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

fun StyleInterface.getTerrain(sourceId: String): Terrain

localizeLabels