IdentifyParameters

require(["esri/tasks/support/IdentifyParameters"], function(IdentifyParameters) { /* code goes here */ });
Class: esri/tasks/support/IdentifyParameters
Inheritance: IdentifyParameters Accessor
Since: ArcGIS API for JavaScript 4.0

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

The name of the class.

more details
more detailsAccessor
Number

Resolution of the current map view in dots per inch.

more details
more detailsIdentifyParameters
Geometry

The geometry used to select features during the Identify operation.

more details
more detailsIdentifyParameters
Number

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

more details
more detailsIdentifyParameters
Number

Height of the View in pixels.

more details
more detailsIdentifyParameters
Number[]

The layers on which to perform the identify operation.

more details
more detailsIdentifyParameters
String

Specifies which layers to use when using Identify.

more details
more detailsIdentifyParameters
Extent

The Extent or bounding box of the current map view.

more details
more detailsIdentifyParameters
Number

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

more details
more detailsIdentifyParameters
Boolean

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

more details
more detailsIdentifyParameters
SpatialReference

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

more details
more detailsIdentifyParameters
Number

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

more details
more detailsIdentifyParameters
Number

Width of the current map view in pixels.

more details
more detailsIdentifyParameters

Property Details

declaredClassStringreadonly inherited

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

Resolution of the current map view in dots per inch.

Default Value: 96

geometryGeometry

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.

geometryPrecisionNumber

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

heightNumber

Height of the View in pixels.

Default Value: 400

layerIdsNumber[]

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

layerOptionString

Specifies which layers to use when using Identify.

Possible valuesDescription
topOnly the top-most visible layer is identified.
visibleAll visible layers are identified.
allAll layers 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.
Default Value: top

mapExtentExtent

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.

maxAllowableOffsetNumber

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.

returnGeometryBoolean

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

Default Value: false

spatialReferenceSpatialReference

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.

toleranceNumber

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

widthNumber

Width of the current map view in pixels.

Default Value: 400

Method Overview

NameReturn TypeSummaryClass
Object

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

more details
more detailsIdentifyParameters

Method Details

toJSON(){Object}

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

Returns:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.