FillLayer

class FillLayer(val layerId: String, val sourceId: String) : Layer, FillLayerDsl

A filled polygon with an optional stroked border.

See also

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

Link copied to clipboard
fun FillLayer(layerId: String, sourceId: String)

Types

Link copied to clipboard
object Companion

Static variables and methods.

Functions

Link copied to clipboard
fun bindTo(delegate: MapboxStyleManager)

Bind the layer to the Style.

open override fun bindTo(delegate: MapboxStyleManager, position: LayerPosition?)

Bind the layer to the map controller.

Link copied to clipboard
open override fun fillAntialias(fillAntialias: Expression): FillLayer
open override fun fillAntialias(fillAntialias: Boolean): FillLayer

Whether or not the fill should be antialiased. Default value: true.

Link copied to clipboard
open override fun fillColor(fillColor: Expression): FillLayer
open override fun fillColor(@ColorInt fillColor: Int): FillLayer
open override fun fillColor(fillColor: String): FillLayer

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. Default value: "#000000".

Link copied to clipboard
open override fun fillColorTransition(options: StyleTransition): FillLayer

Set the FillColor property transition options

Link copied to clipboard
open override fun fillEmissiveStrength(fillEmissiveStrength: Expression): FillLayer
open override fun fillEmissiveStrength(fillEmissiveStrength: Double): FillLayer

Controls the intensity of light emitted on the source features. Default value: 0. Minimum value: 0.

Link copied to clipboard

Set the FillEmissiveStrength property transition options

Link copied to clipboard
open override fun fillOpacity(fillOpacity: Expression): FillLayer
open override fun fillOpacity(fillOpacity: Double): FillLayer

The opacity of the entire fill layer. In contrast to the fill-color, this value will also affect the 1px stroke around the fill, if the stroke is used. Default value: 1. Value range: 0, 1

Link copied to clipboard
open override fun fillOpacityTransition(options: StyleTransition): FillLayer

Set the FillOpacity property transition options

Link copied to clipboard
open override fun fillOutlineColor(fillOutlineColor: Expression): FillLayer
open override fun fillOutlineColor(@ColorInt fillOutlineColor: Int): FillLayer
open override fun fillOutlineColor(fillOutlineColor: String): FillLayer

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

Link copied to clipboard

Set the FillOutlineColor property transition options

Link copied to clipboard
open override fun fillPattern(fillPattern: Expression): FillLayer
open override fun fillPattern(fillPattern: String): FillLayer

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 zoom-dependent expressions will be evaluated only at integer zoom levels.

Link copied to clipboard
open override fun fillSortKey(fillSortKey: Expression): FillLayer
open override fun fillSortKey(fillSortKey: Double): FillLayer

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

Link copied to clipboard
open override fun fillTranslate(fillTranslate: Expression): FillLayer
open override fun fillTranslate(fillTranslate: List<Double>): FillLayer

The geometry's offset. Values are x, y where negatives indicate left and up, respectively. Default value: 0,0.

Link copied to clipboard
open override fun fillTranslateAnchor(fillTranslateAnchor: Expression): FillLayer
open override fun fillTranslateAnchor(fillTranslateAnchor: FillTranslateAnchor): FillLayer

Controls the frame of reference for fill-translate. Default value: "map".

Link copied to clipboard

Set the FillTranslate property transition options

Link copied to clipboard
open override fun fillZOffset(fillZOffset: Expression): FillLayer
open override fun fillZOffset(fillZOffset: Double): FillLayer

Specifies an uniform elevation in meters. Note: If the value is zero, the layer will be rendered on the ground. Non-zero values will elevate the layer from the sea level, which can cause it to be rendered below the terrain. Default value: 0. Minimum value: 0.

Link copied to clipboard

Set the FillZOffset property transition options

Link copied to clipboard
open override fun filter(filter: Expression): FillLayer

A filter is a property at the layer level that determines which features should be rendered in a style layer.

Link copied to clipboard
open override fun maxZoom(maxZoom: Double): FillLayer

