BackgroundLayer

@UiThread
class BackgroundLayer(layerId: String) : Layer, BackgroundLayerDsl
Content copied to clipboard

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)
Content copied to clipboard

Types

Companion
Link copied to clipboard
object Companion
Content copied to clipboard

Static variables and methods.

Functions

backgroundColor
Link copied to clipboard
open override fun backgroundColor(backgroundColor: Expression): BackgroundLayer
Content copied to clipboard
open override fun backgroundColor(@ColorInt backgroundColor: Int): BackgroundLayer
Content copied to clipboard
open override fun backgroundColor(backgroundColor: String): BackgroundLayer
Content copied to clipboard

The color with which the background will be drawn.

backgroundColorTransition
Link copied to clipboard
open override fun backgroundColorTransition(options: StyleTransition): BackgroundLayer
Content copied to clipboard

Set the BackgroundColor property transition options

open override fun backgroundColorTransition(block: StyleTransition.Builder.() -> Unit): BackgroundLayer
Content copied to clipboard

DSL for backgroundColorTransition.

backgroundOpacity
Link copied to clipboard
open override fun backgroundOpacity(backgroundOpacity: Expression): BackgroundLayer
Content copied to clipboard
open override fun backgroundOpacity(backgroundOpacity: Double): BackgroundLayer
Content copied to clipboard

The opacity at which the background will be drawn.

backgroundOpacityTransition
Link copied to clipboard
open override fun backgroundOpacityTransition(options: StyleTransition): BackgroundLayer
Content copied to clipboard

Set the BackgroundOpacity property transition options

open override fun backgroundOpacityTransition(block: StyleTransition.Builder.() -> Unit): BackgroundLayer
Content copied to clipboard

DSL for backgroundOpacityTransition.

backgroundPattern
Link copied to clipboard
open override fun backgroundPattern(backgroundPattern: Expression): BackgroundLayer
Content copied to clipboard
open override fun backgroundPattern(backgroundPattern: String): BackgroundLayer
Content copied to clipboard

Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.

backgroundPatternTransition
Link copied to clipboard
open override fun backgroundPatternTransition(options: StyleTransition): BackgroundLayer
Content copied to clipboard

Set the BackgroundPattern property transition options

open override fun backgroundPatternTransition(block: StyleTransition.Builder.() -> Unit): BackgroundLayer
Content copied to clipboard

DSL for backgroundPatternTransition.

bindTo
Link copied to clipboard
fun bindTo(delegate: StyleInterface)
Content copied to clipboard

Bind the layer to the Style.

open override fun bindTo(delegate: StyleInterface, position: LayerPosition?)
Content copied to clipboard

Bind the layer to the map controller.

maxZoom
Link copied to clipboard
open override fun maxZoom(maxZoom: Double): BackgroundLayer
Content copied to clipboard

The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.

minZoom
Link copied to clipboard
open override fun minZoom(minZoom: Double): BackgroundLayer
Content copied to clipboard

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

visibility
Link copied to clipboard
open override fun visibility(visibility: Visibility): BackgroundLayer
Content copied to clipboard

Whether this layer is displayed.

Properties

backgroundColor
Link copied to clipboard
val backgroundColor: String?
Content copied to clipboard

The color with which the background will be drawn.

backgroundColorAsColorInt
Link copied to clipboard
@get:ColorInt
val backgroundColorAsColorInt: Int?
Content copied to clipboard

The color with which the background will be drawn.

backgroundColorAsExpression
Link copied to clipboard
val backgroundColorAsExpression: Expression?
Content copied to clipboard

The color with which the background will be drawn.

backgroundColorTransition
Link copied to clipboard
val backgroundColorTransition: StyleTransition?
Content copied to clipboard

Transition options for BackgroundColor.

backgroundOpacity
Link copied to clipboard
val backgroundOpacity: Double?
Content copied to clipboard

The opacity at which the background will be drawn.

backgroundOpacityAsExpression
Link copied to clipboard
val backgroundOpacityAsExpression: Expression?
Content copied to clipboard

The opacity at which the background will be drawn.

backgroundOpacityTransition
Link copied to clipboard
val backgroundOpacityTransition: StyleTransition?
Content copied to clipboard

Transition options for BackgroundOpacity.

backgroundPattern
Link copied to clipboard
val backgroundPattern: String?
Content copied to clipboard

Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.

backgroundPatternAsExpression
Link copied to clipboard
val backgroundPatternAsExpression: Expression?
Content copied to clipboard

Name of image in sprite to use for drawing an image background. For seamless patterns, image width and height must be a factor of two (2, 4, 8, ..., 512). Note that zoom-dependent expressions will be evaluated only at integer zoom levels.

backgroundPatternTransition
Link copied to clipboard
val backgroundPatternTransition: StyleTransition?
Content copied to clipboard

Transition options for BackgroundPattern.

layerId
Link copied to clipboard
open override val layerId: String
Content copied to clipboard
maxZoom
Link copied to clipboard
open override val maxZoom: Double?
Content copied to clipboard

The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.

minZoom
Link copied to clipboard
open override val minZoom: Double?
Content copied to clipboard

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

visibility
Link copied to clipboard
open override val visibility: Visibility?
Content copied to clipboard

Whether this layer is displayed.