IdentifyTask

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

Performs an identify operation on the layers of a map service exposed by the ArcGIS Server REST API. Use IdentifyParameters to set the parameters for the identify operation and IdentifyResult to work with the results.

Known Limitations

IdentifyTask is currently not supported if attempting to be used:

See also:

Constructors

new IdentifyTask(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.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
more detailsAccessor
String

Specify the geodatabase version to search.

more details
more detailsIdentifyTask
String

URL to the ArcGIS Server REST resource that represents a map service.

more details
more detailsIdentifyTask

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.

gdbVersion String

Specify the geodatabase version to search.

url String

URL to the ArcGIS Server REST resource that represents a map service.

Method Overview

Name Return Type Summary Class
Promise<Object>

Sends a request to the ArcGIS REST map service resource to identify features based on the IdentifyParameters specified.

more details
more detailsIdentifyTask

Method Details

execute(params, requestOptions){Promise<Object>}

Sends a request to the ArcGIS REST map service resource to identify features based on the IdentifyParameters specified.

Parameters:

Specifies the criteria used to identify the features.

requestOptions Object
optional

Additional options to be used for the data request.

Returns:
Type Description
Promise<Object> Resolves to an object with the following properties:
Property Type Description
results IdentifyResult[] An array of objects containing the result features of the Identify task.
exceededTransferLimit Boolean exceededTransferLimit is included in the response only if the result exceeded the transfer limit.

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