types | References | ArcGIS Maps SDK for JavaScript

Types

import type { RasterInterpolation, BandValuesArray, RasterPixelType, RasterCommonPixelType, RasterFormats } from "@arcgis/core/layers/raster/types.js";

Type definitions

RasterInterpolation

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Specifies how raster values are resampled.

See also

FetchRasterOptions

Type: "nearest" | "bilinear" | "cubic" | "majority"

BandValuesArray

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Defines numeric arrays that can represent raster pixel values.

See also

PixelBlock.pixels

Type: Int8Array<ArrayBuffer> | Uint8Array<ArrayBuffer> | Uint8ClampedArray<ArrayBuffer> | Int16Array<ArrayBuffer> | Uint16Array<ArrayBuffer> | Int32Array<ArrayBuffer> | Uint32Array<ArrayBuffer> | Float32Array<ArrayBuffer> | Float64Array<ArrayBuffer> | number[]

RasterPixelType

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The pixel type.

See also

PixelBlock.pixelType

Type: "unknown" | "u1" | "u2" | "u4" | "u8" | "s8" | "u16" | "s16" | "u32" | "s32" | "f32" | "f64" | "c64" | "c128"

RasterCommonPixelType

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The common output pixel type.

Type: "unknown" | "u8" | "s8" | "u16" | "s16" | "u32" | "s32" | "f32" | "f64"

RasterFormats

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Lists supported output formats for imagery export and requests.

See also

ImageryLayer.format

Type: "lerc" | "jpg" | "jpgpng" | "png" | "png8" | "png24" | "png32" | "bip" | "bsq" | "tiff" | "bmp" | "gif"

RasterNoDataInterpretation

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Specifies how NoData values are interpreted across multiple bands.

See also

ImageryLayer.noDataInterpretation

Type: "any" | "all"

RasterDataType

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Identifies the category of raster data returned by an imagery source.

See also

RasterInfo.dataType

Type: "generic" | "elevation" | "thematic" | "processed" | "scientific" | "standard-time" | "vector-uv" | "vector-u" | "vector-v" | "vector-magdir" | "vector-magnitude" | "vector-direction"

PixelSize

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Describes pixel size along the x and y axes.

See also

RasterInfo.pixelSize

x

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

Pixel size along the x axis.

y

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

Pixel size along the y axis.

RasterSliceValue

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.25

Data series returned in RasterIdentifyResult when ImageryTileLayer.identify() is called on a transposed multidimensional ImageryTileLayer.

value

Property

