Skip to content

Latest commit

 

History

History
293 lines (180 loc) · 5.34 KB

FillLayer.md

File metadata and controls

293 lines (180 loc) · 5.34 KB

<MapboxGL.FillLayer />

FillLayer is a style layer that renders one or more filled (and optionally stroked) 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.
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


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.


Name

fillAntialias

Description

Whether or not the fill should be antialiased.

Type

boolean

Default Value

true

Expression

Parameters: zoom


Name

fillOpacity

Description

The opacity of the entire fill layer. In contrast to the fillColor, this value will also affect the 1px stroke around the fill, if the stroke is used.

Type

number

Default Value

1

Minimum

0

Maximum

1

Expression

Parameters: zoom, feature, feature-state


Name

fillOpacityTransition

Description

The transition affecting any changes to this layer’s fillOpacity propery.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


Name

fillColor

Description

The color of the filled part of this layer. This color can be specified as rgba with an alpha component and the color's opacity will not affect the opacity of the 1px stroke, if it is used.

Type

color

Default Value

#000000

Disabled By

fillPattern

Expression

Parameters: zoom, feature, feature-state


Name

fillColorTransition

Description

The transition affecting any changes to this layer’s fillColor propery.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


Name

fillOutlineColor

Description

The outline color of the fill. Matches the value of fillColor if unspecified.

Type

color

Disabled By

fillPattern

Expression

Parameters: zoom, feature, feature-state


Name

fillOutlineColorTransition

Description

The transition affecting any changes to this layer’s fillOutlineColor propery.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


Name

fillTranslate

Description

The geometry's offset. Values are [x, y] where negatives indicate left and up, respectively.

Type

array<number>

Default Value

[0,0]

Units

pixels

Expression

Parameters: zoom


Name

fillTranslateTransition

Description

The transition affecting any changes to this layer’s fillTranslate propery.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}


Name

fillTranslateAnchor

Description

Controls the frame of reference for fillTranslate.

Type

enum

Default Value

map

Supported Values

map - The fill is translated relative to the map.
viewport - The fill is translated relative to the viewport.

Requires

fillTranslate

Expression

Parameters: zoom


Name

fillPattern

Description

Name of image in sprite to use for drawing image 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

fillPatternTransition

Description

The transition affecting any changes to this layer’s fillPattern propery.

Type

{ duration, delay }

Units

milliseconds

Default Value

{duration: 300, delay: 0}