mapbox-maps-android/com.mapbox.maps.extension.compose.style.layers.generated/BackgroundLayerState

BackgroundLayerState

class BackgroundLayerState

The state holder for BackgroundLayer's layer properties.

See also

The online documentation

Constructors

BackgroundLayerState

fun BackgroundLayerState()

Construct an default BackgroundLayerState.

Properties

backgroundColor

var backgroundColor: ColorValue

The color with which the background will be drawn. Default value: "#000000".

backgroundColorTransition

var backgroundColorTransition: Transition

Defines the transition of backgroundColor. Default value: "#000000".

backgroundEmissiveStrength

var backgroundEmissiveStrength: DoubleValue

Controls the intensity of light emitted on the source features. Default value: 0. Minimum value: 0.

backgroundEmissiveStrengthTransition

var backgroundEmissiveStrengthTransition: Transition

Defines the transition of backgroundEmissiveStrength. Default value: 0. Minimum value: 0.

backgroundOpacity

var backgroundOpacity: DoubleValue

The opacity at which the background will be drawn. Default value: 1. Value range: 0, 1

backgroundOpacityTransition

var backgroundOpacityTransition: Transition

Defines the transition of backgroundOpacity. Default value: 1. Value range: 0, 1

backgroundPattern

var backgroundPattern: ImageValue

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.

backgroundPitchAlignment

var backgroundPitchAlignment: BackgroundPitchAlignmentValue

Orientation of background layer. Default value: "map".

var maxZoom: LongValue

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

var minZoom: LongValue

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden. Value range: 0, 24

var visibility: VisibilityValue

Whether this layer is displayed. Default value: "visible".