FillExtrusionLayer

An extruded (3D) polygon.

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

See also

<a href="https://www.mapbox.com/mapbox-gl-style-spec/#layers-fill-extrusion">The online documentation</a>

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

FillExtrusionLayer
Link copied to clipboard

the ID of the layer

fun FillExtrusionLayer(layerId: String, sourceId: String)

Types

Companion
Link copied to clipboard

Static variables and methods.

object Companion

Functions

bindTo
Link copied to clipboard

Bind the layer to the Style.

override fun bindTo(delegate: StyleManagerInterface)

Bind the layer to the map controller.

open override fun bindTo(delegate: StyleManagerInterface, position: LayerPosition?)
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
fillExtrusionBase
Link copied to clipboard

Set the FillExtrusionBase property

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

Set the FillExtrusionBase property transition options

open override fun fillExtrusionBaseTransition(options: StyleTransition): FillExtrusionLayer
open override fun fillExtrusionBaseTransition(block: StyleTransition.Builder.() -> Unit): FillExtrusionLayer
fillExtrusionColor
Link copied to clipboard

Set the FillExtrusionColor property

open override fun fillExtrusionColor(fillExtrusionColor: Expression): FillExtrusionLayer
open override fun fillExtrusionColor(fillExtrusionColor: String): FillExtrusionLayer

Set the FillExtrusionColor property.

open override fun fillExtrusionColor(fillExtrusionColor: Int): FillExtrusionLayer
fillExtrusionColorTransition
Link copied to clipboard

Set the FillExtrusionColor property transition options

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

Set the FillExtrusionHeight property

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

Set the FillExtrusionHeight property transition options

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

Set the FillExtrusionOpacity property

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

Set the FillExtrusionOpacity property transition options

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

Set the FillExtrusionPattern property

open override fun fillExtrusionPattern(fillExtrusionPattern: Expression): FillExtrusionLayer
open override fun fillExtrusionPattern(fillExtrusionPattern: String): FillExtrusionLayer
fillExtrusionPatternTransition
Link copied to clipboard

Set the FillExtrusionPattern property transition options

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

Set the FillExtrusionTranslate property

open override fun fillExtrusionTranslate(fillExtrusionTranslate: Expression): FillExtrusionLayer
open override fun fillExtrusionTranslate(fillExtrusionTranslate: List<Double>): FillExtrusionLayer
fillExtrusionTranslateAnchor
Link copied to clipboard

Set the FillExtrusionTranslateAnchor property

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

Set the FillExtrusionTranslate property transition options

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

Set the FillExtrusionVerticalGradient property

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

Set the filter property

open override fun filter(filter: Expression): FillExtrusionLayer
getCachedLayerProperties
Link copied to clipboard
override fun getCachedLayerProperties(): Value
hashCode
Link copied to clipboard
open override fun hashCode(): Int
maxZoom
Link copied to clipboard

Set the maxzoom property

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

Set the minzoom property

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

Set the sourceLayer property

open override fun sourceLayer(sourceLayer: String): FillExtrusionLayer
toString
Link copied to clipboard
open override fun toString(): String
updateProperty
Link copied to clipboard
override fun updateProperty(property: PropertyValue<*>)
visibility
Link copied to clipboard

Set the Visibility property

open override fun visibility(visibility: Visibility): FillExtrusionLayer

Properties

fillExtrusionBase
Link copied to clipboard

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

val fillExtrusionBase: Double?
fillExtrusionBaseAsExpression
Link copied to clipboard

This is an Expression representation of "fill-extrusion-base".

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

val fillExtrusionBaseAsExpression: Expression?
fillExtrusionBaseTransition
Link copied to clipboard

Transition options for FillExtrusionBase.

val fillExtrusionBaseTransition: StyleTransition?
fillExtrusionColor
Link copied to clipboard

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.

val fillExtrusionColor: String?
fillExtrusionColorAsColorInt
Link copied to clipboard

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.

val fillExtrusionColorAsColorInt: Int?
fillExtrusionColorAsExpression
Link copied to clipboard

This is an Expression representation of "fill-extrusion-color".

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.

val fillExtrusionColorAsExpression: Expression?
fillExtrusionColorTransition
Link copied to clipboard

Transition options for FillExtrusionColor.

val fillExtrusionColorTransition: StyleTransition?
fillExtrusionHeight
Link copied to clipboard

The height with which to extrude this layer.

val fillExtrusionHeight: Double?
fillExtrusionHeightAsExpression
Link copied to clipboard

This is an Expression representation of "fill-extrusion-height".

The height with which to extrude this layer.

val fillExtrusionHeightAsExpression: Expression?
fillExtrusionHeightTransition
Link copied to clipboard

Transition options for FillExtrusionHeight.

val fillExtrusionHeightTransition: StyleTransition?
fillExtrusionOpacity
Link copied to clipboard

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.

val fillExtrusionOpacity: Double?
fillExtrusionOpacityAsExpression
Link copied to clipboard

This is an Expression representation of "fill-extrusion-opacity".

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.

val fillExtrusionOpacityAsExpression: Expression?
fillExtrusionOpacityTransition
Link copied to clipboard

Transition options for FillExtrusionOpacity.

val fillExtrusionOpacityTransition: StyleTransition?
fillExtrusionPattern
Link copied to clipboard

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.

val fillExtrusionPattern: String?
fillExtrusionPatternAsExpression
Link copied to clipboard

This is an Expression representation of "fill-extrusion-pattern".

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.

val fillExtrusionPatternAsExpression: Expression?
fillExtrusionPatternTransition
Link copied to clipboard

Transition options for FillExtrusionPattern.

val fillExtrusionPatternTransition: StyleTransition?
fillExtrusionTranslate
Link copied to clipboard

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

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

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

This is an Expression representation of "fill-extrusion-translate-anchor".

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

val fillExtrusionTranslateAnchorAsExpression: Expression?
fillExtrusionTranslateAsExpression
Link copied to clipboard

This is an Expression representation of "fill-extrusion-translate".

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

val fillExtrusionTranslateAsExpression: Expression?
fillExtrusionTranslateTransition
Link copied to clipboard

Transition options for FillExtrusionTranslate.

val fillExtrusionTranslateTransition: StyleTransition?
fillExtrusionVerticalGradient
Link copied to clipboard

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 fillExtrusionVerticalGradient: Boolean?

This is an Expression representation of "fill-extrusion-vertical-gradient".

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?
filter
Link copied to clipboard

A expression specifying conditions on source features. Only features that match the filter are displayed. Zoom expressions in filters are only evaluated at integer zoom levels. The feature-state expression is not supported in filter expressions.

val filter: Expression?
layerId
Link copied to clipboard

the ID of the layer

open override val layerId: String
layerProperties
Link copied to clipboard

Properties of this layer.

override val layerProperties: HashMap<String, PropertyValue<*>>
maxZoom
Link copied to clipboard

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

Range: minimum: 0 maximum: 24

open override val maxZoom: Double?
minZoom
Link copied to clipboard

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

Range: minimum: 0 maximum: 24

open override val minZoom: Double?
sourceId
Link copied to clipboard

the ID of the source

val sourceId: String
sourceLayer
Link copied to clipboard

Source layer.

val sourceLayer: String?
visibility
Link copied to clipboard

Visibility of the layer.

open override val visibility: Visibility?