dojo.require("esri.tasks.identify");
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
Properties
url | String | URL to the ArcGIS Server REST resource that represents a map service. |
Methods
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.
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
https://www.example.com/argis/rest/services/Portland/Portland_ESRI_LandBase_AGO/MapServer. |
<Object > options |
Optional |
Optional parameters. See options list. |
options
properties:
<String > gdbVersion |
Optional |
Specify the geodatabase version to display. (As of v2.7). Requires ArcGIS Server service 10.1 or greater |
Sample:
var identify = new esri.tasks.IdentifyTask("https://www.example.com/argis/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.
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) |
Sample:
identifyParams.geometry = geometry;
identifyParams.mapExtent = map.extent;
identify.execute(identifyParams);
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)
Fires when an error occurs when executing the task. (Added at v3.6)
Fires when the identify operation is complete.
Fires when an error occurs when executing the task. (Added at v1.3)