FillExtrusionLayer

class FillExtrusionLayer(layerId: String, sourceId: String) : Layer, FillExtrusionLayerDsl

An extruded (3D) polygon.

See also

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

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

Types

Companion
Link copied to clipboard
object Companion

Static variables and methods.

Functions

bindTo
Link copied to clipboard
fun bindTo(delegate: StyleInterface)

Bind the layer to the Style.

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

Bind the layer to the map controller.

fillExtrusionAmbientOcclusionIntensity
Link copied to clipboard
open override fun fillExtrusionAmbientOcclusionIntensity(fillExtrusionAmbientOcclusionIntensity: Expression): FillExtrusionLayer
open override fun fillExtrusionAmbientOcclusionIntensity(fillExtrusionAmbientOcclusionIntensity: Double): FillExtrusionLayer

Controls the intensity of ambient occlusion (AO) shading. Current AO implementation is a low-cost best-effort approach that shades area near ground and concave angles between walls. Default value 0.0 disables ambient occlusion and values around 0.3 provide the most plausible results for buildings.

open override fun fillExtrusionAmbientOcclusionIntensityTransition(options: StyleTransition): FillExtrusionLayer

Set the FillExtrusionAmbientOcclusionIntensity property transition options

fillExtrusionAmbientOcclusionRadius
Link copied to clipboard
open override fun fillExtrusionAmbientOcclusionRadius(fillExtrusionAmbientOcclusionRadius: Expression): FillExtrusionLayer
open override fun fillExtrusionAmbientOcclusionRadius(fillExtrusionAmbientOcclusionRadius: Double): FillExtrusionLayer

The radius of ambient occlusion (AO) shading, in meters. Current AO implementation is a low-cost best-effort approach that shades area near ground and concave angles between walls where the radius defines only vertical impact. Default value 3.0 corresponds to hight of one floor and brings the most plausible results for buildings.

open override fun fillExtrusionAmbientOcclusionRadiusTransition(options: StyleTransition): FillExtrusionLayer

Set the FillExtrusionAmbientOcclusionRadius property transition options

fillExtrusionBase
Link copied to clipboard
open override fun fillExtrusionBase(fillExtrusionBase: Expression): FillExtrusionLayer
open override fun fillExtrusionBase(fillExtrusionBase: Double): FillExtrusionLayer

The height with which to extrude the base of this layer. Must be less than or equal to fill-extrusion-height.

fillExtrusionBaseTransition
Link copied to clipboard
open override fun fillExtrusionBaseTransition(options: StyleTransition): FillExtrusionLayer

Set the FillExtrusionBase property transition options

open override fun fillExtrusionBaseTransition(block: StyleTransition.Builder.() -> Unit): FillExtrusionLayer
fillExtrusionColor
Link copied to clipboard
open override fun fillExtrusionColor(fillExtrusionColor: Expression): FillExtrusionLayer
open override fun fillExtrusionColor(@ColorInt fillExtrusionColor: Int): FillExtrusionLayer
open override fun fillExtrusionColor(fillExtrusionColor: String): FillExtrusionLayer

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 fill-extrusion-opacity to set layer opacity.

fillExtrusionColorTransition
Link copied to clipboard
open override fun fillExtrusionColorTransition(options: StyleTransition): FillExtrusionLayer

Set the FillExtrusionColor property transition options

open override fun fillExtrusionColorTransition(block: StyleTransition.Builder.() -> Unit): FillExtrusionLayer
fillExtrusionHeight
Link copied to clipboard
open override fun fillExtrusionHeight(fillExtrusionHeight: Expression): FillExtrusionLayer
open override fun fillExtrusionHeight(fillExtrusionHeight: Double): FillExtrusionLayer

The height with which to extrude this layer.

fillExtrusionHeightTransition
Link copied to clipboard
open override fun fillExtrusionHeightTransition(options: StyleTransition): FillExtrusionLayer

Set the FillExtrusionHeight property transition options

open override fun fillExtrusionHeightTransition(block: StyleTransition.Builder.() -> Unit): FillExtrusionLayer
fillExtrusionOpacity
Link copied to clipboard
open override fun fillExtrusionOpacity(fillExtrusionOpacity: Expression): FillExtrusionLayer
open override fun fillExtrusionOpacity(fillExtrusionOpacity: Double): FillExtrusionLayer

