Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: IdentifyTask
[ AMD Module Require | Legacy Module Require ]
require(["esri/tasks/IdentifyTask"], function(IdentifyTask) { /* code goes here */ });
Description
(Added at v1.0)
Performs an identify operation on the layers of a map service resource exposed by the ArcGIS Server REST API.Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new IdentifyTask(url, options?) | Creates a new IdentifyTask object. |
Properties
| Name | Type | Summary |
|---|---|---|
| url | String | URL to the ArcGIS Server REST resource that represents a map service. |
Methods
| Name | Return type | Summary |
|---|---|---|
| execute(identifyParameters, callback?, errback?) | Deferred | Sends a request to the ArcGIS REST map service resource to identify features based on the IdentifyParameters specified in the identifyParameters argument. |
Events
[ On Style Events | Connect Style Event ]
All On Style event listeners receive a single event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
Events
| Name | Event Object | Summary |
|---|---|---|
| complete | {
results: < | Fires when the identify operation is complete. |
| error | {
error: < | Fires when an error occurs when executing the task. |
Constructor Details
Creates a new IdentifyTask object. A URL is a required parameter.
Parameters:
< |
Required | URL to the ArcGIS Server REST resource that represents a map service. An example is http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Portland/Portland_ESRI_LandBase_AGO/MapServer. For more information on constructing a URL, see The Services Directory and the REST API. |
< |
Optional | Optional parameters. See options list. |
options properties: < |
Optional | Specify the geodatabase version to display. (As of v2.7). Requires ArcGIS Server service 10.1 or greater |
Sample:
require([
"esri/tasks/IdentifyTask", ...
], function(IdentifyTask, ... ) {
var identify = new IdentifyTask("http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StatesCitiesRivers_USA/MapServer");
...
});
Property Details
<String
StringURL to the ArcGIS Server REST resource that represents a map service. To obtain the URL, use Services Directory.
Method Details
Sends a request to the ArcGIS REST map service resource to identify features based on the IdentifyParameters specified in the identifyParameters argument. On completion, the onComplete event is fired and the optional callback function is invoked.
Return type:
DeferredParameters:
< |
Required | Specifies the criteria used to identify the features. |
< |
Optional | The function to call when the method has completed. The arguments in the function are the same as the onComplete event. |
< |
Optional | An error object is returned if an error occurs on the Server during task execution. (As of v1.3) |
Sample:
identifyParams.geometry = geometry; identifyParams.mapExtent = map.extent; identify.execute(identifyParams);
See also: on("complete"), on("error")
Event Details
[ On Style Events | Connect Style Event ]
Fires when the identify operation is complete. Should be used in favor of onComplete. (Added at v3.5)
Event Object Properties:
< |
The result of an identify operation |
See also: execute()
Fires when an error occurs when executing the task. (Added at v3.6)
Event Object Properties:
< |
ArcGIS Server error message returned in a JavaScript error object. |
See also: execute()