Mapbox spec: fill-extrusion
import { FillExtrusionLayer } from '@rnmapbox/maps';
FillExtrusionLayer
FillExtrusionLayer is a style layer that renders one or more 3D extruded polygons on the map.
string
required A string that uniquely identifies the layer in the style to which it is added.
boolean
The id refers to en existing layer in the style. Does not create a new layer.
string
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.
defaults to: MapboxGL.StyleSource.DefaultSourceID
string
Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style.
string
Inserts a layer above aboveLayerID.
string
Inserts a layer below belowLayerID
number
Inserts a layer at a specified index
FilterExpression
Filter only the features in the source layer that satisfy a condition that you define
number
required The minimum zoom level at which the layer gets parsed and appears.
number
required The maximum zoom level at which the layer gets parsed and appears.
FillExtrusionLayerStyleProps
Customizable style attributes
- visibility
- fillExtrusionOpacity
- fillExtrusionColor
- fillExtrusionTranslate
- fillExtrusionTranslateAnchor
- fillExtrusionPattern
- fillExtrusionHeight
- fillExtrusionBase
- fillExtrusionVerticalGradient
- fillExtrusionRoundedRoof
Name: visibility
Mapbox spec: visibility
Whether this layer is displayed.
enum
visible
visible - The layer is shown.
none - The layer is not shown.
Parameters: ``
Name: fillExtrusionOpacity
Mapbox spec: fill-extrusion-opacity
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
Name: fillExtrusionOpacityTransition
The transition affecting any changes to this layer’s fillExtrusionOpacity property.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: fillExtrusionColor
Mapbox spec: fill-extrusion-color
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, measure-light
Name: fillExtrusionColorTransition
The transition affecting any changes to this layer’s fillExtrusionColor property.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: fillExtrusionTranslate
Mapbox spec: fill-extrusion-translate
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
Name: fillExtrusionTranslateTransition
The transition affecting any changes to this layer’s fillExtrusionTranslate property.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: fillExtrusionTranslateAnchor
Mapbox spec: fill-extrusion-translate-anchor
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
Mapbox spec: fill-extrusion-pattern
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
Name: fillExtrusionHeight
Mapbox spec: fill-extrusion-height
The height with which to extrude this layer.
number
0
meters
0
Parameters: zoom, feature, feature-state
Name: fillExtrusionHeightTransition
The transition affecting any changes to this layer’s fillExtrusionHeight property.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: fillExtrusionBase
Mapbox spec: fill-extrusion-base
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
Name: fillExtrusionBaseTransition
The transition affecting any changes to this layer’s fillExtrusionBase property.
{ duration, delay }
milliseconds
{duration: 300, delay: 0}
Name: fillExtrusionVerticalGradient
Mapbox spec: fill-extrusion-vertical-gradient
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: fillExtrusionRoundedRoof
Mapbox spec: fill-extrusion-rounded-roof
Indicates whether top edges should be rounded when fillExtrusionEdgeRadius has a value greater than 0. If false, rounded edges are only applied to the sides. Default is true.
boolean
true
fillExtrusionEdgeRadius
Parameters: zoom