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

StyleInterface

interface StyleInterface : StyleManagerInterface

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

Functions

addImage

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

Adds an image to be used in the style.

addPersistentStyleCustomLayer

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

addPersistentStyleLayer

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

addStyleCustomGeometrySource

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

addStyleCustomLayer

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

addStyleImage

abstract 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

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

addStyleSource

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

equals

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

getStyleDefaultCamera

abstract fun getStyleDefaultCamera(): CameraOptions

getStyleImage

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

getStyleJSON

abstract fun getStyleJSON(): String

getStyleLayerProperties

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

getStyleLayerProperty

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

getStyleLayers

abstract fun getStyleLayers(): MutableList<StyleObjectInfo>

getStyleLightProperty

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

getStyleSourceProperties

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

getStyleSourceProperty

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

getStyleSources

abstract fun getStyleSources(): MutableList<StyleObjectInfo>

getStyleTerrainProperty

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

getStyleTransition

abstract fun getStyleTransition(): TransitionOptions

getStyleURI

abstract fun getStyleURI(): String

hashCode

open fun hashCode(): Int

invalidateStyleCustomGeometrySourceRegion

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

invalidateStyleCustomGeometrySourceTile

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

isStyleLayerPersistent

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

isStyleLoaded

abstract fun isStyleLoaded(): Boolean

moveStyleLayer

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

removeStyleImage

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

removeStyleLayer

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

removeStyleSource

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

setStyleCustomGeometrySourceTileData

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

setStyleJSON

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

setStyleLayerProperties

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

setStyleLayerProperty

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

setStyleLight

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

setStyleLightProperty

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

setStyleSourceProperties

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

setStyleSourceProperty

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

setStyleTerrain

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

setStyleTerrainProperty

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

setStyleTransition

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

setStyleURI

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

styleLayerExists

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

styleSourceExists

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

subscribe

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

toString

open fun toString(): String

unsubscribe

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

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

updateStyleImageSourceImage

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

Properties

pixelRatio

abstract val pixelRatio: Float

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.

Inheritors

Style

Extensions

addImage

fun StyleInterface.addImage(image: StyleContract.StyleImageExtension)

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

addImage9Patch

fun StyleInterface.addImage9Patch(image: StyleContract.StyleImageExtension)

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

@JvmOverloads()

fun StyleInterface.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.

addLayer

fun StyleInterface.addLayer(layer: StyleContract.StyleLayerExtension)

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

addLayerAbove

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

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

addLayerAt

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

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

addLayerBelow

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

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

addPersistentLayer

@JvmOverloads()

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

Add layer to the style persistently.

addSource

fun StyleInterface.addSource(source: StyleContract.StyleSourceExtension)

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

getLight

fun StyleInterface.getLight(): Light

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

getTerrain

fun StyleInterface.getTerrain(sourceId: String): Terrain

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

localizeLabels

@JvmOverloads()

fun StyleInterface.localizeLabels(locale: Locale, layerIds: List<String>? = null)

Extension function to localize style labels

removeTerrain

fun StyleInterface.removeTerrain()

Removes terrain from style if it was set.

setLight

fun StyleInterface.setLight(light: StyleContract.StyleLightExtension)

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

setTerrain

fun StyleInterface.setTerrain(terrain: StyleContract.StyleTerrainExtension)

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