require(["esri/smartMapping/raster/renderers/shadedRelief"], (rasterShadedReliefCreator) => { /* code goes here */ });
import * as rasterShadedReliefCreator from "@arcgis/core/smartMapping/raster/renderers/shadedRelief.js";
esri/smartMapping/raster/renderers/shadedRelief
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> | Generates a RasterShadedReliefRenderer to render elevation data. | shadedRelief |
Method Details
-
createRenderer
MethodcreateRenderer(params){Promise<RasterShadedReliefResult>} -
Generates a RasterShadedReliefRenderer to render elevation data.
ParametersSpecificationparams ObjectInput parameters for generating a shaded relief visualization. See the table below for details of each parameter.
Specificationlayer ImageryLayer|ImageryTileLayerThe input layer for which the renderer is generated.
renderingRule RasterFunctionoptionalDeprecated since 4.27. Use
rasterFunctioninstead.rasterFunction RasterFunctionoptionalSpecifies the function for how the requested image should be processed. When
rasterFunctionis applied, the server returns updated service information that reflects custom processing as defined by the raster function. If not provided, the output renderer is created using the layer'srasterFunction.hillshadeType StringoptionalThe preferred hillshade type. See RasterShadedReliefRenderer.hillshadeType for more information.
Possible Values:"traditional"|"multi-directional"
scalingType StringoptionalDefault Value: noneApplies 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"
colorRamp AlgorithmicColorRamp|MultipartColorRampoptionalThe color ramp to apply to the renderer. By default, the color ramp is grayscale.
signal AbortSignaloptionalAllows for cancelable requests. If canceled, the promise will be rejected with an error named
AbortError. See also AbortController.ReturnsType Description Promise<RasterShadedReliefResult> Resolves with an object containing a RasterShadedReliefRenderer that can be set on the input renderer.
Type Definitions
-
The result object of the createRenderer() method. See the table below for details of each property.
- Property
-
renderer RasterShadedReliefRenderer
The RasterShadedReliefRenderer renderer to apply to the input layer.