The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.

Link copied to clipboard
open override fun minZoom(minZoom: Double): FillLayer

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

Link copied to clipboard
open override fun slot(slot: String): FillLayer

The slot this layer is assigned to. If specified, and a slot with that name exists, it will be placed at that position in the layer order.

Link copied to clipboard
open override fun sourceLayer(sourceLayer: String): FillLayer

A source layer is an individual layer of data within a vector source. A vector source can have multiple source layers.

Link copied to clipboard
open override fun visibility(visibility: Expression): FillLayer
open override fun visibility(visibility: Visibility): FillLayer

Whether this layer is displayed.

Properties

Link copied to clipboard

Whether or not the fill should be antialiased. Default value: true.

Link copied to clipboard

Whether or not the fill should be antialiased. Default value: true.

Link copied to clipboard

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. Default value: "#000000".

Link copied to clipboard

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. Default value: "#000000".

Link copied to clipboard

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. Default value: "#000000".

Link copied to clipboard

Transition options for FillColor.

Link copied to clipboard

Controls the intensity of light emitted on the source features. Default value: 0. Minimum value: 0.

Link copied to clipboard

Controls the intensity of light emitted on the source features. Default value: 0. Minimum value: 0.

Link copied to clipboard

Transition options for FillEmissiveStrength.

Link copied to clipboard

The opacity of the entire fill layer. In contrast to the fill-color, this value will also affect the 1px stroke around the fill, if the stroke is used. Default value: 1. Value range: 0, 1

Link copied to clipboard

The opacity of the entire fill layer. In contrast to the fill-color, this value will also affect the 1px stroke around the fill, if the stroke is used. Default value: 1. Value range: 0, 1

Link copied to clipboard

Transition options for FillOpacity.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Transition options for FillOutlineColor.

Link copied to clipboard

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 zoom-dependent expressions will be evaluated only at integer zoom levels.

Link copied to clipboard

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 zoom-dependent expressions will be evaluated only at integer zoom levels.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The geometry's offset. Values are x, y where negatives indicate left and up, respectively. Default value: 0,0.

Link copied to clipboard

Controls the frame of reference for fill-translate. Default value: "map".

Link copied to clipboard

Controls the frame of reference for fill-translate. Default value: "map".

Link copied to clipboard

The geometry's offset. Values are x, y where negatives indicate left and up, respectively. Default value: 0,0.

Link copied to clipboard

Transition options for FillTranslate.

Link copied to clipboard

Specifies an uniform elevation in meters. Note: If the value is zero, the layer will be rendered on the ground. Non-zero values will elevate the layer from the sea level, which can cause it to be rendered below the terrain. Default value: 0. Minimum value: 0.

Link copied to clipboard

Specifies an uniform elevation in meters. Note: If the value is zero, the layer will be rendered on the ground. Non-zero values will elevate the layer from the sea level, which can cause it to be rendered below the terrain. Default value: 0. Minimum value: 0.

Link copied to clipboard

Transition options for FillZOffset.

Link copied to clipboard

A filter is a property at the layer level that determines which features should be rendered in a style layer.

Link copied to clipboard
open override val layerId: String
Link copied to clipboard
open override val maxZoom: Double?

The maximum zoom level for the layer. At zoom levels equal to or greater than the maxzoom, the layer will be hidden.

Link copied to clipboard
open override val minZoom: Double?

The minimum zoom level for the layer. At zoom levels less than the minzoom, the layer will be hidden.

Link copied to clipboard
open override val slot: String?

The slot this layer is assigned to. If specified, and a slot with that name exists, it will be placed at that position in the layer order.

Link copied to clipboard
Link copied to clipboard

A source layer is an individual layer of data within a vector source. A vector source can have multiple source layers.

Link copied to clipboard
open override val visibility: Visibility?

Whether this layer is displayed.

Link copied to clipboard

Whether this layer is displayed.

Extensions

Link copied to clipboard

Get the persistent property as Boolean.