| Prop | Type | Default | Required | Description |
|---|---|---|---|---|
| style | BackgroundLayerStyleProps |
none |
false |
Customizable style attributes |
| sourceID | FIX ME UNKNOWN TYPE |
MapLibreGL.StyleSource.DefaultSourceID |
false |
FIX ME NO DESCRIPTION |
visibility
Whether this layer is displayed.
enum
visible
visible - The layer is shown.
none - The layer is not shown.
backgroundColor
The color with which the background will be drawn.
color
#000000
backgroundPattern
Parameters: zoom
backgroundColorTransition
The transition affecting any changes to this layer’s backgroundColor propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
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 zoomDependent expressions will be evaluated only at integer zoom levels.
resolvedImage
Parameters: zoom
backgroundPatternTransition
The transition affecting any changes to this layer’s backgroundPattern propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
backgroundOpacity
The opacity at which the background will be drawn.
number
1
0
1
Parameters: zoom
backgroundOpacityTransition
The transition affecting any changes to this layer’s backgroundOpacity propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}