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

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

HillshadeLayer
Link copied to clipboard
fun HillshadeLayer(layerId: String, sourceId: String)

Types

Companion
Link copied to clipboard
object Companion

Static variables and methods.

Functions

bindTo
Link copied to clipboard
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
Link copied to clipboard
open override fun hillshadeAccentColor(hillshadeAccentColor: Expression): HillshadeLayer
open override fun hillshadeAccentColor(@ColorInt hillshadeAccentColor: Int): HillshadeLayer
open override fun hillshadeAccentColor(hillshadeAccentColor: String): HillshadeLayer

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

hillshadeAccentColorTransition
Link copied to clipboard
open override fun hillshadeAccentColorTransition(options: StyleTransition): HillshadeLayer

Set the HillshadeAccentColor property transition options

open override fun hillshadeAccentColorTransition(block: StyleTransition.Builder.() -> Unit): HillshadeLayer
hillshadeExaggeration
Link copied to clipboard
open override fun hillshadeExaggeration(hillshadeExaggeration: Expression): HillshadeLayer
open override fun hillshadeExaggeration(hillshadeExaggeration: Double): HillshadeLayer

Intensity of the hillshade

hillshadeExaggerationTransition
Link copied to clipboard
open override fun hillshadeExaggerationTransition(options: StyleTransition): HillshadeLayer

Set the HillshadeExaggeration property transition options

open override fun hillshadeExaggerationTransition(block: StyleTransition.Builder.() -> Unit): HillshadeLayer
hillshadeHighlightColor
Link copied to clipboard
open override fun hillshadeHighlightColor(hillshadeHighlightColor: Expression): HillshadeLayer
open override fun hillshadeHighlightColor(@ColorInt hillshadeHighlightColor: Int): HillshadeLayer
open override fun hillshadeHighlightColor(hillshadeHighlightColor: String): HillshadeLayer

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

hillshadeHighlightColorTransition
Link copied to clipboard
open override fun hillshadeHighlightColorTransition(options: StyleTransition): HillshadeLayer

Set the HillshadeHighlightColor property transition options

open override fun hillshadeHighlightColorTransition(block: StyleTransition.Builder.() -> Unit): HillshadeLayer
hillshadeIlluminationAnchor
Link copied to clipboard
open override fun hillshadeIlluminationAnchor(hillshadeIlluminationAnchor: Expression): HillshadeLayer
open override fun hillshadeIlluminationAnchor(hillshadeIlluminationAnchor: HillshadeIlluminationAnchor): HillshadeLayer

Direction of light source when map is rotated.

hillshadeIlluminationDirection
Link copied to clipboard
open override fun hillshadeIlluminationDirection(hillshadeIlluminationDirection: Expression): HillshadeLayer
open override fun hillshadeIlluminationDirection(hillshadeIlluminationDirection: Double): HillshadeLayer

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.

hillshadeShadowColor
Link copied to clipboard
open override fun hillshadeShadowColor(hillshadeShadowColor: Expression): HillshadeLayer
open override fun hillshadeShadowColor(@ColorInt hillshadeShadowColor: Int): HillshadeLayer
open override fun hillshadeShadowColor(hillshadeShadowColor: String): HillshadeLayer

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

hillshadeShadowColorTransition
Link copied to clipboard
open override fun hillshadeShadowColorTransition(options: StyleTransition): HillshadeLayer

Set the HillshadeShadowColor property transition options

open override fun hillshadeShadowColorTransition(block: StyleTransition.Builder.() -> Unit): HillshadeLayer
maxZoom
Link copied to clipboard
open override fun maxZoom(maxZoom: Double): HillshadeLayer

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

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

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

sourceLayer
Link copied to clipboard
open override fun sourceLayer(sourceLayer: String): HillshadeLayer

A source layer is an individual layer of data within a vector source. A vector source can have multiple source layers.

visibility
Link copied to clipboard
open override fun visibility(visibility: Visibility): HillshadeLayer

Whether this layer is displayed.

Properties

hillshadeAccentColor
Link copied to clipboard
val hillshadeAccentColor: String?

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

hillshadeAccentColorAsColorInt
Link copied to clipboard
val hillshadeAccentColorAsColorInt: Int?

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

hillshadeAccentColorAsExpression
Link copied to clipboard
val hillshadeAccentColorAsExpression: Expression?

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

hillshadeAccentColorTransition
Link copied to clipboard
val hillshadeAccentColorTransition: StyleTransition?

Transition options for HillshadeAccentColor.

hillshadeExaggeration
Link copied to clipboard
val hillshadeExaggeration: Double?

Intensity of the hillshade

hillshadeExaggerationAsExpression
Link copied to clipboard
val hillshadeExaggerationAsExpression: Expression?

Intensity of the hillshade

hillshadeExaggerationTransition
Link copied to clipboard
val hillshadeExaggerationTransition: StyleTransition?

Transition options for HillshadeExaggeration.

hillshadeHighlightColor
Link copied to clipboard
val hillshadeHighlightColor: String?

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

hillshadeHighlightColorAsColorInt
Link copied to clipboard
val hillshadeHighlightColorAsColorInt: Int?

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

hillshadeHighlightColorAsExpression
Link copied to clipboard
val hillshadeHighlightColorAsExpression: Expression?

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

hillshadeHighlightColorTransition
Link copied to clipboard
val hillshadeHighlightColorTransition: StyleTransition?

Transition options for HillshadeHighlightColor.

hillshadeIlluminationAnchor
Link copied to clipboard

Direction of light source when map is rotated.

hillshadeIlluminationAnchorAsExpression
Link copied to clipboard
val hillshadeIlluminationAnchorAsExpression: Expression?

Direction of light source when map is rotated.

hillshadeIlluminationDirection
Link copied to clipboard
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.

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.

hillshadeShadowColor
Link copied to clipboard
val hillshadeShadowColor: String?

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

hillshadeShadowColorAsColorInt
Link copied to clipboard
val hillshadeShadowColorAsColorInt: Int?

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

hillshadeShadowColorAsExpression
Link copied to clipboard
val hillshadeShadowColorAsExpression: Expression?

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

hillshadeShadowColorTransition
Link copied to clipboard
val hillshadeShadowColorTransition: StyleTransition?

Transition options for HillshadeShadowColor.

layerId
Link copied to clipboard
open override val layerId: String
maxZoom
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.

minZoom
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.

sourceId
Link copied to clipboard
val sourceId: String
sourceLayer
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.

visibility
Link copied to clipboard
open override val visibility: Visibility?

Whether this layer is displayed.