Type: number[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Image service pixel values for a given slice.

multidimensionalDefinition

Property

Type: DimensionalDefinition[]

Since: ArcGIS Maps SDK for JavaScript 5.0

A dimensional definition associated with a given slice.

magdirValue

Property

Type: [ number, number ] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The magnitude and direction values for services containing vector data.

RasterIdentifyResult

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The result of identify operation on ImageryTileLayer.identify() and WCSLayer.identify(). It includes the processed pixel values for a given location.

location

Property

Type: Point

Since: ArcGIS Maps SDK for JavaScript 5.0

The identified location.

value

Property

Type: number[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Image service pixel values.

processedValue

Property

Type: number[] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The processed pixel values showing results of the ImageryTileLayer.rasterFunction applied to the layer. Added since version 4.26.

dataSeries

Property

Type: RasterSliceValue[] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Transposed multidimensional data for the requested location and variable returned from a transposed multidimensional ImageryTileLayer.identify(). Added since version 4.25.

PixelData

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

An object that provides the user access to PixelBlock.pixels and their values in the layer. See the object specifications table below for details about each property. This object is used as input in the ImageryLayer.pixelFilter function for filtering and processing each pixel in the block.

See also

ArcGISImageService.fetchPixels()

extent

Property

Type: Extent

Since: ArcGIS Maps SDK for JavaScript 5.0

The extent of the pixelBlock.

pixelBlock

Property

Type: PixelBlock | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

An object representing the pixels in the view. This provides the user access to each pixel on the client via the pixels property of this object.

RasterBandStatistics

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.18

Raster statistics information returned that meets the specified ImageHistogramParameters from the computeStatisticsHistograms() method on ImageryLayer.computeStatisticsHistograms() or ImageryTileLayer.computeStatisticsHistograms().

min

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

Minimum value of the statistics.

max

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

Maximum value of the statistics.

avg

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Average of the statistics.

stddev

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Standard deviation of the statistics.

mode

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Mode value of the statistics.

median

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Median value of the statistics.

sum

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Sum of the statistics.

count

Property

Type: number | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Count of the statistics.

RasterHistogram

Type definition

Since: ArcGIS Maps SDK for JavaScript 4.18

Raster histogram information returned that meets the specified ImageHistogramParameters from the ImageryLayer.computeHistograms() or ImageryLayer.computeStatisticsHistograms() method.

size

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

Number of bins.

min

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The minimum pixel value of the histogram. Matches the minimum bound of the first bin.

max

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The maximum pixel value of the histogram. Matches the maximum bound of the last bin.

counts

Property

Type: number[] | Uint32Array

Since: ArcGIS Maps SDK for JavaScript 5.0

Count of pixels that fall into each bin.

RasterDimensionalInfo

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

A dimension may be used to represent real physical dimensions such as time or depth/height. It may also be used to represent more abstract quantities such as station id or station-time pair. For example, if your temperature data has a corresponding Date dimension field representing the day it was captured, and your salinity data has a Depth dimension field representing the depth at which it was measured, the Dimensions field for that variable would be Date and Depth.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

Dimension name.

description

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Dimension description.

unit

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Dimension unit.

values

Property

Type: (number | [ number, number ])[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

An array of single values or tuples [min, max] each defining a range of valid values along the specified dimension.

hasRanges

Property

Type: boolean | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates if each dimension value is represented using a range.

hasRegularIntervals

Property

Type: boolean | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates if the dimension is recorded at regular intervals.

interval

Property

Type: number | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Dimension interval.

intervalUnit

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Dimension interval unit.

extent

Property

Type: number[] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

The extent of dimension values.

recurring

Property

Type: boolean | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Indicates if the dimension is recurring, e.g. data with 12 slices each represents aggregated value per month over the years.

RasterMultidimensionalInfo

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

RasterMultidimensionalInfo contains dimensions for each variable in the service describing information about the images collected at multiple times, depths, or heights.

variables

Property

Type: RasterMultidimensionalInfoVariable[]

Since: ArcGIS Maps SDK for JavaScript 5.0

The multi dimensional variables. It stores information such as name, unit and dimensions. For example, a temperature variable can store temperature data and the salinity variable can store the salinity data measured daily at different depths.

Example

// update the statistics of the layer's stretch renderer.
const renderer = layer.renderer.clone();
 const dimensions = layer.rasterInfo.multidimensionalInfo;
// get the salinity variable's statistics
const salinity = dimensions.variables.find((variable) => variable.name === variableName);
renderer.customStatistics = salinity.statistics;
layer.renderer = renderer;

RasterMultidimensionalInfoVariable

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Describes a variable in multidimensional raster data.

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

Variable name.

dimensions

Property

Type: RasterDimensionalInfo[]

Since: ArcGIS Maps SDK for JavaScript 5.0

description

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Variable description.

histograms

Property

Type: RasterHistogram[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Variable histograms.

statistics

Property

Type: RasterBandStatistics[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Variable statistics.

unit

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Unit of the variable measured in.

ServiceRasterFunctionInfo

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

The raster function published with the image service.

See also

ArcGISImageService.rasterFunctionInfos

name

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

Name of the raster function.

description

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

Description of the raster function.

help

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

Additional info describing what the raster function does.

functionType

Property

Type: number

Since: ArcGIS Maps SDK for JavaScript 5.0

The function type. Possible values: //0 = Mosaic, 1 = Item, 2 = Item Group.

thumbnail

Property

Type: string

Since: ArcGIS Maps SDK for JavaScript 5.0

Inline base64 encoded thumbnail of the raster function.

FetchRasterOptions

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Options for fetching raster pixel data from imagery tile layers.

See also

Supertypes: AbortOptions

bandIds

Property

Type: number[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Returns pixel data only for the specified bands, if provided. Added at version 4.34.

interpolation

Property

Type: RasterInterpolation | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Added at version 4.23. Defines how to interpolate pixel values.

DynamicFetchRasterOptions

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Options for fetching raster pixel data from dynamic imagery services.

See also

ImageryLayer.fetchPixels()

Supertypes: AbortOptions

bandIds

Property

Type: number[] | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Returns pixel data only for the specified bands, if provided. Added at version 4.34.

interpolation

Property

Type: RasterInterpolation | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Defines how to interpolate pixel values.

applyRendering

Property

Type: boolean | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

When true, request a rendered image from server using layer's rendering configuration, including layer format (jpgpng or similar), renderer, bandIds, compression quality and interpolation setting.

RasterIdentifyOptions

Type definition

Since: ArcGIS Maps SDK for JavaScript 5.0

Additional options to set for identify() method on ImageryTileLayer.identify() and WCSLayer.identify().

At version 4.25, the transposedVariableName was added to get pixel values from specific dimensional definitions if the ImageryTileLayer references a transposed multidimensional image service. Set the transposedVariableName and multidimensionalDefinition get pixel values for the specified dimensional definitions from a transposed multidimensional service. If multidimensionalDefinition is not specified, pixel values will be returned from all the dimensional slices.

Supertypes: AbortOptions

multidimensionalDefinition

Property

Type: DimensionalDefinition[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

A dimensional definition used for the identify operation. For non-transposed multidimensional ImageryTileLayer.identify() and for WCSLayer.identify(), the identify operation returns a value for only one dimensional slice at a time. For transposed multidimensional ImageryTileLayer, identify returns values for all or specified dimensional slices.

transposedVariableName

Property

Type: string | undefined

Since: ArcGIS Maps SDK for JavaScript 5.0

Name of the transposed variable. This option is only honored if the ImageryTileLayer's serviceRasterInfo.hasMultidimensionalTranspose is true. Added since 4.25.