BackgroundLayer

class BackgroundLayer(layerId: String) : Layer, BackgroundLayerDsl

The background color or pattern of the map.

See also

Parameters

layerId

the ID of the layer

Constructors

BackgroundLayer
Link copied to clipboard
fun BackgroundLayer(layerId: String)
the ID of the layer

Types

Companion
Link copied to clipboard
object Companion
Static variables and methods.

Functions

backgroundColor
Link copied to clipboard
open override fun backgroundColor(backgroundColor: Expression): BackgroundLayer
Set the BackgroundColor property
open override fun backgroundColor(@ColorInt() backgroundColor: Int): BackgroundLayer
Set the BackgroundColor property.
open override fun backgroundColor(backgroundColor: String): BackgroundLayer
Set the BackgroundColor property
backgroundColorTransition
Link copied to clipboard
open override fun backgroundColorTransition(options: StyleTransition): BackgroundLayer
Set the BackgroundColor property transition options
open override fun backgroundColorTransition(block: StyleTransition.Builder.() -> Unit): BackgroundLayer
backgroundOpacity
Link copied to clipboard
open override fun backgroundOpacity(backgroundOpacity: Expression): BackgroundLayer
Set the BackgroundOpacity property
open override fun backgroundOpacity(backgroundOpacity: Double): BackgroundLayer
Set the BackgroundOpacity property
backgroundOpacityTransition
Link copied to clipboard
open override fun backgroundOpacityTransition(options: StyleTransition): BackgroundLayer
Set the BackgroundOpacity property transition options
open override fun backgroundOpacityTransition(block: StyleTransition.Builder.() -> Unit): BackgroundLayer
backgroundPattern
Link copied to clipboard
open override fun backgroundPattern(backgroundPattern: Expression): BackgroundLayer
Set the BackgroundPattern property
open override fun backgroundPattern(backgroundPattern: String): BackgroundLayer
Set the BackgroundPattern property
backgroundPatternTransition
Link copied to clipboard
open override fun backgroundPatternTransition(options: StyleTransition): BackgroundLayer
Set the BackgroundPattern property transition options
open override fun backgroundPatternTransition(block: StyleTransition.Builder.() -> Unit): BackgroundLayer
bindTo
Link copied to clipboard
fun bindTo(delegate: StyleInterface)
Bind the layer to the Style.
open override fun bindTo(delegate: StyleInterface, position: LayerPosition?)
Bind the layer to the map controller.
equals
Link copied to clipboard
open operator fun equals(other: Any?): Boolean
hashCode
Link copied to clipboard
open fun hashCode(): Int
maxZoom
Link copied to clipboard
open override fun maxZoom(maxZoom: Double): BackgroundLayer
Set the maxzoom property
minZoom
Link copied to clipboard
open override fun minZoom(minZoom: Double): BackgroundLayer
Set the minzoom property
toString
Link copied to clipboard
open fun toString(): String
visibility
Link copied to clipboard
open override fun visibility(visibility: Visibility): BackgroundLayer
Set the Visibility property

Properties

backgroundColor
Link copied to clipboard
val backgroundColor: String?
The color with which the background will be drawn.
backgroundColorAsColorInt
Link copied to clipboard
val backgroundColorAsColorInt: Int?
The color with which the background will be drawn.
backgroundColorAsExpression
Link copied to clipboard
val backgroundColorAsExpression: Expression?
This is an Expression representation of "background-color".
backgroundColorTransition
Link copied to clipboard
val backgroundColorTransition: StyleTransition?
Transition options for BackgroundColor.
backgroundOpacity
Link copied to clipboard
val backgroundOpacity: Double?
The opacity at which the background will be drawn.
backgroundOpacityAsExpression
Link copied to clipboard
val backgroundOpacityAsExpression: Expression?
This is an Expression representation of "background-opacity".
backgroundOpacityTransition
Link copied to clipboard
val backgroundOpacityTransition: StyleTransition?
Transition options for BackgroundOpacity.
backgroundPattern
Link copied to clipboard
val backgroundPattern: String?
Name of image in sprite to use for drawing an image background.
backgroundPatternAsExpression
Link copied to clipboard
val backgroundPatternAsExpression: Expression?
This is an Expression representation of "background-pattern".
backgroundPatternTransition
Link copied to clipboard
val backgroundPatternTransition: StyleTransition?
Transition options for BackgroundPattern.
layerId
Link copied to clipboard
open override val layerId: String
the ID of the layer
maxZoom
Link copied to clipboard
open override val maxZoom: Double?
The maximum zoom level for the layer.
minZoom
Link copied to clipboard
open override val minZoom: Double?
The minimum zoom level for the layer.
visibility
Link copied to clipboard
open override val visibility: Visibility?
Visibility of the layer.