BackgroundLayer
BackgroundLayer¶
Props¶
| Prop | Type | Default | Required | Description |
|---|---|---|---|---|
| style | BackgroundLayerStyleProps |
none |
false |
Customizable style attributes |
| sourceID | `` | VietmapGL.StyleSource.DefaultSourceID |
false |
Styles¶
Visibility¶
Name
visibility
Description Whether this layer is displayed.
Type
enum
Default Value
visible
Supported Values
visible - The layer is shown.
none - The layer is not shown.
BackgroundColor¶
Name
backgroundColor
Description The color with which the background will be drawn.
Type
color
Default Value
#000000
Disabled By
backgroundPattern
Expression
Parameters: zoom
BackgroundColorTransition¶
Name
backgroundColorTransition
Description
The transition affecting any changes to this layer’s backgroundColor propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}
BackgroundPattern¶
Name
backgroundPattern
Description 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.
Type
resolvedImage
Expression
Parameters: zoom
BackgroundPatternTransition¶
Name
backgroundPatternTransition
Description
The transition affecting any changes to this layer’s backgroundPattern propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}
BackgroundOpacity¶
Name
backgroundOpacity
Description The opacity at which the background will be drawn.
Type
number
Default Value
1
Minimum
0
Maximum
1
Expression
Parameters: zoom
Name
backgroundOpacityTransition
Description
The transition affecting any changes to this layer’s backgroundOpacity propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}