utils | References | ArcGIS Maps SDK for JavaScript

import { getSupportedRendererInfo, getDefaultBandCombination } from "@arcgis/core/smartMapping/raster/support/utils.js";

const { getSupportedRendererInfo, getDefaultBandCombination } = await $arcgis.import("@arcgis/core/smartMapping/raster/support/utils.js");

Since: ArcGIS Maps SDK for JavaScript 4.20

This object contains utility methods for obtaining information about supported renderers of raster layers (i.e. ImageryLayer, ImageryTileLayer, or WCSLayer).

Type definitions

SmartMappingRasterRendererType

Type definition

Supported renderer types for imagery layers.

Type: "raster-stretch" | "raster-unique-value" | "raster-rgb" | "raster-class-breaks" | "raster-colormap" | "raster-shaded-relief" | "raster-vector-field" | "raster-flow"

SupportedRasterRendererInfo

Type definition

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

supportedTypes

Property

Type: SmartMappingRasterRendererType[]

A list of supported renderer types that may be applied to the input layer.

defaultRenderer

Property

Type: RasterRendererUnion

The default renderer of the input layer.

Functions

getSupportedRendererInfo

Function

Returns supported raster renderer information of an imagery layer.

Signature: getSupportedRendererInfo (parameters: RasterRendererParameters): Promise<SupportedRasterRendererInfo>

Parameters

Parameter	Type	Description	Required
parameters	RasterRendererParameters	Input parameters for getting supported renderer info about a raster layer.

Returns: Promise<SupportedRasterRendererInfo>
Resolves to an object containing information about the default renderer and other supported renderer types.

getDefaultBandCombination

Function

Returns default band ids used by a multispectral imagery layer when using a raster rgb or stretch renderer.

Signature: getDefaultBandCombination (parameters: RasterRendererParameters): Promise<[ number ] | [ number, number, number ] | null | undefined>

Parameters

Parameter	Type	Description	Required
parameters	RasterRendererParameters	Input parameters for getting default band ids about a raster layer.

Returns: Promise<[ number ] | [ number, number, number ] | null | undefined>
Resolves to an array containing a list of default band ids.