Hide Table of Contents
esri/dijit/util
esri/layer/pixelFilters
esri/process
esri/workers
Class: ImageServiceIdentifyTask

require(["esri/tasks/ImageServiceIdentifyTask"], function(ImageServiceIdentifyTask) { /* code goes here */ });

Description

(Added at v2.0)
Performs an identify operation on an image service resource. It identifies the content of an image service for the input location and mosaic rule.

Samples

Search for samples that use this class.

Constructors

NameSummary
new ImageServiceIdentifyTask(url)Creates a new ImageServiceIdentifyTask object.

Methods

NameReturn typeSummary
execute(params, callback?, errback?)DeferredSends a request to the ArcGIS REST image service resource to identify content based on the ImageServiceIdentifyParameters specified in the imageServiceIdentifyParameters 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

NameEvent ObjectSummary
complete
{
  result: <ImageServiceIdentifyResult>
}
Fires when the identify operation is complete.
Constructor Details

new ImageServiceIdentifyTask(url)

Creates a new ImageServiceIdentifyTask object.
Parameters:
<String> url Required URL to the ArcGIS Server REST resource that represents an image service.
require([
  "esri/tasks/ImageServiceIdentifyTask", ... 
], function(ImageServiceIdentifyTask, ... ) {
  var imageTask = new ImageServiceIdentifyTask("http://sampleserver6.arcgisonline.com/arcgis/rest/services/CharlotteLAS/ImageServer");
  ...
});
Method Details

execute(params, callback?, errback?)

Sends a request to the ArcGIS REST image service resource to identify content based on the ImageServiceIdentifyParameters specified in the imageServiceIdentifyParameters argument.
Return type: Deferred
Parameters:
<ImageServiceIdentifyParameters> params 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.
Sample:
imageTask.execute(imageParams, getResults);
Event Details
[ On Style Events | Connect Style Event ]

complete

Fires when the identify operation is complete. Should be used in favor of onComplete. (Added at v3.5)
Event Object Properties:
<ImageServiceIdentifyResult> result The result of an identify operation.