imageService | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Method Overview

Return Type	Summary	Object
Promise<ImageAngleResult>	Computes the rotation angle of a ImageryLayer at a given location.	imageService
Promise<Object>	Computes histograms based on the provided ImageHistogramParameters.	imageService
Promise<ImagePixelLocationResult>	Computes the corresponding pixel location in columns and rows for an ImageryLayer based on input geometry.	imageService
Promise<Object>	Computes statistics and histograms for the provided ImageHistogramParameters.	imageService
Promise<FindImagesResult>	Finds images based on the provided FindImagesParameters.	imageService
Promise<ImageUrlResult>	Retrieves an image's url using the provided ImageUrlParameters.	imageService
Promise<ImageSampleResult>	Returns sample point locations, pixel values and corresponding resolutions of the source data for a given geometry.	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.	imageService
Promise<Geometry>	Convert a geometry from an image space to a map space using the provided ImageToMapParameters.	imageService
Promise<Geometry>	Creates a map space geometry from multiray image space geometries using the provided ImageToMapMultirayParameters.	imageService
Promise<Geometry>	Converts a given geometry from a map space to an image space using the provided MapToImageParameters.	imageService
Promise<ImageAreaResult>	Calculates the area and perimeter of a given geometry on an image service.	imageService
Promise<MeasureAreaFromImageResult>	Measures the area and the perimeter of a polygon in an image space on a selected raster when the following conditions are met: * Image service must be published from a mosaic dataset.	imageService
Promise<ImageDistanceResult>	Calculates the distance and angle between two points on an image service.	imageService
Promise<ImageHeightResult>	Calculates the height of an object between two points on an image service.	imageService
Promise<MeasureLengthFromImageResult>	Measures the length of a polyline in an image space on a selected raster when the following conditions are met: * Image service must be published from a mosaic dataset.	imageService
Promise<ImagePointResult>	Returns the location for a given point or centroid of a given area on an image service.	imageService
Promise<ImageBoundaryResult>	Returns the boundary of an image for the provided ImageBoundaryParameters.	imageService
Promise<ImageGPSInfoResult>	Returns GPS information for the provided ImageGPSInfoParameters.	imageService

Method Details

computeAngles Method computeAngles(url, parameters, requestOptions){Promise<ImageAngleResult>} Since: ArcGIS Maps SDK for JavaScript 4.22 imageService since 4.19, computeAngles added at 4.22.

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.

parameters ImageAngleParameters autocast

Autocasts from Object

Specifies parameters for computing angles.

requestOptions Object

optional

Additional options to be used for the data request.

Returns

Type	Description
Promise<ImageAngleResult>	When resolved, returns an instance of ImageAngleResult containing computed north and up angles.

See also

ArcGIS REST API - Compute Angles

computeHistograms Method computeHistograms(url, parameters, requestOptions){Promise<Object>}

Computes histograms based on the provided ImageHistogramParameters. If a raster function 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.

parameters ImageHistogramParameters autocast

Autocasts from Object

Specifies parameters for computing histograms.

requestOptions Object

optional

Additional options to be used for the data request.

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

parameters ImagePixelLocationParameters

Specifies parameters for computing image space pixel location.

requestOptions Object

optional

Additional options to be used for the data request.

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

ArcGIS REST API - Compute Pixel Location

computeStatisticsHistograms Method computeStatisticsHistograms(url, parameters, requestOptions){Promise<Object>}

Computes statistics and histograms for the provided ImageHistogramParameters. If a raster function 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.

parameters ImageHistogramParameters autocast

Autocasts from Object

Specifies parameters for computing statistics and histograms.

requestOptions Object

optional

Additional options to be used for the data request.

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.

findImages Method findImages(url, parameters, requestOptions){Promise<FindImagesResult>} Since: ArcGIS Maps SDK for JavaScript 4.29 imageService since 4.19, findImages added at 4.29.

Finds images based on the provided FindImagesParameters. It locates all images that contain a toGeometry and sorts them accordingly. The fromGeometry can be a 3D SceneView's camera position and the toGeometry is a clicked location on the map.

This operation is supported with ArcGIS Enterprise version 11.2 or higher image services..

Parameters

url String

The url of the image service to perform the find images operation on.

parameters FindImagesParameters autocast

Autocasts from Object

Specifies the find images parameters.

requestOptions Object

optional

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

Returns

Type	Description
Promise<FindImagesResult>	Resolves to a FindImagesResult containing images that met the search requirements.

getImageUrl Method getImageUrl(url, parameters, requestOptions){Promise<ImageUrlResult>} Since: ArcGIS Maps SDK for JavaScript 4.30 imageService since 4.19, getImageUrl added at 4.30.

Retrieves an image's url using the provided ImageUrlParameters. This operation is supported with ArcGIS Enterprise version 11.3 or higher image services.

Parameters

