Skip To ContentArcGIS for DevelopersSign In Dashboard

ImageServiceIdentifyTask

require(["esri/tasks/ImageServiceIdentifyTask"], function(ImageServiceIdentifyTask) { /* code goes here */ });
Class: esri/tasks/ImageServiceIdentifyTask
Inheritance: ImageServiceIdentifyTask Task Accessor
Since: ArcGIS API for JavaScript 4.0

Performs an identify operation on an image service resource. It identifies the content of an image service for the input location and mosaic rule. Use ImageServiceIdentifyParameters to set the parameters of the task and ImageServiceIdentifyResult to work with the results.

See also:

Constructors

new ImageServiceIdentifyTask(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
Object

The options to be used for data requests.

more details
more detailsTask
String

The ArcGIS Server REST service URL (usually of a Feature Service Layer or Map Service Layer) for use in a task.

more details
more detailsTask

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

requestOptions Object inherited

The options to be used for data requests. These options can also be controlled through the requestOptions method parameter.

The ArcGIS Server REST service URL (usually of a Feature Service Layer or Map Service Layer) for use in a task.

Method Overview

NameReturn TypeSummaryClass
Promise<ImageServiceIdentifyResult>

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

more details
more detailsexecute

Method Details

execute(params, requestOptions){Promise<ImageServiceIdentifyResult>}inner

Sends a request to the ArcGIS REST image service resource to identify content based on the ImageServiceIdentifyParameters 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:
TypeDescription
Promise<ImageServiceIdentifyResult>When resolved, returns an instance of ImageServiceIdentifyResult.

API Reference search results

NameTypeModule
Loading...