BackgroundLayer

@UiThread()

class BackgroundLayer(layerId: String) : Layer, BackgroundLayerDsl

The background color or pattern of the map.

Parameters

layerId

the ID of the layer

Constructors

BackgroundLayer

fun BackgroundLayer(layerId: String)

the ID of the layer

Types

Companion

object Companion

Static variables and methods.

Functions

backgroundColor

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

open override fun backgroundColorTransition(options: StyleTransition): BackgroundLayer

Set the BackgroundColor property transition options

open override fun backgroundColorTransition(block: StyleTransition.Builder.() -> Unit): BackgroundLayer

DSL for backgroundColorTransition.

backgroundOpacity

open override fun backgroundOpacity(backgroundOpacity: Expression): BackgroundLayer

Set the BackgroundOpacity property

open override fun backgroundOpacity(backgroundOpacity: Double): BackgroundLayer

Set the BackgroundOpacity property

backgroundOpacityTransition

open override fun backgroundOpacityTransition(options: StyleTransition): BackgroundLayer

Set the BackgroundOpacity property transition options

open override fun backgroundOpacityTransition(block: StyleTransition.Builder.() -> Unit): BackgroundLayer

DSL for backgroundOpacityTransition.

backgroundPattern

open override fun backgroundPattern(backgroundPattern: Expression): BackgroundLayer

Set the BackgroundPattern property

open override fun backgroundPattern(backgroundPattern: String): BackgroundLayer

Set the BackgroundPattern property

backgroundPatternTransition

open override fun backgroundPatternTransition(options: StyleTransition): BackgroundLayer

Set the BackgroundPattern property transition options

open override fun backgroundPatternTransition(block: StyleTransition.Builder.() -> Unit): BackgroundLayer

DSL for backgroundPatternTransition.

bindTo

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.

maxZoom

open override fun maxZoom(maxZoom: Double): BackgroundLayer

Set the maxzoom property

minZoom

open override fun minZoom(minZoom: Double): BackgroundLayer

Set the minzoom property

visibility

open override fun visibility(visibility: Visibility): BackgroundLayer

Set the Visibility property

Properties

backgroundColor

val backgroundColor: String?

The color with which the background will be drawn.

backgroundColorAsColorInt

val backgroundColorAsColorInt: Int?

The color with which the background will be drawn.

backgroundColorAsExpression

val backgroundColorAsExpression: Expression?

This is an Expression representation of "background-color".

backgroundColorTransition

val backgroundColorTransition: StyleTransition?

Transition options for BackgroundColor.

backgroundOpacity

val backgroundOpacity: Double?

The opacity at which the background will be drawn.

backgroundOpacityAsExpression

val backgroundOpacityAsExpression: Expression?

This is an Expression representation of "background-opacity".

backgroundOpacityTransition

val backgroundOpacityTransition: StyleTransition?

Transition options for BackgroundOpacity.

backgroundPattern

val backgroundPattern: String?

Name of image in sprite to use for drawing an image background.

backgroundPatternAsExpression

val backgroundPatternAsExpression: Expression?

This is an Expression representation of "background-pattern".

backgroundPatternTransition

val backgroundPatternTransition: StyleTransition?

Transition options for BackgroundPattern.

layerId

open override val layerId: String

the ID of the layer

maxZoom

open override val maxZoom: Double?

The maximum zoom level for the layer.

minZoom

open override val minZoom: Double?

The minimum zoom level for the layer.

visibility

open override val visibility: Visibility?

Visibility of the layer.

BackgroundLayer

See also

Parameters

Constructors

Types

Functions

Properties