Mapbox Maps Android/com.mapbox.maps.extension.style.layers.generated/HillshadeLayer

HillshadeLayer

Client-side hillshading visualization based on DEM data. Currently, the implementation only supports Mapbox Terrain RGB and Mapzen Terrarium tiles.

class HillshadeLayer(layerId: String, sourceId: String) : Layer, HillshadeLayerDsl

See also

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

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

HillshadeLayer

the ID of the layer

fun HillshadeLayer(layerId: String, sourceId: String)

Types

Companion

Static variables and methods.

object Companion

Functions

bindTo

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

open operator override fun equals(other: Any?): Boolean

getCachedLayerProperties

override fun getCachedLayerProperties(): Value

hashCode

open override fun hashCode(): Int

hillshadeAccentColor

Set the HillshadeAccentColor property

open override fun hillshadeAccentColor(hillshadeAccentColor: Expression): HillshadeLayer

open override fun hillshadeAccentColor(hillshadeAccentColor: String): HillshadeLayer

Set the HillshadeAccentColor property.

open override fun hillshadeAccentColor(hillshadeAccentColor: Int): HillshadeLayer

hillshadeAccentColorTransition

Set the HillshadeAccentColor property transition options

open override fun hillshadeAccentColorTransition(options: StyleTransition): HillshadeLayer

DSL for hillshadeAccentColorTransition.

open override fun hillshadeAccentColorTransition(block: StyleTransition.Builder.() -> Unit): HillshadeLayer

hillshadeExaggeration

Set the HillshadeExaggeration property

open override fun hillshadeExaggeration(hillshadeExaggeration: Expression): HillshadeLayer

open override fun hillshadeExaggeration(hillshadeExaggeration: Double): HillshadeLayer

hillshadeExaggerationTransition

Set the HillshadeExaggeration property transition options

open override fun hillshadeExaggerationTransition(options: StyleTransition): HillshadeLayer

DSL for hillshadeExaggerationTransition.

open override fun hillshadeExaggerationTransition(block: StyleTransition.Builder.() -> Unit): HillshadeLayer

hillshadeHighlightColor

Set the HillshadeHighlightColor property

open override fun hillshadeHighlightColor(hillshadeHighlightColor: Expression): HillshadeLayer

open override fun hillshadeHighlightColor(hillshadeHighlightColor: String): HillshadeLayer

Set the HillshadeHighlightColor property.

open override fun hillshadeHighlightColor(hillshadeHighlightColor: Int): HillshadeLayer

hillshadeHighlightColorTransition

Set the HillshadeHighlightColor property transition options

open override fun hillshadeHighlightColorTransition(options: StyleTransition): HillshadeLayer

DSL for hillshadeHighlightColorTransition.

open override fun hillshadeHighlightColorTransition(block: StyleTransition.Builder.() -> Unit): HillshadeLayer

hillshadeIlluminationAnchor

Set the HillshadeIlluminationAnchor property

open override fun hillshadeIlluminationAnchor(hillshadeIlluminationAnchor: Expression): HillshadeLayer

open override fun hillshadeIlluminationAnchor(hillshadeIlluminationAnchor: HillshadeIlluminationAnchor): HillshadeLayer

hillshadeIlluminationDirection

Set the HillshadeIlluminationDirection property

open override fun hillshadeIlluminationDirection(hillshadeIlluminationDirection: Expression): HillshadeLayer

open override fun hillshadeIlluminationDirection(hillshadeIlluminationDirection: Double): HillshadeLayer

hillshadeShadowColor

Set the HillshadeShadowColor property

open override fun hillshadeShadowColor(hillshadeShadowColor: Expression): HillshadeLayer

open override fun hillshadeShadowColor(hillshadeShadowColor: String): HillshadeLayer

Set the HillshadeShadowColor property.

open override fun hillshadeShadowColor(hillshadeShadowColor: Int): HillshadeLayer

hillshadeShadowColorTransition

Set the HillshadeShadowColor property transition options

open override fun hillshadeShadowColorTransition(options: StyleTransition): HillshadeLayer

DSL for hillshadeShadowColorTransition.

open override fun hillshadeShadowColorTransition(block: StyleTransition.Builder.() -> Unit): HillshadeLayer

