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

BackgroundLayer

@MapboxExperimental
@Composable
fun BackgroundLayer(layerId: String = remember { generateRandomLayerId("background") }, backgroundColor: ColorValue = ColorValue.INITIAL, backgroundColorTransition: Transition = Transition.INITIAL, backgroundEmissiveStrength: DoubleValue = DoubleValue.INITIAL, backgroundEmissiveStrengthTransition: Transition = Transition.INITIAL, backgroundOpacity: DoubleValue = DoubleValue.INITIAL, backgroundOpacityTransition: Transition = Transition.INITIAL, backgroundPattern: ImageValue = ImageValue.INITIAL, visibility: VisibilityValue = VisibilityValue.INITIAL, minZoom: LongValue = LongValue.INITIAL, maxZoom: LongValue = LongValue.INITIAL)

The background color or pattern of the map.

See also

Parameters

layerId

the ID of the layer, by default, a random id will be generated with UUID.

backgroundColor

The color with which the background will be drawn.

backgroundColorTransition

Defines the transition of backgroundColor.

backgroundEmissiveStrength

Controls the intensity of light emitted on the source features.

backgroundEmissiveStrengthTransition

Defines the transition of backgroundEmissiveStrength.

backgroundOpacity

The opacity at which the background will be drawn.

backgroundOpacityTransition

Defines the transition of backgroundOpacity.

backgroundPattern

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.

visibility

Whether this layer is displayed.

minZoom

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

maxZoom

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