Skip to main content

<FillLayer />

FillLayer is a style layer that renders one or more filled (and optionally stroked) polygons on the map.

Props​

PropTypeDefaultRequiredDescription
styleFillLayerStylenonefalseCustomizable style attributes
sourceIDFIX ME UNKNOWN TYPEMLRNModule.StyleSource.DefaultSourceIDfalseFIX ME NO DESCRIPTION

Styles​

fillSortKey​

Sorts features in ascending order based on this value. Features with a higher sort key will appear above features with a lower sort key.

Type
number
Expression Parameters
zoom, feature

visibility​

Whether this layer is displayed.

Type
enum
Default Value
visible
Supported Values

  • visible: The layer is shown.

  • none: The layer is not shown.

fillAntialias​

Whether or not the fill should be antialiased.

Type
boolean
Default Value
true
Expression Parameters
zoom

fillOpacity​

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

fillOpacityTransition​

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

Type
{ duration, delay }
Units
milliseconds
Default Value
{ duration: 300, delay: 0 }

fillColor​

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

fillColorTransition​

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

Type
{ duration, delay }
Units
milliseconds
Default Value
{ duration: 300, delay: 0 }

fillOutlineColor​

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

Type
color
Disabled By
fillPattern
Expression Parameters
zoom, feature, feature-state

fillOutlineColorTransition​

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

Type
{ duration, delay }
Units
milliseconds
Default Value
{ duration: 300, delay: 0 }

fillTranslate​

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

Type
number[]
Default Value
0,0
Units
pixels
Expression Parameters
zoom

fillTranslateTransition​

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

Type
{ duration, delay }
Units
milliseconds
Default Value
{ duration: 300, delay: 0 }

fillTranslateAnchor​

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

fillPattern​

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

fillPatternTransition​

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

Type
{ duration, delay }
Units
milliseconds
Default Value
{ duration: 300, delay: 0 }