IdentifyParameters | API Reference | ArcGIS Maps SDK for JavaScript 4.32

Input parameters for the identify.

See also

Constructors

IdentifyParameters Constructor 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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
Number	Resolution of the current map view in dots per inch.	IdentifyParameters
String\|null\|undefined	Specify the geodatabase version to search.	IdentifyParameters
GeometryUnion\|null\|undefined	The geometry used to select features during the Identify operation.	IdentifyParameters
Number\|null\|undefined	Specify the number of decimal places for the geometries returned by the task.	IdentifyParameters
Number	Height of the View in pixels.	IdentifyParameters
Date\|null\|undefined	The historic moment to identify.	IdentifyParameters
Number []\|null\|undefined	The layers on which to perform the identify operation.	IdentifyParameters
String	Specifies which layers to use when using Identify.	IdentifyParameters
Extent\|null\|undefined	The Extent or bounding box of the current map view.	IdentifyParameters
Number\|null\|undefined	The maximum allowable offset used for generalizing geometries returned by the identify operation.	IdentifyParameters
Boolean	If `true`, field names will be returned instead of field aliases.	IdentifyParameters
Boolean	If `true`, the result set includes the geometry associated with each result.	IdentifyParameters
Boolean	When `true`, indicates that M values will be returned.	IdentifyParameters
Boolean	If `true`, the values in the result will not be formatted i.e.	IdentifyParameters
Boolean	When `true`, indicates that z-values will be returned.	IdentifyParameters
SpatialReference\|null\|undefined	The spatial reference of the input and output geometries as well as of the mapExtent.	IdentifyParameters
Collection<Sublayer>\|null\|undefined	An Collection of Sublayer objects used to change the layer ordering and/or rendering, or redefine the map.	IdentifyParameters
TimeExtent\|null\|undefined	Specify the time extent used by identify.	IdentifyParameters
Number\|null\|undefined	The distance in screen pixels from the specified geometry within which the identify should be performed.	IdentifyParameters
Number	Width of the current map view in pixels.	IdentifyParameters

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

dpi Property dpi Number

Resolution of the current map view in dots per inch.

Default Value:96

gdbVersion Property gdbVersion String |null |undefined

Specify the geodatabase version to search.

geometry Property geometry GeometryUnion |null |undefinedautocast

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 Property geometryPrecision Number |null |undefined

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

height Property height Number

Height of the View in pixels.

Default Value:400

historicMoment Property historicMoment Date |null |undefinedautocast Since: ArcGIS Maps SDK for JavaScript 4.29 IdentifyParameters since 4.20, historicMoment added at 4.29.

The historic moment to identify. This parameter applies only if the supportsQueryWithHistoricMoment capability of the service being queried is true. This setting is provided in the layer resource.

layerIds Property layerIds Number[] |null |undefined

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

layerOption Property 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 Property mapExtent Extent |null |undefinedautocast

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 Property maxAllowableOffset Number |null |undefined

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 Property 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 Property returnGeometry Boolean

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

Default Value:false

returnM Property returnM Boolean

When true, indicates that M values will be returned.

Default Value:false

returnUnformattedValues Property 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 Property returnZ Boolean

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

Default Value:false

spatialReference Property spatialReference SpatialReference |null |undefinedautocast

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 Property sublayers Collection<Sublayer> |null |undefinedautocast Since: ArcGIS Maps SDK for JavaScript 4.22 IdentifyParameters since 4.20, sublayers added at 4.22.

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

Usually this property is set with the layer's sublayers.

See also

Identify - ArcGIS Server REST API

Example

const {
  extent: maxExtent,
  spatialReference,
  width,
  height,
  timeExtent,
} = view;

const parameters = new IdentifyParameters({
  sublayers: layer.sublayers,
  layerOption: "popup",
  returnGeometry: true,
  geometry: maxExtent.center,
  tolerance: 5,
  height,
  mapExtent,
  spatialReference,
  timeExtent,
  width,
});

identify(layer.url, parameters).then((response) => {
  // process the response
});

timeExtent Property timeExtent TimeExtent |null |undefinedautocast Since: ArcGIS Maps SDK for JavaScript 4.22 IdentifyParameters since 4.20, timeExtent added at 4.22.

Specify the time extent used by identify.

tolerance Property tolerance Number |null |undefined

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

width Property width Number

Width of the current map view in pixels.

Default Value:400

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
*\|null\|undefined	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	IdentifyParameters
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	IdentifyParameters

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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 }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

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 Method fromJSON(json){* |null |undefined}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
* \| null \| undefined	Returns a new instance of this class.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 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 Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 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 Method 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.