The opacity of the entire fill extrusion layer. This is rendered on a per-layer, not per-feature, basis, and data-driven styling is not available.

fillExtrusionOpacityTransition
Link copied to clipboard
open override fun fillExtrusionOpacityTransition(options: StyleTransition): FillExtrusionLayer

Set the FillExtrusionOpacity property transition options

open override fun fillExtrusionOpacityTransition(block: StyleTransition.Builder.() -> Unit): FillExtrusionLayer
fillExtrusionPattern
Link copied to clipboard
open override fun fillExtrusionPattern(fillExtrusionPattern: Expression): FillExtrusionLayer
open override fun fillExtrusionPattern(fillExtrusionPattern: String): FillExtrusionLayer

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

fillExtrusionPatternTransition
Link copied to clipboard
open override fun fillExtrusionPatternTransition(options: StyleTransition): FillExtrusionLayer

Set the FillExtrusionPattern property transition options

open override fun fillExtrusionPatternTransition(block: StyleTransition.Builder.() -> Unit): FillExtrusionLayer
fillExtrusionTranslate
Link copied to clipboard
open override fun fillExtrusionTranslate(fillExtrusionTranslate: Expression): FillExtrusionLayer
open override fun fillExtrusionTranslate(fillExtrusionTranslate: List<Double>): FillExtrusionLayer

The geometry's offset. Values are x, y where negatives indicate left and up (on the flat plane), respectively.

fillExtrusionTranslateAnchor
Link copied to clipboard
open override fun fillExtrusionTranslateAnchor(fillExtrusionTranslateAnchor: Expression): FillExtrusionLayer
open override fun fillExtrusionTranslateAnchor(fillExtrusionTranslateAnchor: FillExtrusionTranslateAnchor): FillExtrusionLayer

Controls the frame of reference for fill-extrusion-translate.

fillExtrusionTranslateTransition
Link copied to clipboard
open override fun fillExtrusionTranslateTransition(options: StyleTransition): FillExtrusionLayer

Set the FillExtrusionTranslate property transition options

open override fun fillExtrusionTranslateTransition(block: StyleTransition.Builder.() -> Unit): FillExtrusionLayer
fillExtrusionVerticalGradient
Link copied to clipboard
open override fun fillExtrusionVerticalGradient(fillExtrusionVerticalGradient: Expression): FillExtrusionLayer
open override fun fillExtrusionVerticalGradient(fillExtrusionVerticalGradient: Boolean): FillExtrusionLayer

Whether to apply a vertical gradient to the sides of a fill-extrusion layer. If true, sides will be shaded slightly darker farther down.

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

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

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

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

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

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

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

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

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

Whether this layer is displayed.

Properties

fillExtrusionAmbientOcclusionIntensity
Link copied to clipboard
val fillExtrusionAmbientOcclusionIntensity: Double?

Controls the intensity of ambient occlusion (AO) shading. Current AO implementation is a low-cost best-effort approach that shades area near ground and concave angles between walls. Default value 0.0 disables ambient occlusion and values around 0.3 provide the most plausible results for buildings.

Controls the intensity of ambient occlusion (AO) shading. Current AO implementation is a low-cost best-effort approach that shades area near ground and concave angles between walls. Default value 0.0 disables ambient occlusion and values around 0.3 provide the most plausible results for buildings.

Transition options for FillExtrusionAmbientOcclusionIntensity.

fillExtrusionAmbientOcclusionRadius
Link copied to clipboard
val fillExtrusionAmbientOcclusionRadius: Double?

The radius of ambient occlusion (AO) shading, in meters. Current AO implementation is a low-cost best-effort approach that shades area near ground and concave angles between walls where the radius defines only vertical impact. Default value 3.0 corresponds to hight of one floor and brings the most plausible results for buildings.

The radius of ambient occlusion (AO) shading, in meters. Current AO implementation is a low-cost best-effort approach that shades area near ground and concave angles between walls where the radius defines only vertical impact. Default value 3.0 corresponds to hight of one floor and brings the most plausible results for buildings.

Transition options for FillExtrusionAmbientOcclusionRadius.

fillExtrusionBase
Link copied to clipboard
val fillExtrusionBase: Double?

