FillExtrusionLayer
FillExtrusionLayer¶
- FillExtrusionLayer is a style layer that renders one or more 3D extruded polygons on the map.
props¶
| Prop | Type | Default | Required | Description |
|---|---|---|---|---|
| style | FillExtrusionLayerStyleProps |
none |
false |
Customizable style attributes |
| sourceID | `` | Vietmap.StyleSource.DefaultSourceID |
false |
styles¶
- visibility
- fillExtrusionOpacity
- fillExtrusionColor
- fillExtrusionTranslate
- fillExtrusionTranslateAnchor
- fillExtrusionPattern
- fillExtrusionHeight
- fillExtrusionBase
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.
FillExtrusionOpacity¶
Name
fillExtrusionOpacity
Description 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¶
Name
fillExtrusionOpacityTransition
Description
The transition affecting any changes to this layer’s fillExtrusionOpacity propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}
FillExtrusionColor¶
Name
fillExtrusionColor
Description
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¶
Name
fillExtrusionColorTransition
Description
The transition affecting any changes to this layer’s fillExtrusionColor propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}
FillExtrusionTranslate¶
Name
fillExtrusionTranslate
Description The geometry's offset. Values are [x, y] where negatives indicate left and up (on the flat plane), respectively.
Type
array<number>
Default Value
[0,0]
Units
pixels
Expression
Parameters: zoom
FillExtrusionTranslateTransition¶
Name
fillExtrusionTranslateTransition
Description
The transition affecting any changes to this layer’s fillExtrusionTranslate propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}
FillExtrusionTranslateAnchor¶
Name
fillExtrusionTranslateAnchor
Description
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
fillExtrusionPattern
Description 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¶
Name
fillExtrusionPatternTransition
Description
The transition affecting any changes to this layer’s fillExtrusionPattern propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}
FillExtrusionHeight¶
Name
fillExtrusionHeight
Description The height with which to extrude this layer.
Type
number
Default Value
0
Units
meters
Minimum
0
Expression
Parameters: zoom, feature, feature-state
Name
FillExtrusionHeightTransition¶
fillExtrusionHeightTransition
Description
The transition affecting any changes to this layer’s fillExtrusionHeight propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}
FillExtrusionBase¶
Name
fillExtrusionBase
Description
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¶
Name
fillExtrusionBaseTransition
Description
The transition affecting any changes to this layer’s fillExtrusionBase propery.
Type
{ duration, delay }
Units
milliseconds
Default Value
{duration: 300, delay: 0}