IdentifyParameters

AMD: require(["esri/tasks/support/IdentifyParameters"], (IdentifyParameters) => { /* code goes here */ });
ESM: import IdentifyParameters from "@arcgis/core/tasks/support/IdentifyParameters";
Class: esri/tasks/support/IdentifyParameters
Inheritance: IdentifyParameters Accessor
Since: ArcGIS API for JavaScript 4.0
Deprecated since version 4.20. Use IdentifyParameters instead.

Input parameters for the IdentifyTask.

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
Stringmore details

The name of the class.

more detailsAccessor
Numbermore details

Resolution of the current map view in dots per inch.

more detailsIdentifyParameters
Stringmore details

Specify the geodatabase version to search.

more detailsIdentifyParameters
Geometrymore details

The geometry used to select features during the Identify operation.

more detailsIdentifyParameters
Numbermore details

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

more detailsIdentifyParameters
Numbermore details

Height of the View in pixels.

more detailsIdentifyParameters
Number[]more details

The layers on which to perform the identify operation.

more detailsIdentifyParameters
Stringmore details

Specifies which layers to use when using Identify.

more detailsIdentifyParameters
Extentmore details

The Extent or bounding box of the current map view.

more detailsIdentifyParameters
Numbermore details

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

more detailsIdentifyParameters
Booleanmore details

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

more detailsIdentifyParameters
Booleanmore details

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

more detailsIdentifyParameters
Booleanmore details

When true, indicates that M values will be returned.

more detailsIdentifyParameters
Booleanmore details

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

more detailsIdentifyParameters
Booleanmore details

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

more detailsIdentifyParameters
SpatialReferencemore details

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

more detailsIdentifyParameters
Numbermore details

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

more detailsIdentifyParameters
Numbermore details

Width of the current map view in pixels.

more detailsIdentifyParameters

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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.

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

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
Since: ArcGIS API for JavaScript 4.20

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

Default Value:false
returnGeometry Boolean

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

Default Value:false
returnM Boolean
Since: ArcGIS API for JavaScript 4.20

When true, indicates that M values will be returned.

Default Value:false
returnUnformattedValues Boolean
Since: ArcGIS API for JavaScript 4.20

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:false
returnZ Boolean
Since: ArcGIS API for JavaScript 4.20

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.

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

Name Return Type Summary Class
*more details

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

more detailsIdentifyParameters
Objectmore details

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

more detailsIdentifyParameters

Method Details

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.
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.