| 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 |
- visibility
- fillExtrusionOpacity
- fillExtrusionColor
- fillExtrusionTranslate
- fillExtrusionTranslateAnchor
- fillExtrusionPattern
- fillExtrusionHeight
- fillExtrusionBase
- fillExtrusionVerticalGradient
- fillExtrusionAmbientOcclusionIntensity
- fillExtrusionAmbientOcclusionRadius
Name: visibility
Whether this layer is displayed.
enum
visible
visible - The layer is shown.
none - The layer is not shown.
Name: fillExtrusionOpacity
The opacity of the entire fill extrusion layer. This is rendered on a perLayer, not perFeature, basis, and dataDriven styling is not available.
number
1
0
1
Parameters: zoom
fillExtrusionOpacityTransition
The transition affecting any changes to this layer’s fillExtrusionOpacity propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: fillExtrusionColor
The base color of the extruded fill. The extrusion's surfaces will be shaded differently based on this color in combination with the root light settings. If this color is specified as rgba with an alpha component, the alpha component will be ignored; use fillExtrusionOpacity to set layer opacity.
color
#000000
fillExtrusionPattern
Parameters: zoom, feature, feature-state
fillExtrusionColorTransition
The transition affecting any changes to this layer’s fillExtrusionColor propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: fillExtrusionTranslate
The geometry's offset. Values are [x, y] where negatives indicate left and up (on the flat plane), respectively.
array<number>
[0,0]
pixels
Parameters: zoom
fillExtrusionTranslateTransition
The transition affecting any changes to this layer’s fillExtrusionTranslate propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: fillExtrusionTranslateAnchor
Controls the frame of reference for fillExtrusionTranslate.
enum
map
map - The fill extrusion is translated relative to the map.
viewport - The fill extrusion is translated relative to the viewport.
fillExtrusionTranslate
Parameters: zoom
Name: fillExtrusionPattern
Name of image in sprite to use for drawing images on extruded fills. 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, feature
fillExtrusionPatternTransition
The transition affecting any changes to this layer’s fillExtrusionPattern propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: fillExtrusionHeight
The height with which to extrude this layer.
number
0
meters
0
Parameters: zoom, feature, feature-state
fillExtrusionHeightTransition
The transition affecting any changes to this layer’s fillExtrusionHeight propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: fillExtrusionBase
The height with which to extrude the base of this layer. Must be less than or equal to fillExtrusionHeight.
number
0
meters
0
fillExtrusionHeight
Parameters: zoom, feature, feature-state
fillExtrusionBaseTransition
The transition affecting any changes to this layer’s fillExtrusionBase propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: fillExtrusionVerticalGradient
Whether to apply a vertical gradient to the sides of a fillExtrusion layer. If true, sides will be shaded slightly darker farther down.
boolean
true
Parameters: zoom
Name: fillExtrusionAmbientOcclusionIntensity
Controls the intensity of ambient occlusion (AO) shading. Current AO implementation is a lowCost bestEffort approach that shades area near ground and concave angles between walls. Default value 0.0 disables ambient occlusion and values around 0.3 provide the most plausible results for buildings.
number
0
0
1
Parameters: zoom
fillExtrusionAmbientOcclusionIntensityTransition
The transition affecting any changes to this layer’s fillExtrusionAmbientOcclusionIntensity propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: fillExtrusionAmbientOcclusionRadius
The radius of ambient occlusion (AO) shading, in meters. Current AO implementation is a lowCost bestEffort approach that shades area near ground and concave angles between walls where the radius defines only vertical impact. Default value 3.0 corresponds to hight of one floor and brings the most plausible results for buildings.
number
3
0
Parameters: zoom
fillExtrusionAmbientOcclusionRadiusTransition
The transition affecting any changes to this layer’s fillExtrusionAmbientOcclusionRadius propery.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}