Skip to content

Latest commit

 

History

History
346 lines (213 loc) · 6.82 KB

FillExtrusionLayer.md

File metadata and controls

346 lines (213 loc) · 6.82 KB

<MapboxGL.FillExtrusionLayer />

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

props

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

styles


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


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


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


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


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

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


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}


fillExtrusionVerticalGradient

Name: fillExtrusionVerticalGradient

Description

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