IdentifyTask
require(["esri/tasks/IdentifyTask"], function(IdentifyTask) { /* code goes here */ });esri/tasks/IdentifyTaskPerforms 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:
- in a 3D SceneView
- with dynamic layers
Constructors
- new IdentifyTask(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | The name of the class. more details | more details | Accessor | |
| String | Specify the geodatabase version to search. more details | more details | IdentifyTask | |
| Object | The options to be used for data requests. more details | more details | Task | |
| String | URL to the ArcGIS Server REST resource that represents a map service. more details | more details | IdentifyTask |
Property Details
- 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. Requires ArcGIS Server service 10.1 or greater.
The options to be used for data requests. These options can also be controlled through the
requestOptionsmethod parameter.
- 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 details | IdentifyTask |
Method Details
Sends a request to the ArcGIS REST map service resource to identify features based on the IdentifyParameters specified.
Parameters:params IdentifyParametersSpecifies the criteria used to identify the features.
requestOptions ObjectoptionalAdditional options to be used for the data request (will override requestOptions defined during construction).
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.