shadedRelief

AMD: require(["esri/smartMapping/raster/renderers/shadedRelief"], (rasterShadedReliefCreator) => { /* code goes here */ });
ESM: import * as rasterShadedReliefCreator from "@arcgis/core/smartMapping/raster/renderers/shadedRelief";
Object: esri/smartMapping/raster/renderers/shadedRelief
Since: ArcGIS API 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.

Method Overview

Name Return Type Summary Object
Promise<RasterShadedReliefResult>more details

Generates a RasterShadedReliefRenderer to render elevation data.

more detailsshadedRelief

Method Details

createRenderer(params){Promise<RasterShadedReliefResult>}

Generates a RasterShadedReliefRenderer to render elevation data.

Parameters:
Specification:
params Object

Input parameters for generating a shaded relief visualization. See the table below for details of each parameter.

Specification:

The input layer for which the renderer is generated.

renderingRule RasterFunction
optional

Specifies the rule for how the requested image should be rendered. When renderingRule is applied, the server returns updated service information that reflects custom processing as defined by the rendering rule. If not provided, the output renderer is created using the layer's renderingRule.

hillshadeType String
optional

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

Possible Values:"traditional"|"multi-directional"

scalingType String
optional
Default Value: none

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.

Possible Values:"none"|"adjusted"

optional

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

signal AbortSignal
optional

Allows for cancelable requests. If canceled, the promise will be rejected with an error named AbortError. See also AbortController.

Returns:
Type Description
Promise<RasterShadedReliefResult> Resolves with an object containing a RasterShadedReliefRenderer that can be set on the input renderer.

Type Definitions

RasterShadedReliefResult

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

Property:

The RasterShadedReliefRenderer renderer to apply to the input layer.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.