Skip to main content

<FillExtrusionLayer />

FillExtrusionLayer is a style layer that renders one or more 3D extruded polygons on the map.

Props​

PropTypeDefaultRequiredDescription
styleFillExtrusionLayerStylenonefalseCustomizable style attributes
sourceIDFIX ME UNKNOWN TYPEMLRNModule.StyleSource.DefaultSourceIDfalseFIX 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.

fillExtrusionOpacity​

The opacity of the entire fill extrusion layer. This is rendered on a perLayer, not perFeature, basis, and dataDriven styling is not available.

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

fillExtrusionOpacityTransition​

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

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

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.

Type
color
Default Value
#000000
Disabled By
fillExtrusionPattern
Expression Parameters
zoom, feature, feature-state

fillExtrusionColorTransition​

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

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

fillExtrusionTranslate​

The geometry's offset. Values are [x, y] where negatives indicate left and up (on the flat plane), respectively.

Type
number[]
Default Value
0,0
Units
pixels
Expression Parameters
zoom

fillExtrusionTranslateTransition​

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

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

fillExtrusionTranslateAnchor​

Controls the frame of reference for fillExtrusionTranslate.

Type
enum
Default Value
map
Supported Values

  • map: The fill extrusion is translated relative to the map.

  • viewport: The fill extrusion is translated relative to the viewport.

Requires
fillExtrusionTranslate
Expression Parameters
zoom

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.

Type
resolvedImage
Expression Parameters
zoom, feature

fillExtrusionPatternTransition​

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

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

fillExtrusionHeight​

The height with which to extrude this layer.

Type
number
Default Value
0
Units
meters
Minimum
0
Expression Parameters
zoom, feature, feature-state

fillExtrusionHeightTransition​

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

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

fillExtrusionBase​

The height with which to extrude the base of this layer. Must be less than or equal to fillExtrusionHeight.

Type
number
Default Value
0
Units
meters
Minimum
0
Requires
fillExtrusionHeight
Expression Parameters
zoom, feature, feature-state

fillExtrusionBaseTransition​

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

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

fillExtrusionVerticalGradient​

Whether to apply a vertical gradient to the sides of a fillExtrusion layer. If true, sides will be shaded slightly darker farther down.

Type
boolean
Default Value
true
Expression Parameters
zoom