types | References | ArcGIS Maps SDK for JavaScript

Types

import type { RasterPrimaryArgument, RasterArgument, BaseRasterFunctionParameters, Base2RasterFunctionParameters, BaseNRasterFunctionParameters } from "@arcgis/core/layers/raster/functions/types.js";

Type definitions

RasterPrimaryArgument

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.28

Raster argument used to specify raster(s) used in raster processing.

Type: string | RasterFunction

RasterArgument

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.28

Raster argument used to specify raster(s) used in raster processing. When the input raster is the image service itself and if the raster function takes:

A single input raster: the raster parameter can be omitted.
Multiple input rasters: the image service raster needs to be represented using defaultRaster as ("$$").

When the input raster is the result of a another raster function processing:

Set the raster parameter to a result of a raster function.

When the raster function takes more than one input rasters:

One of the input (usually the first) must be either another raster function or an image service raster
Additional rasters can also be specified in the form of a scalar, e.g. 100. When the function is applied on a dynamic image service:
$RasterId (e.g. "$1") can be used to reference a raster by its objectId.

Type: number | RasterPrimaryArgument

BaseRasterFunctionParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.28

Input parameters for performing math operations on one input raster.

raster

Property

Type: RasterPrimaryArgument | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The input raster. Default is the image service.

outputPixelType

Property

Type: RasterCommonPixelType | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The output pixel type, default is unknown.

Default value: "unknown"

Base2RasterFunctionParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.28

Input parameters for perform math operations between two rasters.

raster

Property

Type: RasterArgument

Since: ArcGIS Maps SDK for JavaScript 5.0

The first raster (pre changes).

raster2

Property

Type: RasterArgument

Since: ArcGIS Maps SDK for JavaScript 5.0

The second raster (post changes).

outputPixelType

Property

Type: RasterCommonPixelType | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The output pixel type, default is unknown.

BaseNRasterFunctionParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

rasters

Property

