Input parameters for the IdentifyTask.
Constructors
new IdentifyParameters(properties)
properties Object See the properties for a list of all the properties that may be passed into the constructor. |
Property Overview
Name | Type | Summary | |
---|---|---|---|
String | The name of the class. more details | more details | |
Number | Resolution of the current map view in dots per inch. more details | more details | |
Geometry | The geometry used to select features during the Identify operation. more details | more details | |
Number | Specify the number of decimal places for the geometries returned by the task. more details | more details | |
Number | Height of the View in pixels. more details | more details | |
Number[] | The layers on which to perform the identify operation. more details | more details | |
String | Specifies which layers to use when using Identify. more details | more details | |
Extent | The Extent or bounding box of the current map view. more details | more details | |
Number | The maximum allowable offset used for generalizing geometries returned by the identify operation. more details | more details | |
Boolean | If | more details | |
SpatialReference | The spatial reference of the input and output geometries as well as of the mapExtent. more details | more details | |
Number | The distance in screen pixels from the specified geometry within which the identify should be performed. more details | more details | |
Number | Width of the current map view in pixels. more details | more details |
Property Details
declaredClassStringreadonly
The name of the class. The declared class name is formatted as
esri.folder.className
.dpiNumber
Resolution of the current map view in dots per inch.
Default Value: 96geometryGeometry
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: 400layerIdsNumber[]
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 values Description top Only the top-most visible layer is identified. visible All visible layers are identified. all All 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: topmapExtentExtent
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: falsespatialReferenceSpatialReference
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
Name | Return Type | Summary | |
---|---|---|---|
Object | Converts an instance of this class to its ArcGIS Portal JSON representation. more details | more details |
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:Type Description Object The ArcGIS Portal JSON representation of an instance of this class.