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 Maps SDK 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<ImageAngleResult>

Computes the rotation angle of a ImageryLayer at a given location.

more details
imageService
Promise<object>

Computes histograms based on the provided ImageHistogramParameters.

more details
imageService
Promise<ImagePixelLocationResult>

Computes the corresponding pixel location in columns and rows for an ImageryLayer based on input geometry.

more details
imageService
Promise<object>

Computes statistics and histograms for the provided ImageHistogramParameters.

more details
imageService
Promise<ImageSampleResult>

Returns sample point locations, pixel values and corresponding resolutions of the source data for a given geometry.

more details
imageService
Promise<ImageIdentifyResult>

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

more details
imageService

Method Details

computeAngles(url, parameters, requestOptions){Promise<ImageAngleResult>}
Since: ArcGIS Maps SDK for JavaScript 4.22
beta

Computes the rotation angle of a ImageryLayer at a given location. This operation is supported at 10.9.1 and later.

Parameters
url String

URL to the ArcGIS Server REST resource that represents an image service.

Autocasts from Object

Specifies parameters for computing angles.

requestOptions Object
optional

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

Returns
Type Description
Promise<ImageAngleResult> When resolved, returns an instance of ImageAngleResult containing computed north and up angles.
See also
computeHistograms(url, parameters, requestOptions){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
url String

URL to the ArcGIS Server REST resource that represents an image service.

Autocasts from Object

Specifies parameters for computing histograms.

requestOptions Object
optional

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

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.
computePixelSpaceLocations(url, parameters, requestOptions){Promise<ImagePixelLocationResult>}
Since: ArcGIS Maps SDK for JavaScript 4.22

Computes the corresponding pixel location in columns and rows for an ImageryLayer based on input geometry. Requires that the raster catalog item has a valid icsToPixel resource.

Parameters
url String

URL to the ArcGIS Server REST resource that represents an image service.

Specifies parameters for computing image space pixel location.

requestOptions Object
optional

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

Returns
Type Description
Promise<ImagePixelLocationResult> When resolved, returns an instance of ImagePixelLocationResult containing x and y values for the column and row of each input geometry.
See also
computeStatisticsHistograms(url, parameters, requestOptions){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
url String

URL to the ArcGIS Server REST resource that represents an image service.

Autocasts from Object

Specifies parameters for computing statistics and histograms.

requestOptions Object
optional

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

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(url, parameters, requestOptions){Promise<ImageSampleResult>}
Since: ArcGIS Maps SDK for JavaScript 4.23

Returns sample point locations, pixel values and corresponding resolutions of the source data for a given geometry. When the input geometry is a polyline, extent, or polygon, the sampling is based on sampleCount or sampleDistance parameters. When the geometry is a point or multipoint, the point or points are used directly.

The number of sample locations in the response is based on the sampleDistance or sampleCount parameter and cannot exceed the limit imposed by the image service. The sample points are located at the intersection of the provided geometry and the raster item's footprints. They are also filtered by the mosaicRule and pixelSize parameters.

Parameters
url String

URL to the ArcGIS Server REST resource that represents an image service.

Autocasts from Object

The parameters used in the getSamples operation.

requestOptions Object
optional

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

Returns
Type Description
Promise<ImageSampleResult> When resolved, ImageSampleResult is returned containing an array of ImageSamples.
Example
// get all sample points along a polyline
// at the specified sample distance and pixel size
const param = {
  geometry: polyline
  returnFirstValueOnly: false,
  // resolution - unit of the view's spatial reference
  pixelSize: {
    x:12,
    y:12,
    spatialReference: view.spatialReference
  },
  interpolation: "nearest",
  // unit of the geometry's spatial reference is used
  sampleDistance: 30,
  outFields: ["*"]
};
imageService.getSamples(url, param).then((results) => {
  // use the getSamples results as needed.
  console.log(results);
})
.catch(function(error){
  console.log(error)
})
identify(url, 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
url String

URL to the ArcGIS Server REST resource that represents an image service.

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.