The height with which to extrude the base of this layer. Must be less than or equal to fill-extrusion-height.

fillExtrusionBaseAsExpression
Link copied to clipboard
val fillExtrusionBaseAsExpression: Expression?

The height with which to extrude the base of this layer. Must be less than or equal to fill-extrusion-height.

fillExtrusionBaseTransition
Link copied to clipboard
val fillExtrusionBaseTransition: StyleTransition?

Transition options for FillExtrusionBase.

fillExtrusionColor
Link copied to clipboard
val fillExtrusionColor: String?

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 fill-extrusion-opacity to set layer opacity.

fillExtrusionColorAsColorInt
Link copied to clipboard
val fillExtrusionColorAsColorInt: Int?

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 fill-extrusion-opacity to set layer opacity.

fillExtrusionColorAsExpression
Link copied to clipboard
val fillExtrusionColorAsExpression: Expression?

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 fill-extrusion-opacity to set layer opacity.

fillExtrusionColorTransition
Link copied to clipboard
val fillExtrusionColorTransition: StyleTransition?

Transition options for FillExtrusionColor.

fillExtrusionHeight
Link copied to clipboard
val fillExtrusionHeight: Double?

The height with which to extrude this layer.

fillExtrusionHeightAsExpression
Link copied to clipboard
val fillExtrusionHeightAsExpression: Expression?

The height with which to extrude this layer.

fillExtrusionHeightTransition
Link copied to clipboard
val fillExtrusionHeightTransition: StyleTransition?

Transition options for FillExtrusionHeight.

fillExtrusionOpacity
Link copied to clipboard
val fillExtrusionOpacity: Double?

The opacity of the entire fill extrusion layer. This is rendered on a per-layer, not per-feature, basis, and data-driven styling is not available.

fillExtrusionOpacityAsExpression
Link copied to clipboard
val fillExtrusionOpacityAsExpression: Expression?

The opacity of the entire fill extrusion layer. This is rendered on a per-layer, not per-feature, basis, and data-driven styling is not available.

fillExtrusionOpacityTransition
Link copied to clipboard
val fillExtrusionOpacityTransition: StyleTransition?

Transition options for FillExtrusionOpacity.

fillExtrusionPattern
Link copied to clipboard
val fillExtrusionPattern: String?

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

fillExtrusionPatternAsExpression
Link copied to clipboard
val fillExtrusionPatternAsExpression: Expression?

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

fillExtrusionPatternTransition
Link copied to clipboard
val fillExtrusionPatternTransition: StyleTransition?

Transition options for FillExtrusionPattern.

fillExtrusionTranslate
Link copied to clipboard
val fillExtrusionTranslate: List<Double>?

The geometry's offset. Values are x, y where negatives indicate left and up (on the flat plane), respectively.

fillExtrusionTranslateAnchor
Link copied to clipboard

Controls the frame of reference for fill-extrusion-translate.

val fillExtrusionTranslateAnchorAsExpression: Expression?

Controls the frame of reference for fill-extrusion-translate.

fillExtrusionTranslateAsExpression
Link copied to clipboard
val fillExtrusionTranslateAsExpression: Expression?

The geometry's offset. Values are x, y where negatives indicate left and up (on the flat plane), respectively.

fillExtrusionTranslateTransition
Link copied to clipboard
val fillExtrusionTranslateTransition: StyleTransition?

Transition options for FillExtrusionTranslate.

fillExtrusionVerticalGradient
Link copied to clipboard
val fillExtrusionVerticalGradient: Boolean?

Whether to apply a vertical gradient to the sides of a fill-extrusion layer. If true, sides will be shaded slightly darker farther down.

val fillExtrusionVerticalGradientAsExpression: Expression?

Whether to apply a vertical gradient to the sides of a fill-extrusion layer. If true, sides will be shaded slightly darker farther down.

filter
Link copied to clipboard
val filter: Expression?

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

layerId
Link copied to clipboard
open override val layerId: String
maxZoom
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.

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

sourceId
Link copied to clipboard
val sourceId: String
sourceLayer
Link copied to clipboard
val sourceLayer: String?

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

visibility
Link copied to clipboard
open override val visibility: Visibility?

Whether this layer is displayed.