url String

The url of the image service to perform the get image url operation on.

parameters ImageUrlParameters autocast

Autocasts from Object

Specifies the image url parameters.

requestOptions Object

optional

Additional options to be used for the data request.

Returns

Type	Description
Promise<ImageUrlResult>	Resolves to a ImageUrlResult containing the image's url.

getSamples Method getSamples(url, parameters, requestOptions){Promise<ImageSampleResult>} Since: ArcGIS Maps SDK for JavaScript 4.23 imageService since 4.19, getSamples added at 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.

parameters ImageSampleParameters autocast

Autocasts from Object

The parameters used in the getSamples operation.

requestOptions Object

optional

Additional options to be used for the data request.

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 Method 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.

params ImageIdentifyParameters

Specifies the criteria used to identify the features.

requestOptions Object

optional

Additional options to be used for the data request.

Returns

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

imageToMap Method imageToMap(url, parameters, requestOptions){Promise<Geometry>} Since: ArcGIS Maps SDK for JavaScript 4.29 imageService since 4.19, imageToMap added at 4.29.

Convert a geometry from an image space to a map space using the provided ImageToMapParameters. This operation is supported with ArcGIS Enterprise version 11.2 or higher image services.

Parameters

url String

The url of the image service to perform the image to map operation on.

parameters ImageToMapParameters autocast

Autocasts from Object

Specifies the image to map parameters.

requestOptions Object

optional

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

Returns

Type	Description
Promise<Geometry>	Resolves to a geometry object.

imageToMapMultiray Method imageToMapMultiray(url, parameters, requestOptions){Promise<Geometry>} Since: ArcGIS Maps SDK for JavaScript 4.29 imageService since 4.19, imageToMapMultiray added at 4.29.

Creates a map space geometry from multiray image space geometries using the provided ImageToMapMultirayParameters. For example, a house is shown in several raster items. Users can specify the house location on each image using the geometries parameter. Then in the rasterIds parameter, specify the rasterIds of the images in the same order as the geometries. The imageToMapMultiray operation will find and return the house location in the map space on all specified images.

This operation is supported with ArcGIS Enterprise version 11.2 or higher image services.

Parameters

url String

The url of the image service to perform the image to map multiray operation on.

parameters ImageToMapMultirayParameters autocast

Autocasts from Object

Specifies the image to map multiray parameters.

requestOptions Object

optional

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

Returns

Type	Description
Promise<Geometry>	Resolves to a geometry object where the coordinates in map coordinates.

mapToImage Method mapToImage(url, parameters, requestOptions){Promise<Geometry>} Since: ArcGIS Maps SDK for JavaScript 4.29 imageService since 4.19, mapToImage added at 4.29.

Converts a given geometry from a map space to an image space using the provided MapToImageParameters. This operation is supported with ArcGIS Enterprise version 11.2 or higher image services.

Parameters

url String

The url of the image service to perform the map to image operation on.

parameters MapToImageParameters autocast

Autocasts from Object

Specifies the map to image parameters.

requestOptions Object

optional

Additional options to be used for the data request.

Returns

Type	Description
Promise<Geometry>	Resolves to a geometry object where the coordinates are in image space.

measureAreaAndPerimeter Method measureAreaAndPerimeter(url, parameters, requestOptions){Promise<ImageAreaResult>} Since: ArcGIS Maps SDK for JavaScript 4.26 imageService since 4.19, measureAreaAndPerimeter added at 4.26.

Calculates the area and perimeter of a given geometry on an image service. The result of this operation includes the name of the raster dataset being used, the sensor name, and measured values.

Parameters

url String

The url of the image service to perform the area and perimeter measurement on.

parameters ImageAreaParameters autocast

Autocasts from Object

Specifies parameters for measuring the area and perimeter of a given geometry on an image service.

requestOptions Object

optional

Additional options to be used for the data request.

Returns

Type	Description
Promise<ImageAreaResult>	When resolved, returns an instance of ImageAreaResult containing the name of the raster dataset being used, the sensor name, and measured values.

measureAreaFromImage Method measureAreaFromImage(url, parameters, requestOptions){Promise<MeasureAreaFromImageResult>} Since: ArcGIS Maps SDK for JavaScript 4.29 imageService since 4.19, measureAreaFromImage added at 4.29.

Measures the area and the perimeter of a polygon in an image space on a selected raster when the following conditions are met:

Image service must be published from a mosaic dataset.
Raster items in the mosaic dataset must have 3D transformation (e.g. mosaic dataset built with UAV raster type).

Parameters

url String

The url of the image service to perform the height measurement on.

parameters MeasureFromImageParameters autocast

Autocasts from Object

Specifies the parameters for measuring the area.

requestOptions Object

optional

Additional options to be used for the data request.

Returns

