IdentifyParameters

AMD: require(["esri/rest/support/IdentifyParameters"], (IdentifyParameters) => { /* code goes here */ });
ESM: import IdentifyParameters from "@arcgis/core/rest/support/IdentifyParameters";
Class: esri/rest/support/IdentifyParameters
Inheritance: IdentifyParameters Accessor
Since: ArcGIS Maps SDK for JavaScript 4.20

Input parameters for the identify.

See also

Constructors

new IdentifyParameters(properties)
Parameter
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
Accessor
Number

Resolution of the current map view in dots per inch.

more details
IdentifyParameters
String

Specify the geodatabase version to search.

more details
IdentifyParameters
Geometry

The geometry used to select features during the Identify operation.

more details
IdentifyParameters
Number

Specify the number of decimal places for the geometries returned by the task.

more details
IdentifyParameters
Number

Height of the View in pixels.

more details
IdentifyParameters
Number[]

The layers on which to perform the identify operation.

more details
IdentifyParameters
String

Specifies which layers to use when using Identify.

more details
IdentifyParameters
Extent

The Extent or bounding box of the current map view.

more details
IdentifyParameters
Number

The maximum allowable offset used for generalizing geometries returned by the identify operation.

more details
IdentifyParameters
Boolean

If true, field names will be returned instead of field aliases.

more details
IdentifyParameters
Boolean

If true, the result set includes the geometry associated with each result.

more details
IdentifyParameters
Boolean

When true, indicates that M values will be returned.

more details
IdentifyParameters
Boolean

If true, the values in the result will not be formatted i.e.

more details
IdentifyParameters
Boolean

When true, indicates that z-values will be returned.

more details
IdentifyParameters
SpatialReference

The spatial reference of the input and output geometries as well as of the mapExtent.

more details
IdentifyParameters
Sublayer[]

An Collection of Sublayer objects used to change the layer ordering and/or rendering, or redefine the map.

more details
IdentifyParameters
TimeExtent

Specify the time extent used by identify.

more details
IdentifyParameters
Number

The distance in screen pixels from the specified geometry within which the identify should be performed.

more details
IdentifyParameters
Number

Width of the current map view in pixels.

more details
IdentifyParameters

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

dpi Number

Resolution of the current map view in dots per inch.

Default Value:96
gdbVersion String

Specify the geodatabase version to search.

geometry Geometryautocast

The geometry used to select features during the Identify operation. The type of the geometry is specified by Geometry.type. The most common geometry used with Identify is a Point.

geometryPrecision Number

Specify the number of decimal places for the geometries returned by the task.

height Number

Height of the View in pixels.

Default Value:400
layerIds Number[]

The layers on which to perform the identify operation. The layers are specified as a comma-separated list of layer IDs.

layerOption String

Specifies which layers to use when using Identify.

Possible values Description
top Only the top-most visible layer on the service is identified.
visible All visible layers on the service are identified.
all All layers on the service are identified, even if they are not visible. If your service has many layers, a request using this option will not perform well. A visible layer means you can see it in the map at the current extent. If a layer is turned off or not in range based on its scale dependency settings, it cannot be identified.
popup All visible layers with a popupTemplate. sublayers is required for this option.

Possible Values:"top"|"visible"|"all"|"popup"

Default Value:top
mapExtent Extent

The Extent or bounding box of the current map view. The mapExtent property is assumed to be in the spatial reference of the map unless spatialReference has been specified.

The values for mapExtent, height, width, and dpi are used to determine the current map scale. Once the scale is known, the map service can exclude layers based on their scale dependency settings. The map service is not performing a spatial intersection based on the provided extent. These properties are also used to calculate the search distance on the map based on the tolerance in screen pixels.

maxAllowableOffset Number

The maximum allowable offset used for generalizing geometries returned by the identify operation. The offset is in the units of the spatialReference. If a spatialReference is not defined the spatial reference of the view is used.

returnFieldName Boolean

If true, field names will be returned instead of field aliases. Requires ArcGIS Server service 10.5 or greater.

Default Value:true
returnGeometry Boolean

If true, the result set includes the geometry associated with each result.

Default Value:false
returnM Boolean

When true, indicates that M values will be returned.

Default Value:false
returnUnformattedValues Boolean

If true, the values in the result will not be formatted i.e. numbers will returned as is and dates will be returned as epoch values. Requires ArcGIS Server service 10.5 or greater.

Default Value:true
returnZ Boolean

When true, indicates that z-values will be returned.

Default Value:false
spatialReference SpatialReference

The spatial reference of the input and output geometries as well as of the mapExtent. If the spatial reference is not specified, the geometry and the extent are assumed to be in the spatial reference of the view, and the output geometries will also be in the spatial reference of the view.

sublayers Sublayer[]
Since: ArcGIS Maps SDK for JavaScript 4.22

An Collection of Sublayer objects used to change the layer ordering and/or rendering, or redefine the map. Sublayers created on the fly as dynamic layers can also be used. When set, the identify operation will performed against MapImageLayer.

See also
timeExtent TimeExtent
Since: ArcGIS Maps SDK for JavaScript 4.22

Specify the time extent used by identify.

tolerance Number

The distance in screen pixels from the specified geometry within which the identify should be performed.

width Number

Width of the current map view in pixels.

Default Value:400

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
IdentifyParameters
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
IdentifyParameters

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns
Type Description
* Returns a new instance of this class.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
removeHandles(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

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