Skip to content
import { createRenderer } from "@arcgis/core/smartMapping/raster/renderers/shadedRelief.js";
Since
ArcGIS Maps SDK for JavaScript 4.20

This object contains helper methods for generating a RasterShadedReliefRenderer to render elevation values in raster layers (i.e. ImageryLayer, ImageryTileLayer).

The createRenderer() method in this module generates a renderer that may be applied directly to the input layer.

Type definitions

RasterShadedReliefParameters

Type definition

hillshadeType

Property
Type
RasterShadedReliefRenderer["hillshadeType"] | undefined

The preferred hillshade type. See RasterShadedReliefRenderer.hillshadeType for more information.

scalingType

Property
Type
RasterShadedReliefRenderer["scalingType"] | undefined

Applies a constant or adjusted z-factor based on resolution changes. The shaded result is scaled dynamically by adjusting the z-factor using one of two options. See RasterShadedReliefRenderer.hillshadeType for more information.

Default value
none

colorRamp

Property
Type
AlgorithmicColorRamp | MultipartColorRamp | undefined

The color ramp to apply to the renderer. By default, the color ramp is grayscale.

RasterShadedReliefResult

Type definition

The result object of the createRenderer() method. See the table below for details of each property.

renderer

Property
Type
RasterShadedReliefRenderer

The RasterShadedReliefRenderer renderer to apply to the input layer.

Functions

createRenderer

Function

Generates a RasterShadedReliefRenderer to render elevation data.

Signature
createRenderer (parameters: RasterShadedReliefParameters): Promise<RasterShadedReliefResult>
Parameters
ParameterTypeDescriptionRequired
parameters

Input parameters for generating a shaded relief visualization.

Returns
Promise<RasterShadedReliefResult>

Resolves with an object containing a RasterShadedReliefRenderer that can be set on the input renderer.