Type	Description
Promise<MeasureAreaFromImageResult>	When resolved, returns an instance of MeasureAreaFromImageResult containing the name of the polygon's shape in map space and its length, area, and center.

measureDistanceAndAngle Method measureDistanceAndAngle(url, parameters, requestOptions){Promise<ImageDistanceResult>} Since: ArcGIS Maps SDK for JavaScript 4.26 imageService since 4.19, measureDistanceAndAngle added at 4.26.

Calculates the distance and angle between two points on an image service. The result of this operation includes the name of the raster dataset being used, the sensor name, and measured values.

Parameters

url String

The url of the image service to perform the distance and angle measurement on.

parameters ImageDistanceParameters autocast

Autocasts from Object

Specifies parameters for measuring a distance and an angle on an image between two points.

requestOptions Object

optional

Additional options to be used for the data request.

Returns

Type	Description
Promise<ImageDistanceResult>	When resolved, returns an instance of ImageDistanceResult containing the name of the raster dataset being used, the sensor name, and measured values.

measureHeight Method measureHeight(url, parameters, requestOptions){Promise<ImageHeightResult>} Since: ArcGIS Maps SDK for JavaScript 4.26 imageService since 4.19, measureHeight added at 4.26.

Calculates the height of an object between two points on an image service. The result of this operation includes the name of the raster dataset being used, the sensor name, and measured values. See the ImageHeightParameters.operationType documentation for types of height measurements.

Parameters

url String

The url of the image service to perform the height measurement on.

parameters ImageHeightParameters autocast

Autocasts from Object

Specifies the parameters for measuring the height of an object between two points on an image service.

requestOptions Object

optional

Additional options to be used for the data request.

Returns

Type	Description
Promise<ImageHeightResult>	When resolved, returns an instance of ImageHeightResult containing the name of the raster dataset being used, the sensor name, and measured values.

measureLengthFromImage Method measureLengthFromImage(url, parameters, requestOptions){Promise<MeasureLengthFromImageResult>} Since: ArcGIS Maps SDK for JavaScript 4.29 imageService since 4.19, measureLengthFromImage added at 4.29.

Measures the length of a polyline in an image space on a selected raster when the following conditions are met:

Image service must be published from a mosaic dataset.
Raster items in the mosaic dataset must have 3D transformation (e.g. mosaic dataset built with UAV raster type).

Parameters

url String

The url of the image service to perform the measurement on.

parameters MeasureFromImageParameters autocast

Autocasts from Object

Specifies parameters for measuring the length.

requestOptions Object

optional

Additional options to be used for the data request.

Returns

Type	Description
Promise<MeasureLengthFromImageResult>	When resolved, returns an instance of MeasureLengthFromImageResult containing the name of the polyline's shape in map space and its length.

measurePointOrCentroid Method measurePointOrCentroid(parameters, requestOptions){Promise<ImagePointResult>} Since: ArcGIS Maps SDK for JavaScript 4.26 imageService since 4.19, measurePointOrCentroid added at 4.26.

Returns the location for a given point or centroid of a given area on an image service.

Parameters

parameters ImagePointParameters autocast

Autocasts from Object

Specifies parameters for determining a point location or a centroid of a given area on the image service.

requestOptions Object

optional

Additional options to be used for the data request.

Returns

Type	Description
Promise<ImagePointResult>	When resolved, returns an instance of ImagePointResult containing the name of the raster dataset being used, the sensor name, and measured values.

queryBoundary Method queryBoundary(url, parameters, requestOptions){Promise<ImageBoundaryResult>} Since: ArcGIS Maps SDK for JavaScript 4.29 imageService since 4.19, queryBoundary added at 4.29.

Returns the boundary of an image for the provided ImageBoundaryParameters. This operation is supported with ArcGIS Enterprise version 10.6 or higher image services.

Parameters

url String

The url of the image service to query the boundary for.

parameters ImageBoundaryParameters autocast

Autocasts from Object

Specifies the imagery boundary parameters.

requestOptions Object

optional

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

Returns

Type	Description
Promise<ImageBoundaryResult>	Resolves to an object containing boundary geometry of the image service.

queryGPSInfo Method queryGPSInfo(url, parameters, requestOptions){Promise<ImageGPSInfoResult>} Since: ArcGIS Maps SDK for JavaScript 4.29 imageService since 4.19, queryGPSInfo added at 4.29.

Returns GPS information for the provided ImageGPSInfoParameters. It returns information about cameras, GPS locations when the image was taken, and exterior orientation information of each image.

This operation is supported with ArcGIS Enterprise version 11.2 or higher image services.

Parameters

url String

The url of the image service to query GPS information from.

parameters ImageGPSInfoParameters autocast

Autocasts from Object

Specifies the parameters for query GPS info operation.

requestOptions Object

optional

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

Returns

Type	Description
Promise<ImageGPSInfoResult>	Resolves to an object containing information about images and cameras.