require(["esri/smartMapping/raster/support/utils"], (rasterRendererUtils) => { /* code goes here */ });
import * as rasterRendererUtils from "@arcgis/core/smartMapping/raster/support/utils.js";
esri/smartMapping/raster/support/utils
This object contains utility methods for obtaining information about supported renderers of raster layers (i.e. ImageryLayer, ImageryTileLayer, or WCSLayer).
Method Overview
| Name | Return Type | Summary | Object |
|---|---|---|---|
| Promise<number[]> | Returns default band ids used by a multispectral imagery layer when using a raster rgb or stretch renderer. more details | utils | |
| Promise<SupportedRendererInfo> | Returns supported raster renderer information of an imagery layer. more details | utils |
Method Details
-
Returns default band ids used by a multispectral imagery layer when using a raster rgb or stretch renderer.
ParametersSpecificationparams ObjectInput parameters for getting default band ids about a raster layer. See the table below for details of each parameter.
SpecificationLayer for which the default band ids are returned.
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.signal AbortSignaloptionalAllows for cancelable requests. If canceled, the promise will be rejected with an error named
AbortError. See also AbortController.ReturnsType Description Promise<number[]> Resolves to an array containing a list of default band ids.
-
getSupportedRendererInfo(params){Promise<SupportedRendererInfo>}
-
Returns supported raster renderer information of an imagery layer.
ParametersSpecificationparams ObjectInput parameters for getting supported renderer info about a raster layer. See the table below for details of each parameter.
SpecificationThe input layer for which the renderer info is returned.
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.signal AbortSignaloptionalAllows for cancelable requests. If canceled, the promise will be rejected with an error named
AbortError. See also AbortController.ReturnsType Description Promise<SupportedRendererInfo> Resolves to an object containing information about the default renderer and other supported renderer types.
Type Definitions
-
SupportedRendererInfo
-
The result object of the getSupportedRendererInfo() method. See the table below for details of each property.
- Properties
-
The default renderer of the input layer.
supportedTypes SupportedRendererType[]A list of supported renderer types that may be applied to the input layer.
-
SupportedRendererType String
-
Supported renderer types for imagery layers.
Possible Values:"raster-stretch"|"raster-unique-value"|"raster-rgb"|"raster-class-breaks"|"raster-colormap"|"raster-shaded-relief"|"raster-vector-field"|"raster-flow"