mapbox-maps-android/com.mapbox.maps.extension.style.layers.generated/HillshadeLayer

HillshadeLayer

@UiThread
class HillshadeLayer(val layerId: String, val 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

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

Types

Link copied to clipboard
object Companion

Static variables and methods.

Functions

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

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. Default value: "#000000".

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

DSL for hillshadeAccentColorTransition.

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

Controls the intensity of light emitted on the source features. Default value: 0. Minimum value: 0.

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

Set the HillshadeEmissiveStrength property transition options

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

DSL for hillshadeEmissiveStrengthTransition.

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

Intensity of the hillshade Default value: 0.5. Value range: 0, 1

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

DSL for hillshadeExaggerationTransition.

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. Default value: "#FFFFFF".

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

DSL for hillshadeHighlightColorTransition.

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. Default value: "viewport".

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 and no 3d lights enabled. If hillshade-illumination-anchor is set to map and 3d lights enabled, the direction from 3d lights is used instead. Default value: 335. Value range: 0, 359

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. Default value: "#000000".

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

DSL for hillshadeShadowColorTransition.

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.

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.

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

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.

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.

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

Whether this layer is displayed.

Properties

Link copied to clipboard
val hillshadeAccentColor: String?

The shading color used to accentuate rugged terrain like sharp cliffs and gorges. Default value: "#000000".

Link copied to clipboard
@get:ColorInt
val hillshadeAccentColorAsColorInt: Int?

The shading color used to accentuate rugged terrain like sharp cliffs and gorges. Default value: "#000000".

Link copied to clipboard
val hillshadeAccentColorAsExpression: Expression?

The shading color used to accentuate rugged terrain like sharp cliffs and gorges. Default value: "#000000".

Link copied to clipboard
val hillshadeAccentColorTransition: StyleTransition?

Transition options for HillshadeAccentColor.

Link copied to clipboard
val hillshadeEmissiveStrength: Double?

Controls the intensity of light emitted on the source features. Default value: 0. Minimum value: 0.

Link copied to clipboard
val hillshadeEmissiveStrengthAsExpression: Expression?

Controls the intensity of light emitted on the source features. Default value: 0. Minimum value: 0.

Link copied to clipboard
val hillshadeEmissiveStrengthTransition: StyleTransition?

Transition options for HillshadeEmissiveStrength.

Link copied to clipboard
val hillshadeExaggeration: Double?

Intensity of the hillshade Default value: 0.5. Value range: 0, 1

Link copied to clipboard
val hillshadeExaggerationAsExpression: Expression?

Intensity of the hillshade Default value: 0.5. Value range: 0, 1

Link copied to clipboard
val hillshadeExaggerationTransition: StyleTransition?

Transition options for HillshadeExaggeration.

Link copied to clipboard
val hillshadeHighlightColor: String?

The shading color of areas that faces towards the light source. Default value: "#FFFFFF".

Link copied to clipboard
@get:ColorInt
val hillshadeHighlightColorAsColorInt: Int?

The shading color of areas that faces towards the light source. Default value: "#FFFFFF".

Link copied to clipboard
val hillshadeHighlightColorAsExpression: Expression?

The shading color of areas that faces towards the light source. Default value: "#FFFFFF".

Link copied to clipboard
val hillshadeHighlightColorTransition: StyleTransition?

Transition options for HillshadeHighlightColor.

Link copied to clipboard
val hillshadeIlluminationAnchor: HillshadeIlluminationAnchor?

Direction of light source when map is rotated. Default value: "viewport".

Link copied to clipboard
val hillshadeIlluminationAnchorAsExpression: Expression?

Direction of light source when map is rotated. Default value: "viewport".

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 and no 3d lights enabled. If hillshade-illumination-anchor is set to map and 3d lights enabled, the direction from 3d lights is used instead. Default value: 335. Value range: 0, 359

val hillshadeIlluminationDirectionAsExpression: Expression?

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 and no 3d lights enabled. If hillshade-illumination-anchor is set to map and 3d lights enabled, the direction from 3d lights is used instead. Default value: 335. Value range: 0, 359

Link copied to clipboard
val hillshadeShadowColor: String?

The shading color of areas that face away from the light source. Default value: "#000000".

Link copied to clipboard
@get:ColorInt
val hillshadeShadowColorAsColorInt: Int?

The shading color of areas that face away from the light source. Default value: "#000000".

Link copied to clipboard
val hillshadeShadowColorAsExpression: Expression?

The shading color of areas that face away from the light source. Default value: "#000000".

Link copied to clipboard
val hillshadeShadowColorTransition: StyleTransition?

Transition options for HillshadeShadowColor.

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

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.

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

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

Link copied to clipboard
open override val visibility: Visibility?

Whether this layer is displayed.

Link copied to clipboard
open override val visibilityAsExpression: Expression?

Whether this layer is displayed.

Extensions

Link copied to clipboard
fun Layer.isPersistent(): Boolean?

Get the persistent property as Boolean.