MapLibre Native Android/org.maplibre.android.style.layers/BackgroundLayer

BackgroundLayer

@UiThread
open class BackgroundLayer : Layer

The background color or pattern of the map.

See also

<a href="https://maplibre.org/maplibre-style-spec/#layers-background">The online documentation</a>

Constructors

Link copied to clipboard
constructor(layerId: String)
Creates a BackgroundLayer.

Properties

Link copied to clipboard
open val nativePtr: Long

Functions

Link copied to clipboard
@NonNull
open fun getBackgroundColor(): PropertyValue<String>
Get the BackgroundColor property
Link copied to clipboard
@ColorInt
open fun getBackgroundColorAsInt(): Int
The color with which the background will be drawn.
Link copied to clipboard
@NonNull
open fun getBackgroundColorTransition(): TransitionOptions
Get the BackgroundColor property transition options
Link copied to clipboard
@NonNull
open fun getBackgroundOpacity(): PropertyValue<Float>
Get the BackgroundOpacity property
Link copied to clipboard
@NonNull
open fun getBackgroundOpacityTransition(): TransitionOptions
Get the BackgroundOpacity property transition options
Link copied to clipboard
@NonNull
open fun getBackgroundPattern(): PropertyValue<String>
Get the BackgroundPattern property
Link copied to clipboard
@NonNull
open fun getBackgroundPatternTransition(): TransitionOptions
Get the BackgroundPattern property transition options
Link copied to clipboard
@NonNull
open fun getId(): String
Link copied to clipboard
open fun getMaxZoom(): Float
Link copied to clipboard
open fun getMinZoom(): Float
Link copied to clipboard
Link copied to clipboard
open fun isDetached(): Boolean
Link copied to clipboard
open fun setBackgroundColorTransition(@NonNull options: TransitionOptions)
Set the BackgroundColor property transition options
Link copied to clipboard
open fun setBackgroundOpacityTransition(@NonNull options: TransitionOptions)
Set the BackgroundOpacity property transition options
Link copied to clipboard
open fun setBackgroundPatternTransition(@NonNull options: TransitionOptions)
Set the BackgroundPattern property transition options
Link copied to clipboard
open fun setDetached()
Link copied to clipboard
open fun setMaxZoom(zoom: Float)
Link copied to clipboard
open fun setMinZoom(zoom: Float)
Link copied to clipboard
open fun setProperties(@NonNull properties: Array<PropertyValue<out Any>>)
Link copied to clipboard
@NonNull
open fun withProperties(@NonNull properties: Array<PropertyValue<out Any>>): BackgroundLayer
Set a property or properties.