Skip to content

Latest commit

 

History

History
166 lines (128 loc) · 3.37 KB

BackgroundLayer.md

File metadata and controls

166 lines (128 loc) · 3.37 KB
Raw

<MapLibreGL.BackgroundLayer />

Props

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

Styles

visibility

Whether this layer is displayed.

Type
enum
Default Value
visible
Supported Values
  • visible: The layer is shown.
  • none: The layer is not shown.

backgroundColor

The color with which the background will be drawn.

Type
color
Default Value
#000000
Disabled By
backgroundPattern
Expression Parameters
zoom

backgroundColorTransition

The transition affecting any changes to this layer’s backgroundColor property.

Type
{ duration, delay }
Units
milliseconds
Default Value
{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.

Type
resolvedImage
Expression Parameters
zoom

backgroundPatternTransition

The transition affecting any changes to this layer’s backgroundPattern property.

Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}

backgroundOpacity

The opacity at which the background will be drawn.

Type
number
Default Value
1
Minimum
0
Maximum
1
Expression Parameters
zoom

backgroundOpacityTransition

The transition affecting any changes to this layer’s backgroundOpacity property.

Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}