maxZoom

Set the maxzoom property

open override fun maxZoom(maxZoom: Double): HillshadeLayer

minZoom

Set the minzoom property

open override fun minZoom(minZoom: Double): HillshadeLayer

sourceLayer

Set the sourceLayer property

open override fun sourceLayer(sourceLayer: String): HillshadeLayer

toString

open override fun toString(): String

updateProperty

override fun updateProperty(property: PropertyValue<*>)

visibility

Set the Visibility property

open override fun visibility(visibility: Visibility): HillshadeLayer

Properties

hillshadeAccentColor

The shading color used to accentuate rugged terrain like sharp cliffs and gorges.

val hillshadeAccentColor: String?

hillshadeAccentColorAsColorInt

The shading color used to accentuate rugged terrain like sharp cliffs and gorges.

val hillshadeAccentColorAsColorInt: Int?

hillshadeAccentColorAsExpression

This is an Expression representation of "hillshade-accent-color".

The shading color used to accentuate rugged terrain like sharp cliffs and gorges.

val hillshadeAccentColorAsExpression: Expression?

hillshadeAccentColorTransition

Transition options for HillshadeAccentColor.

val hillshadeAccentColorTransition: StyleTransition?

hillshadeExaggeration

Intensity of the hillshade

val hillshadeExaggeration: Double?

hillshadeExaggerationAsExpression

This is an Expression representation of "hillshade-exaggeration".

Intensity of the hillshade

val hillshadeExaggerationAsExpression: Expression?

hillshadeExaggerationTransition

Transition options for HillshadeExaggeration.

val hillshadeExaggerationTransition: StyleTransition?

hillshadeHighlightColor

The shading color of areas that faces towards the light source.

val hillshadeHighlightColor: String?

hillshadeHighlightColorAsColorInt

The shading color of areas that faces towards the light source.

val hillshadeHighlightColorAsColorInt: Int?

hillshadeHighlightColorAsExpression

This is an Expression representation of "hillshade-highlight-color".

The shading color of areas that faces towards the light source.

val hillshadeHighlightColorAsExpression: Expression?

hillshadeHighlightColorTransition

Transition options for HillshadeHighlightColor.

val hillshadeHighlightColorTransition: StyleTransition?

hillshadeIlluminationAnchor

Direction of light source when map is rotated.

val hillshadeIlluminationAnchor: HillshadeIlluminationAnchor?

hillshadeIlluminationAnchorAsExpression

This is an Expression representation of "hillshade-illumination-anchor".

Direction of light source when map is rotated.

val hillshadeIlluminationAnchorAsExpression: Expression?

hillshadeIlluminationDirection

The direction of the light source used to generate the hillshading with 0 as the top of the viewport if hillshade-illumination-anchor is set to viewport and due north if hillshade-illumination-anchor is set to map.

val hillshadeIlluminationDirection: Double?

hillshadeIlluminationDirectionAsExpression

This is an Expression representation of "hillshade-illumination-direction".

The direction of the light source used to generate the hillshading with 0 as the top of the viewport if hillshade-illumination-anchor is set to viewport and due north if hillshade-illumination-anchor is set to map.

val hillshadeIlluminationDirectionAsExpression: Expression?

hillshadeShadowColor

The shading color of areas that face away from the light source.

val hillshadeShadowColor: String?

hillshadeShadowColorAsColorInt

The shading color of areas that face away from the light source.

val hillshadeShadowColorAsColorInt: Int?

hillshadeShadowColorAsExpression

This is an Expression representation of "hillshade-shadow-color".

The shading color of areas that face away from the light source.

val hillshadeShadowColorAsExpression: Expression?

hillshadeShadowColorTransition

Transition options for HillshadeShadowColor.

val hillshadeShadowColorTransition: StyleTransition?

layerId

the ID of the layer

open override val layerId: String

layerProperties

Properties of this layer.

override val layerProperties: HashMap<String, PropertyValue<*>>

maxZoom

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

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

the ID of the source

val sourceId: String

sourceLayer

Source layer.

val sourceLayer: String?

visibility

Visibility of the layer.

open override val visibility: Visibility?