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

Parameters

layerId

the ID of the layer

sourceId

the ID of the source

Constructors

HillshadeLayer
Link copied to clipboard

the ID of the layer

fun HillshadeLayer(layerId: String, sourceId: String)

Types

Companion
Link copied to clipboard

Static variables and methods.

object Companion

Functions

bindTo
Link copied to clipboard

Bind the layer to the Style.

override fun bindTo(delegate: StyleInterface)

Bind the layer to the map controller.

open override fun bindTo(delegate: StyleInterface, position: LayerPosition?)
equals
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
getCachedLayerProperties
Link copied to clipboard
override fun getCachedLayerProperties(): Value
hashCode
Link copied to clipboard
open override fun hashCode(): Int
hillshadeAccentColor
Link copied to clipboard

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

Set the HillshadeAccentColor property transition options

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

Set the HillshadeExaggeration property

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

Set the HillshadeExaggeration property transition options

open override fun hillshadeExaggerationTransition(options: StyleTransition): HillshadeLayer
open override fun hillshadeExaggerationTransition(block: StyleTransition.Builder.() -> Unit): HillshadeLayer
hillshadeHighlightColor
Link copied to clipboard

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

Set the HillshadeHighlightColor property transition options

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

Set the HillshadeIlluminationAnchor property

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

Set the HillshadeIlluminationDirection property

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

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

Set the HillshadeShadowColor property transition options

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

Set the maxzoom property

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

Set the minzoom property

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

Set the sourceLayer property

open override fun sourceLayer(sourceLayer: String): HillshadeLayer
toString
Link copied to clipboard
open override fun toString(): String
updateProperty
Link copied to clipboard
override fun updateProperty(property: PropertyValue<*>)
visibility
Link copied to clipboard

Set the Visibility property

open override fun visibility(visibility: Visibility): HillshadeLayer

Properties

hillshadeAccentColor
Link copied to clipboard

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

val hillshadeAccentColor: String?
hillshadeAccentColorAsColorInt
Link copied to clipboard

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

val hillshadeAccentColorAsColorInt: Int?
hillshadeAccentColorAsExpression
Link copied to clipboard

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

Transition options for HillshadeAccentColor.

val hillshadeAccentColorTransition: StyleTransition?
hillshadeExaggeration
Link copied to clipboard

Intensity of the hillshade

val hillshadeExaggeration: Double?
hillshadeExaggerationAsExpression
Link copied to clipboard

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

Intensity of the hillshade

val hillshadeExaggerationAsExpression: Expression?
hillshadeExaggerationTransition
Link copied to clipboard

Transition options for HillshadeExaggeration.

val hillshadeExaggerationTransition: StyleTransition?
hillshadeHighlightColor
Link copied to clipboard

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

val hillshadeHighlightColor: String?
hillshadeHighlightColorAsColorInt
Link copied to clipboard

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

val hillshadeHighlightColorAsColorInt: Int?
hillshadeHighlightColorAsExpression
Link copied to clipboard

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

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

val hillshadeHighlightColorAsExpression: Expression?
hillshadeHighlightColorTransition
Link copied to clipboard

Transition options for HillshadeHighlightColor.

val hillshadeHighlightColorTransition: StyleTransition?
hillshadeIlluminationAnchor
Link copied to clipboard

Direction of light source when map is rotated.

hillshadeIlluminationAnchorAsExpression
Link copied to clipboard

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

Direction of light source when map is rotated.

val hillshadeIlluminationAnchorAsExpression: Expression?
hillshadeIlluminationDirection
Link copied to clipboard

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?

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

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

val hillshadeShadowColor: String?
hillshadeShadowColorAsColorInt
Link copied to clipboard

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

val hillshadeShadowColorAsColorInt: Int?
hillshadeShadowColorAsExpression
Link copied to clipboard

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

Transition options for HillshadeShadowColor.

val hillshadeShadowColorTransition: StyleTransition?
layerId
Link copied to clipboard

the ID of the layer

open override val layerId: String
layerProperties
Link copied to clipboard

Properties of this layer.

override val layerProperties: HashMap<String, PropertyValue<*>>
maxZoom
Link copied to clipboard

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

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

the ID of the source

val sourceId: String
sourceLayer
Link copied to clipboard

Source layer.

val sourceLayer: String?
visibility
Link copied to clipboard

Visibility of the layer.

open override val visibility: Visibility?