imageService

AMD: require(["esri/rest/imageService"], (imageService) => { /* code goes here */ });
ESM: import * as imageService from "@arcgis/core/rest/imageService";
Object: esri/rest/imageService
Since: ArcGIS API for JavaScript 4.19

Performs various operations on an image service resource:

Identify the content of an image service for the input location and mosaic rule. Compute histograms based on the provided ImageHistogramParameters. Compute statistics and histograms for the provided ImageHistogramParameters.

Method Overview

Name Return Type Summary Object
Promise<Object>more details

Computes histograms based on the provided ImageHistogramParameters.

more detailsimageService
Promise<Object>more details

Computes statistics and histograms for the provided ImageHistogramParameters.

more detailsimageService
Promise<Object>more details

Get samples from an image service based on the provided ImageSampleParameters.

more detailsimageService
Promise<ImageIdentifyResult>more details

Sends a request to the ArcGIS REST image service resource to identify content based on the ImageIdentifyParameters specified in the params argument.

more detailsimageService

Method Details

computeHistograms(parameters, options){Promise<Object>}

Computes histograms based on the provided ImageHistogramParameters. If a rendering rule and a mosaic rule are not specified, the current settings on the layer will be used. This operation is supported by an image service published with a mosaic dataset or a raster dataset at ArcGIS Server 10.4 and later. The result of this operation contains histograms computed for the given extent.

Parameters:
Autocasts from Object

Specifies parameters for computing histograms.

options Object
optional

An object with the following properties.

Specification:
signal AbortSignal
optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns:
Type Description
Promise<Object> Resolves to an object containing histogram results. See the object specification table below for details.
Property Type Description
histograms[] RasterHistogram Result containing raster histograms.
computeStatisticsHistograms(parameters, options){Promise<Object>}

Computes statistics and histograms for the provided ImageHistogramParameters. If a rendering rule and a mosaic rule are not specified, the current settings on the layer will be used. This operation is supported by an image service published with a mosaic dataset or a raster dataset at ArcGIS Server 10.4 and later. The result of this operation contains both statistics and histograms computed for the given extent.

Parameters:
Autocasts from Object

Specifies parameters for computing statistics and histograms.

options Object
optional

An object with the following properties.

Specification:
signal AbortSignal
optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns:
Type Description
Promise<Object> Resolves to an object containing histogram and statistics results. See the object specification table below for details.
Property Type Description
histograms[] RasterHistogram Result containing raster histograms.
bandStatistics[] RasterBandStatistics Raster band statistics.
getSamples(parameters, options){Promise<Object>}
Since: ArcGIS API for JavaScript 4.20

Get samples from an image service based on the provided ImageSampleParameters.

Parameters:
Autocasts from Object

Specifies parameters for computing histograms.

options Object
optional

An object with the following properties.

Specification:
signal AbortSignal
optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns:
Type Description
Promise<Object> Resolves to an object containing sample results. See the object specification table below for details.
Property Type Description
identify(params, requestOptions){Promise<ImageIdentifyResult>}

Sends a request to the ArcGIS REST image service resource to identify content based on the ImageIdentifyParameters specified in the params argument.

Parameters:

Specifies the criteria used to identify the features.

requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
Type Description
Promise<ImageIdentifyResult> When resolved, returns an instance of ImageIdentifyResult.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.