Type: RasterArgument[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The input raster. Default is the image service.

outputPixelType

Property

Type: RasterCommonPixelType | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The output pixel type, default is unknown.

Default value: "unknown"

ConvolutionType

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: "user-defined" | "line-detection-horizontal" | "line-detection-vertical" | "line-detection-left-diagonal" | "line-detection-right-diagonal" | "gradient-north" | "gradient-west" | "gradient-east" | "gradient-south" | "gradient-north-east" | "gradient-north-west" | "smooth-arithmetic-mean" | "smoothing3x3" | "smoothing5x5" | "sharpening3x3" | "sharpening5x5" | "laplacian3x3" | "laplacian5x5" | "sobel-horizontal" | "sobel-vertical" | "sharpen" | "sharpen2" | "point-spread" | "none"

ConvolutionFunctionParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.28

Supertypes: BaseRasterFunctionParameters

convolutionType

Property

Type: Exclude<ConvolutionType, "user-defined">

Since: ArcGIS Maps SDK for JavaScript 5.0

The convolution type.

ConvolutionFunctionCustomParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.28

Supertypes: BaseRasterFunctionParameters

convolutionType

Property

Type: "user-defined" | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The convolution type must be "user-defined".

rows

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The number of rows, only needed for user-defined kernel.

cols

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The number of columns, only needed for user-defined kernel

kernel

Property

Type: number[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The kernel size of rows x columns arranged in row-major order.

ContrastBrightnessParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

contrastOffset

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

Contrast offset from -100 to 100.

brightnessOffset

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

Brightness offset from -100 to 100.

BaseStretchParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

dynamicRangeAdjustment

Property

Type: boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

When true, perform dynamic range adjustment (not supported on client side)

outputMin

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The minimum output value. Default is 0.

outputMax

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The maximum output value. Default is 255.

useGamma

Property

Type: boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

When true, gamma stretch is applied.

gamma

Property

Type: number[] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The gamma values used for each band, needed when useGamma is true.

MinMaxStretchParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseStretchParameters

statistics

Property

Type: RasterBandStatistics[] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The avg and stddev in each band's statistics is used along with numberOfStandardDeviations to calculate the cut off pixels values beling stretched. Default is the input data source's statistics.

StddevStretchParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: MinMaxStretchParameters

numberOfStandardDeviations

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Values with in the given number of standard deviations are stretched to [outputMin, outputMax], those fall outside are clamped.

PercentClipStretchParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseStretchParameters

minPercent

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Percentage of the lowest pixel values to be excluded.

maxPercent

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Percentage of the highest pixel values to be excluded.

NDVIBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

redBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based red band id.

scientificOutput

Property

Type: boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Output values are linearly scaled to 0 to 200 when scientificOutput is false. Default is true.

SAVIBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

redBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based red band id.

factor

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The amount of green vegetation cover from 0 to 1. Default is 0.33.

TSAVIBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

redBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based red band id.

slope

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The soil line slope. Default is 0.33.

intercept

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The soil line intercept. Default is 0.5.

factor

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The adjustment factor to minimize soil noise. Default is 1.5.

MSAVIBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

redBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based red band id.

GEMIBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

redBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based red band id.

PVIBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

redBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based red band id.

slope

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The soil line slope. Default is 0.3.

gradient

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The soil line gradient. Default is 0.5.

LandsatBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

bandIds

Property

Type: [ number, number, number, number, number, number ]

Since: ArcGIS Maps SDK for JavaScript 5.0

The bandIds array representing Landsat band 1, 2, 3, 4, 5, 7.

SultanParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

bandIds

Property

Type: [ number, number, number, number, number ]

Since: ArcGIS Maps SDK for JavaScript 5.0

The bandIds array representing band 1, 3, 4, 5, 6.

VARIBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

redBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based red band id.

greenBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based green band id.

blueBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based blue band id.

GDNVIBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

greenBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based green band id.

SRBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

redBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based red band id.

NDVIreBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

reBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based red edge band id.

SRreBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

reBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based red edge band id.

MTVI2BandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

redBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based red band id.

greenBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based green band id.

RTVICoreBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

reBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based red edge band id.

greenBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based green band id.

CIreBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

reBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based red edge band id.

CIgBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

greenBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based green band id.

NDWIBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

greenBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based green band id.

EVIBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

redBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based red band id.

blueBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based blue band id.

IronOxideBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

redBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based red band id.

blueBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based blue band id.

FerrousMineralsBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

swirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based shortwave infrared band id.

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

ClayMineralsBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

swir1BandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based shortwave infrared band id centering around 1.5—1.75µm.

swir2BandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based shortwave infrared band id centering around 2.08—2.35µm.

WNDWIBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

greenBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based green band id.

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

swirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based shortwave infrared band id.

alpha

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

A weighted coefficient ranging from 0 to 1. Default is 0.5.

BAIBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

redBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based red band id.

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

NBRBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

swirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based shortwave infrared band id.

NDBIBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

swirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based shortwave infrared band id.

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

NDMIBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

nirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based near infrared band id.

swirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based shortwave infrared band id.

NDSIBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

greenBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based green band id.

swirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based shortwave infrared band id.

MNDWIBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

greenBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based green band id.

swirBandId

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based shortwave infrared band id.

CustomBandParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

bandIndexes

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The custom band index, e.g. (b1 - b0) / (b1 + b0)

ChangeMethod

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Change methods for compute change raster function.

Type: "difference" | "relative-difference" | "categorical" | "euclidean-distance" | "angle-difference" | "band-with-most-change"

ChangeKeepMethod

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Change keep methods for compute change raster function.

Type: "all" | "changed" | "unchanged"

ComputeChangeParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: Base2RasterFunctionParameters

method

Property

Type: ChangeMethod

Since: ArcGIS Maps SDK for JavaScript 5.0

The method used to compute changes.

keepMethod

Property

Type: ChangeKeepMethod | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Choose what to keep for categorical changes.

GrayscaleParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

weights

Property

Type: number[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The weights applied to each input band. Weights are often applied because some bands have variable importance depending on the application.

ColorspaceConversionParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

conversionType

Property

Type: "rgb-to-hsv" | "hsv-to-rgb"

Since: ArcGIS Maps SDK for JavaScript 5.0

The conversion type.

SpectralConversionParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

conversionMatrix

Property

Type: number[] | number[][]

Since: ArcGIS Maps SDK for JavaScript 5.0

The matrix used to convert the input raster arranged in row-major order.

ColormapParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.28

Raster colormap input parameters specified using a colormap.

Supertypes: BaseRasterFunctionParameters

colormap

Property

Type: number[][] | PixelValueToColor[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The colormap.

PixelValueToColor

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.28

A pixel value to color mapping.

value

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

Pixel value.

color

Property

Type: number[] | string

Since: ArcGIS Maps SDK for JavaScript 5.0

Color represented using [r,g,b] or [r,g,b,a], or the color's name or hex string.

ColormapByNameParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.28

Raster colormap input parameters specified using colormap name.

Supertypes: BaseRasterFunctionParameters

colorRampName

Property

Type: RasterColorRampName | RasterColormapName

Since: ArcGIS Maps SDK for JavaScript 5.0

The name of a predefined colorramp or colormap.

ColormapByRampParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.28

Raster colormap input parameters specified using a colorramp.

Supertypes: BaseRasterFunctionParameters

colorRamp

Property

Type: AlgorithmicColorRamp | MultipartColorRamp

Since: ArcGIS Maps SDK for JavaScript 5.0

A colorramp

StatisticsHistogramParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

statistics

Property

Type: RasterBandStatistics[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The statistics parameter.

histograms

Property

Type: RasterHistogram[] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The histogram parameter.

TableParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

attributeTable

Property

Type: FeatureSet

Since: ArcGIS Maps SDK for JavaScript 5.0

The attribute table represented using a feature set.

ExtractBandByIdParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.28

Extract bands parameters specified using band ids.

Supertypes: BaseRasterFunctionParameters

bandIds

Property

Type: number[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The 0-based band ids.

missingBandAction

Property

Type: "fail" | "best-match" | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicate whether to use best possible matching band when the requested band is missing.

ExtractBandByNameParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.28

Extract bands parameters specified using band names.

Supertypes: BaseRasterFunctionParameters

bandNames

Property

Type: string[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The band names.

missingBandAction

Property

Type: "fail" | "best-match" | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicate whether to use best possible matching band when the requested band is missing.

ExtractBandByWavelengthParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.28

Extract bands parameters specified using band wavelengths.

Supertypes: BaseRasterFunctionParameters

bandWavelengths

Property

Type: number[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The band wavelengths.

missingBandAction

Property

Type: "fail" | "best-match" | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicate whether to use best possible matching band when the requested band is missing.

ColorCompositeByIdParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.32

Create color composite input parameters using band ids.

Supertypes: BaseRasterFunctionParameters

redBand

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

Red band id.

greenBand

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

Green band id.

blueBand

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

Blue band id.

method

Property

Type: "id"

Since: ArcGIS Maps SDK for JavaScript 5.0

The composition method.

ColorCompositeByNameParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.32

Create color composite input parameters using band names or expressions. The supported operators are unary: plus (+), minus (-), times (*), and divide (/). Using B1 for the first band of the input raster, B2 for the second band, and so on.

Supertypes: BaseRasterFunctionParameters

redBand

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

Red band name or expression, e.g. "B1"

greenBand

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

Green band name or expression, e.g. "B2"

blueBand

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

Blue band name or expression, e.g. "B1-B2"

method

Property

Type: "name"

Since: ArcGIS Maps SDK for JavaScript 5.0

The composition method.

RemapParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

rangeMaps

Property

Type: PixelValueRangeMap[] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Range maps.

allowUnmatched

Property

Type: boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

When true, unmatched pixel values are passed through or replaced with a constant. When false, unmatched pixel values are set to NoData.

replacementValue

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The value that will replace missing or unmatched values in the output when allowUnmatched is true.

PixelValueRangeMap

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.28

Range map pixel values.

range

Property

Type: [ number, number ]

Since: ArcGIS Maps SDK for JavaScript 5.0

The pixel value range.

output

Property

Type: number | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The mapped pixel value. Null or undefined will produce NoData as the output.

TransposeBitsParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

inputBitPositions

Property

Type: number[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The position of the input bits.

outputBitPositions

Property

Type: number[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The position of the output bits.

fillRaster

Property

Type: RasterArgument | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Specify a raster to be used to fill in all bits that are not involved in the transpose.

MaskParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

includedRanges

Property

Type: [ number, number ][] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The included values for each band. Each band is specified using a range [from, to].

noDataValues

Property

Type: number[][] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The nodata values for each band.

noDataInterpretation

Property

Type: "match-any" | "match-all" | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Result is no data if all bands are nodata when match-all is specified, any if any band is nodata when match-any is specified. Default is match-any.

ClipParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

geometry

Property

Type: Extent | Polygon

Since: ArcGIS Maps SDK for JavaScript 5.0

An extent or a polygon geometry to define the clip shape.

keepOutside

Property

Type: boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

When false, the imagery within the clip geometry will be kept in the output. When true, imagery outside of the clip geometry will be kept and the imagery inside the clip geometry will be discarded.

SetNullParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.28

SetNull parameters

Supertypes: BaseRasterFunctionParameters

raster

Property

Type: RasterPrimaryArgument

Since: ArcGIS Maps SDK for JavaScript 5.0

The input raster.

falseRaster

Property

Type: RasterArgument

Since: ArcGIS Maps SDK for JavaScript 5.0

The false raster.

ConditionalParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.28

Conditional parameters

Supertypes: BaseRasterFunctionParameters

raster

Property

Type: RasterPrimaryArgument

Since: ArcGIS Maps SDK for JavaScript 5.0

The input raster.

trueRaster

Property

Type: RasterArgument

Since: ArcGIS Maps SDK for JavaScript 5.0

The true raster.

falseRaster

Property

Type: RasterArgument

Since: ArcGIS Maps SDK for JavaScript 5.0

The false raster.

CellStatisticsType

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: "majority" | "max" | "mean" | "median" | "min" | "minority" | "range" | "stddev" | "sum" | "variety"

CellStatisticsParameters

Type definition

Supertypes: BaseNRasterFunctionParameters

statisticsType

Property

Type: CellStatisticsType

The true raster, if the first input is a raster.

processAsMultiband

Property

Type: boolean | undefined

When true, process the single input raster as multiple bands. Default is true.

CalculatorParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseNRasterFunctionParameters

inputNames

Property

Type: string[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The input names.

expression

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

The expression.

WeightedSumParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseNRasterFunctionParameters

weights

Property

Type: number[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The weight for each raster.

fields

Property

Type: string[] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The field used to perform the weighted sum. Default is Value.

WeightedOverlayParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseNRasterFunctionParameters

weights

Property

Type: number[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The relative weight for each raster. This will be normalized internally to make the total weight 100%.

minScale

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The minimum scale of the mapped output

maxScale

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The maximum scale of the mapped output.

valueToScaleMaps

Property

Type: number[][][] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The value to scale map for each input raster. Each raster's map is represented using an array of [fromValue, toScale].

noDataValues

Property

Type: number[][] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The nodata values for each input raster.

restrictedValues

Property

Type: number[][] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The restricted values for each input raster.

fields

Property

Type: string[] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The field used to perform the weighted sum. Default is Value.

FocalStatisticsType

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Type: "min" | "max" | "mean" | "stddev" | "median" | "majority" | "minority"

StatisticsParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

rows

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

Number of rows.

cols

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

Number of columns.

statisticsType

Property

Type: FocalStatisticsType

Since: ArcGIS Maps SDK for JavaScript 5.0

The statistics type

fillNoDataOnly

Property

Type: boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

When true only fills noData pixels

ArgStatisticsParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.32

Arg statistics input parameters for min, max, and median statistics type.

Supertypes: BaseNRasterFunctionParameters

undefinedClass

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

A constant value that will be used when no definitive maximum or minimum can be attained.

Default value: 100

statisticsType

Property

Type: "max" | "min" | "median"

Since: ArcGIS Maps SDK for JavaScript 5.0

The statistics type.

ArgStatisticsDurationParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.32

Arg statistics input parameters for duration statistics type.

Supertypes: BaseNRasterFunctionParameters

minValue

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The lowest value equal to or greater than the beginning of the duration.

maxValue

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The highest value equal to or less than the end of the duration.

statisticsType

Property

Type: "duration"

Since: ArcGIS Maps SDK for JavaScript 5.0

The statistics type.

RasterSlopeType

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Raster slope type.

Type: "degree" | "percent-rise" | "adjusted"

SlopeParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

slopeType

Property

Type: RasterSlopeType

Since: ArcGIS Maps SDK for JavaScript 5.0

The slope type.

zFactor

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The z factor.

pixelSizePower

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Used for adjusted slope type. It is the exponent applied to the pixel size term in the equation that controls the rate at which the Z Factor changes to avoid significant loss of relief.

pixelSizeZFactor

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Used for adjusted slope type. It controls the rate at which the Z Factor changes.

removeEdgeEffect

Property

Type: boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

When true, applies edge effect removal. This option is only supported on server side by ImageryLayer only.

RasterCurvatureType

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Raster curvature type.

Type: "standard" | "planform" | "profile"

CurvatureParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

curvatureType

Property

Type: RasterCurvatureType

Since: ArcGIS Maps SDK for JavaScript 5.0

The curvature type.

zFactor

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The z factor.

HillshadeParameters

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Supertypes: BaseRasterFunctionParameters

hillshadeType

Property

Type: "traditional" | "multi-directional"

Since: ArcGIS Maps SDK for JavaScript 5.0

The hillshade type.

zFactor

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The z factor.

altitude

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The altitude.

azimuth

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The azimuth.

scalingType

Property

Type: "none" | "adjusted" | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The scaling type.

pixelSizePower

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Used for adjusted scaling type. It is the exponent applied to the pixel size term in the equation that controls the rate at which the Z Factor changes to avoid significant loss of relief.