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 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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
String

Specifies the geodatabase version to display.

more details
more detailsIdentifyTask
Object

The options to be used for data requests.

more details
more detailsTask
String

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

more details
more detailsIdentifyTask

Property Details

declaredClassStringreadonly inherited

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

gdbVersionString

Specifies the geodatabase version to display.

requestOptionsObject inherited

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

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

Method Overview

NameReturn TypeSummaryClass
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 (will override requestOptions defined during construction).

Returns:
TypeDescription
Promise< Object>Resolves to an object with the following properties:
PropertyTypeDescription
resultsIdentifyResult[]An array of objects containing the result features of the Identify task.
exceededTransferLimitBooleanexceededTransferLimit is included in the response only if the result exceeded the transfer limit.

API Reference search results

NameTypeModule

There were no match results from your search criteria.