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

addPersistentStyleCustomLayer

@NonNull

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

addPersistentStyleLayer

@NonNull

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

addStyleCustomGeometrySource

@NonNull

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

addStyleCustomLayer

@NonNull

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

addStyleImage

@NonNull

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

@NonNull

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

addStyleModel

@NonNull

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

addStyleSource

@NonNull

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

getStyleAtmosphereProperty

@NonNull

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

getStyleDefaultCamera

@NonNull

abstract fun getStyleDefaultCamera(): CameraOptions

getStyleImage

@Nullable

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

getStyleJSON

@NonNull

abstract fun getStyleJSON(): String

getStyleLayerProperties

@NonNull

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

getStyleLayerProperty

@NonNull

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

getStyleLayers

@NonNull

abstract fun getStyleLayers(): MutableList<StyleObjectInfo>

getStyleLightProperty

@NonNull

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

getStyleProjectionProperty

@NonNull

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

getStyleSourceProperties

@NonNull

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

getStyleSourceProperty

@NonNull

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

getStyleSources

@NonNull

abstract fun getStyleSources(): MutableList<StyleObjectInfo>

getStyleTerrainProperty

@NonNull

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

getStyleTransition

@NonNull

abstract fun getStyleTransition(): TransitionOptions

getStyleURI

@NonNull

abstract fun getStyleURI(): String

hasStyleImage

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

hasStyleModel

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

invalidateStyleCustomGeometrySourceRegion

@NonNull

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

invalidateStyleCustomGeometrySourceTile

@NonNull

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

isStyleLayerPersistent

@NonNull

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

isStyleLoaded

abstract fun isStyleLoaded(): Boolean

isValid

abstract fun isValid(): Boolean

Whether the Style instance is valid.

moveStyleLayer

@NonNull

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

removeStyleImage

@NonNull

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

removeStyleLayer

@NonNull

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

removeStyleModel

@NonNull

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

removeStyleSource

@NonNull

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

setStyleAtmosphere

@NonNull

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

setStyleAtmosphereProperty

@NonNull

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

setStyleCustomGeometrySourceTileData

@NonNull

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

setStyleJSON

abstract fun setStyleJSON(@NonNull p0: String)

setStyleLayerProperties

@NonNull

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

setStyleLayerProperty

@NonNull

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

setStyleLight

@NonNull

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

setStyleLightProperty

@NonNull

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

setStyleProjection

@NonNull

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

setStyleProjectionProperty

@NonNull

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

setStyleSourceProperties

@NonNull

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

setStyleSourceProperty

@NonNull

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

setStyleTerrain

@NonNull

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

setStyleTerrainProperty

@NonNull

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

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

unsubscribe

abstract fun unsubscribe(@NonNull p0: Observer)

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

updateStyleImageSourceImage

@NonNull

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. X-stretches, Y-stretches and padding will be calculated from Bitmap.getNinePatchChunk.

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.

getAtmosphere

fun StyleInterface.getAtmosphere(): Atmosphere

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

getLight

fun StyleInterface.getLight(): Light

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

getProjection

fun StyleInterface.getProjection(): Projection

Extension function to get the projection 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.

setAtmosphere

fun StyleInterface.setAtmosphere(atmosphere: StyleContract.StyleAtmosphereExtension)

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

setLight

fun StyleInterface.setLight(light: StyleContract.StyleLightExtension)

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

setProjection

fun StyleInterface.setProjection(projection: Projection)

Extension function to set the Projection 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.