HillshadeLayer

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

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

See also

The online documentation

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

HillshadeLayer

fun HillshadeLayer(layerId: String, sourceId: String)

the ID of the layer

Types

Companion

object Companion

Static variables and methods.

Functions

bindTo

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.

hillshadeAccentColor

open override fun hillshadeAccentColor(hillshadeAccentColor: Expression): HillshadeLayer

Set the HillshadeAccentColor property

open override fun hillshadeAccentColor(@ColorInt() hillshadeAccentColor: Int): HillshadeLayer

Set the HillshadeAccentColor property.

open override fun hillshadeAccentColor(hillshadeAccentColor: String): HillshadeLayer

Set the HillshadeAccentColor property

hillshadeAccentColorTransition

open override fun hillshadeAccentColorTransition(options: StyleTransition): HillshadeLayer

Set the HillshadeAccentColor property transition options

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

DSL for hillshadeAccentColorTransition.

hillshadeExaggeration

open override fun hillshadeExaggeration(hillshadeExaggeration: Expression): HillshadeLayer

Set the HillshadeExaggeration property

open override fun hillshadeExaggeration(hillshadeExaggeration: Double): HillshadeLayer

Set the HillshadeExaggeration property

hillshadeExaggerationTransition

open override fun hillshadeExaggerationTransition(options: StyleTransition): HillshadeLayer

Set the HillshadeExaggeration property transition options

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

DSL for hillshadeExaggerationTransition.

hillshadeHighlightColor

open override fun hillshadeHighlightColor(hillshadeHighlightColor: Expression): HillshadeLayer

Set the HillshadeHighlightColor property

open override fun hillshadeHighlightColor(@ColorInt() hillshadeHighlightColor: Int): HillshadeLayer

Set the HillshadeHighlightColor property.

open override fun hillshadeHighlightColor(hillshadeHighlightColor: String): HillshadeLayer

Set the HillshadeHighlightColor property

hillshadeHighlightColorTransition

open override fun hillshadeHighlightColorTransition(options: StyleTransition): HillshadeLayer

Set the HillshadeHighlightColor property transition options

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

DSL for hillshadeHighlightColorTransition.

hillshadeIlluminationAnchor

open override fun hillshadeIlluminationAnchor(hillshadeIlluminationAnchor: Expression): HillshadeLayer

Set the HillshadeIlluminationAnchor property

open override fun hillshadeIlluminationAnchor(hillshadeIlluminationAnchor: HillshadeIlluminationAnchor): HillshadeLayer

Set the HillshadeIlluminationAnchor property

hillshadeIlluminationDirection

open override fun hillshadeIlluminationDirection(hillshadeIlluminationDirection: Expression): HillshadeLayer

Set the HillshadeIlluminationDirection property

open override fun hillshadeIlluminationDirection(hillshadeIlluminationDirection: Double): HillshadeLayer

Set the HillshadeIlluminationDirection property

hillshadeShadowColor

open override fun hillshadeShadowColor(hillshadeShadowColor: Expression): HillshadeLayer

Set the HillshadeShadowColor property

open override fun hillshadeShadowColor(@ColorInt() hillshadeShadowColor: Int): HillshadeLayer

Set the HillshadeShadowColor property.

open override fun hillshadeShadowColor(hillshadeShadowColor: String): HillshadeLayer

Set the HillshadeShadowColor property

hillshadeShadowColorTransition

open override fun hillshadeShadowColorTransition(options: StyleTransition): HillshadeLayer

Set the HillshadeShadowColor property transition options

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

DSL for hillshadeShadowColorTransition.

maxZoom

open override fun maxZoom(maxZoom: Double): HillshadeLayer

Set the maxzoom property

minZoom

open override fun minZoom(minZoom: Double): HillshadeLayer

Set the minzoom property

sourceLayer

open override fun sourceLayer(sourceLayer: String): HillshadeLayer

Set the sourceLayer property

visibility

open override fun visibility(visibility: Visibility): HillshadeLayer

Set the Visibility property

Properties

hillshadeAccentColor

val hillshadeAccentColor: String?

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

hillshadeAccentColorAsColorInt

val hillshadeAccentColorAsColorInt: Int?

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

hillshadeAccentColorAsExpression

val hillshadeAccentColorAsExpression: Expression?

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

hillshadeAccentColorTransition

val hillshadeAccentColorTransition: StyleTransition?

Transition options for HillshadeAccentColor.

hillshadeExaggeration

val hillshadeExaggeration: Double?

Intensity of the hillshade

hillshadeExaggerationAsExpression

val hillshadeExaggerationAsExpression: Expression?

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

hillshadeExaggerationTransition

val hillshadeExaggerationTransition: StyleTransition?

Transition options for HillshadeExaggeration.

hillshadeHighlightColor

val hillshadeHighlightColor: String?

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

hillshadeHighlightColorAsColorInt

val hillshadeHighlightColorAsColorInt: Int?

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

hillshadeHighlightColorAsExpression

val hillshadeHighlightColorAsExpression: Expression?

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

hillshadeHighlightColorTransition

val hillshadeHighlightColorTransition: StyleTransition?

Transition options for HillshadeHighlightColor.

hillshadeIlluminationAnchor

val hillshadeIlluminationAnchor: HillshadeIlluminationAnchor?

Direction of light source when map is rotated.

hillshadeIlluminationAnchorAsExpression

val hillshadeIlluminationAnchorAsExpression: Expression?

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

hillshadeIlluminationDirection

val hillshadeIlluminationDirection: Double?

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.

hillshadeIlluminationDirectionAsExpression

val hillshadeIlluminationDirectionAsExpression: Expression?

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

hillshadeShadowColor

val hillshadeShadowColor: String?

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

hillshadeShadowColorAsColorInt

val hillshadeShadowColorAsColorInt: Int?

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

hillshadeShadowColorAsExpression

val hillshadeShadowColorAsExpression: Expression?

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

hillshadeShadowColorTransition

val hillshadeShadowColorTransition: StyleTransition?

Transition options for HillshadeShadowColor.

layerId

open override val layerId: String

the ID of the layer

maxZoom

open override val maxZoom: Double?

The maximum zoom level for the layer.

minZoom

open override val minZoom: Double?

The minimum zoom level for the layer.

sourceId

val sourceId: String

the ID of the source

sourceLayer

val sourceLayer: String?

Source layer.

visibility

open override val visibility: Visibility?

Visibility of the layer.