mapbox-maps-android/com.mapbox.maps.extension.style.layers/CustomLayer

CustomLayer

class CustomLayer(val layerId: String, host: CustomLayerHost) : Layer, CustomLayerDsl

Layer with custom rendering implementation.

With the power of CustomLayerHost you can implement your own Open GL ES rendering behaviour and manipulate layer as a usual one.

Parameters

layerId

mandatory custom layer id.

host

an instance of user-defined OpenGL ES renderer. Note: there is no API to get instance of CustomLayerHost from CustomLayer after setting it here so this instance should be cached on user's end if needed.

Constructors

CustomLayer

fun CustomLayer(layerId: String, host: CustomLayerHost)

Types

Companion

object Companion

Static methods and variables.

Functions

bindTo

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.

maxZoom

open override fun maxZoom(maxZoom: Double): CustomLayer

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

minZoom

open override fun minZoom(minZoom: Double): CustomLayer

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

slot

open override fun slot(slot: String): CustomLayer

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.

toString

open override fun toString(): String

Returns a human readable string that includes the cached properties of the layer.

visibility

open override fun visibility(visibility: Expression): CustomLayer

open override fun visibility(visibility: Visibility): CustomLayer

Whether this layer is displayed.

Properties

layerId

open override val layerId: String

maxZoom

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

open override val minZoom: Double?

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

slot

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.

visibility

open override val visibility: Visibility?

Whether this layer is displayed.

visibilityAsExpression

open override val visibilityAsExpression: Expression?

Whether this layer is displayed.

Extensions

isPersistent

fun Layer.isPersistent(): Boolean?

Get the persistent property as Boolean.