| Prop | Type | Default | Required | Description |
|---|---|---|---|---|
| id | string |
none |
true |
A string that uniquely identifies the source in the style to which it is added. |
| sourceID | string |
MapboxGL.StyleSource.DefaultSourceID |
false |
The source from which to obtain the data to style. If the source has not yet been added to the current style, the behavior is undefined. Inferred from parent source only if the layer is a direct child to it. |
| sourceLayerID | string |
none |
false |
Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style. |
| aboveLayerID | string |
none |
false |
Inserts a layer above aboveLayerID. |
| belowLayerID | string |
none |
false |
Inserts a layer below belowLayerID |
| layerIndex | number |
none |
false |
Inserts a layer at a specified index |
| filter | array |
none |
false |
Filter only the features in the source layer that satisfy a condition that you define |
| minZoomLevel | number |
none |
false |
The minimum zoom level at which the layer gets parsed and appears. |
| maxZoomLevel | number |
none |
false |
The maximum zoom level at which the layer gets parsed and appears. |
| style | union |
none |
false |
Customizable style attributes |
Name: visibility
Whether this layer is displayed.
enum
visible
visible - The layer is shown.
none - The layer is not shown.
Name: 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 property.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: 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 property.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: 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 property.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}