mapbox-maps-android/com.mapbox.maps.extension.style.layers.generated/ClipLayer

ClipLayer

@UiThread
@MapboxExperimental
class ClipLayer(val layerId: String, val sourceId: String) : Layer, ClipLayerDsl

Layer that removes 3D content from map.

See also

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

Link copied to clipboard
fun ClipLayer(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
@MapboxExperimental
open override fun clipLayerTypes(clipLayerTypes: Expression): ClipLayer
@MapboxExperimental
open override fun clipLayerTypes(clipLayerTypes: List<String>): ClipLayer

Layer types that will also be removed if fallen below this clip layer. Default value: [].

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

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): ClipLayer

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): ClipLayer

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): ClipLayer

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): ClipLayer

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): ClipLayer
open override fun visibility(visibility: Visibility): ClipLayer

Whether this layer is displayed.

Properties

Link copied to clipboard
@MapboxExperimental
val clipLayerTypes: List<String>?

Layer types that will also be removed if fallen below this clip layer. Default value: [].

Link copied to clipboard
@MapboxExperimental
val clipLayerTypesAsExpression: Expression?

Layer types that will also be removed if fallen below this clip layer. Default value: [].

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.

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
val sourceLayer: String?

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
open override val visibilityAsExpression: Expression?

Whether this layer is displayed.

Extensions

Link copied to clipboard
fun Layer.isPersistent(): Boolean?

Get the persistent property as Boolean.