identify

AMD: require(["esri/rest/identify"], (identify) => { /* code goes here */ });
ESM: import * as identify from "@arcgis/core/rest/identify";
Object: esri/rest/identify
Since: ArcGIS Maps SDK for JavaScript 4.19

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

The identify operation is currently not supported if attempting to be used in a 3D SceneView

Method Overview

Name Return Type Summary Object
Promise<object>

Sends a request to the ArcGIS REST map service resource to identify features based on the IdentifyParameters specified.

more details
identify

Method Details

identify(url, params, requestOptions){Promise<object>}

Sends a request to the ArcGIS REST map service resource to identify features based on the IdentifyParameters specified.

Parameters
url String

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

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
Type Description
Promise<object> Resolves to an object with the following properties:
Property Type Description
results IdentifyResult[] An array of objects containing the result features of the Identify task.
exceededTransferLimit Boolean If maxRecordCount is configured for a service, exceededTransferLimit will be true if an identify matches more than the maxRecordCount features. It will be false otherwise. Supported by ArcGIS Server version 10.1 and later.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.