FillExtrusionLayer

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.

props

id

string

required A string that uniquely identifies the layer in the style to which it is added.

existing

boolean

The id refers to en existing layer in the style. Does not create a new layer.

sourceID

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

sourceLayerID

string

Identifier of the layer within the source identified by the sourceID property from which the receiver obtains the data to style.

aboveLayerID

string

Inserts a layer above aboveLayerID.

belowLayerID

string

Inserts a layer below belowLayerID

layerIndex

number

Inserts a layer at a specified index

filter

FilterExpression

Filter only the features in the source layer that satisfy a condition that you define

minZoomLevel

number

required The minimum zoom level at which the layer gets parsed and appears.

maxZoomLevel

number

required The maximum zoom level at which the layer gets parsed and appears.

style

FillExtrusionLayerStyleProps

Customizable style attributes

visibility

Name: visibility

Mapbox spec: 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.

Expression

Parameters: ``

fillExtrusionOpacity

Name: fillExtrusionOpacity

Mapbox spec: fill-extrusion-opacity

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 property.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}

fillExtrusionColor

Name: fillExtrusionColor

Mapbox spec: fill-extrusion-color

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, measure-light

fillExtrusionColorTransition

Name: fillExtrusionColorTransition

Description

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

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}

fillExtrusionTranslate

Name: fillExtrusionTranslate

Mapbox spec: fill-extrusion-translate

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 property.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}

fillExtrusionTranslateAnchor

Name: fillExtrusionTranslateAnchor

Mapbox spec: fill-extrusion-translate-anchor

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

Mapbox spec: fill-extrusion-pattern

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

fillExtrusionHeight

Name: fillExtrusionHeight

Mapbox spec: fill-extrusion-height

Description

The height with which to extrude this layer.

Type

number

Default Value

0

Units

meters

Minimum

0

Expression

Parameters: zoom, feature, feature-state

fillExtrusionHeightTransition

Name: fillExtrusionHeightTransition

Description

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

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}

fillExtrusionBase

Name: fillExtrusionBase

Mapbox spec: fill-extrusion-base

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 property.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}

fillExtrusionVerticalGradient

Name: fillExtrusionVerticalGradient

Mapbox spec: fill-extrusion-vertical-gradient

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

fillExtrusionRoundedRoof

Name: fillExtrusionRoundedRoof

Mapbox spec: fill-extrusion-rounded-roof

Description

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.

Type

boolean

Default Value

true

Requires

fillExtrusionEdgeRadius

Expression

Parameters: zoom