Hide Table of Contents
esri
arcgis
dijit
geometry
layers
renderer
symbols
tasks
Class: IdentifyTask
[ AMD Module Require | Legacy Module Require ]
Module Require
require(["esri/tasks/IdentifyTask", ... ], function(IdentifyTask, ... ){ ... });
Description
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.Class hierarchy
esri.tasks.IdentifyTask
Constructors
| Constructor | Description |
|---|---|
| new IdentifyTask(url,options?) | Creates a new IdentifyTask object. A URL is a required parameter. |
Properties
| Property | Type | Description |
|---|---|---|
| url | String | URL to the ArcGIS Server REST resource that represents a map service. To obtain the URL, use Services Directory. |
Methods
| Method | Return Value | Description |
|---|---|---|
| execute(identifyParameters,callback?,errback?) | dojo.Deferred | 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. |
Events
[ On Style Events | Connect Style Events ]
All On Style event listeners receive a single event object. The event properties listed below are accessed from this event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
| On Event | Event Properties | Description |
|---|---|---|
| complete | <IdentifyResult[]> results | Fires when the identify operation is complete. Should be used in favor of onComplete. |
Constructor Details
Creates a new IdentifyTask object. A URL is a required parameter.
Parameters:
| <String> url | 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. |
| <Object> options | Optional | Optional parameters. See options list. |
Options:
| <String> gdbVersion | Specify the geodatabase version to display. (As of v2.7). Requires ArcGIS Server service 10.1 or greater |
Code Snippet:
require([
"esri/tasks/IdentifyTask", ...
], function(IdentifyTask, ... ) {
var identify = new IdentifyTask("http://sampleserver1.arcgisonline.com/ArcGIS/rest/services/Specialty/ESRI_StatesCitiesRivers_USA/MapServer");
...
});
Property Details
URL 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.
The return object of
The return object of
dojo.Deferred was added at v1.4.Return Value: dojo.Deferred
Input Parameters:
| <IdentifyParameters> identifyParameters | Required | Specifies the criteria used to identify the features. |
| <Function> callback | Optional | The function to call when the method has completed. The arguments in the function are the same as the onComplete event. |
| <Function> errback | Optional | An error object is returned if an error occurs on the Server during task execution. (As of v1.3) |
Code Snippet:
identifyParams.geometry = geometry; identifyParams.mapExtent = map.extent; identify.execute(identifyParams);
See Also: onComplete onError
Event Details
[ On Style Events | Connect Style Events ]
Fires when the identify operation is complete. Should be used in favor of onComplete.
Event Properties:
| <IdentifyResult[]> results | The result of an identify operation |