Class: IdentifyParametersE-mail This Topic Printable Version Give Us Feedback

Description

This data object is used as the identifyParameters argument to IdentifyTask.execute method. It specifies the criteria used to identify the features.

Class hierarchy

esri.tasks.IdentifyParameters

Constructor

Constructor Description
esri.tasks.IdentifyParameters() Creates a new IdentifyParameters object. The constructor takes no parameters.

Properties

Property Type Description
dpi Number Resolution of the current map view in dots per inch.
geometry Geometry The geometry used to select features during Identify. The type of the geometry is specified by Geometry type. The most common geometry used with Identify is a Point.
height Number Height of the map currently being viewed in pixels.
layerIds Number[] The layers to perform the find operation on. The layers are specified as a comma-separated list of layer ids. The list of ids is returned in ArcGISMapServiceLayer layerInfos.
layerOption String Specifies which layers to use when using Identify. See the Constants table for valid values.
mapExtent Extent The Extent or bounding box of the map currently being viewed. The mapExtent property is assumed to be in the spatial reference of the map unless sr has been specified.

The values for mapExtent, height, width, and dpi are used to determine the layers visible in the current extent. They are also used to calculate the search distance on the map based on the tolerance in screen pixels.
returnGeometry Boolean If "true", the result set includes the geometry associated with each result. The default is "false".
spatialReference SpatialReference The spatial reference of the input and output geometries as well as of the mapExtent. If sr is not specified, the geometry and the extent are assumed to be in the spatial reference of the map, and the output geometries will also be in the spatial reference of the map. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references.
tolerance Number The distance in screen pixels from the specified geometry within which the identify should be performed.
width Number Width of the map currently being viewed in pixels.

Constants

Constant Description
LAYER_OPTION_ALL All layers are identified, even if they are not visible. Performance note: if your service has many layers, a request using ths 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.
LAYER_OPTION_TOP Only the top-most visible layer is identified.
LAYER_OPTION_VISIBLE All visible layers are identified.
Constructor Detail

esri.tasks.IdentifyParameters()

Creates a new IdentifyParameters object. The constructor takes no parameters.
Code snippets:
  identifyParams = new esri.tasks.IdentifyParameters();
  identifyParams.tolerance = 3;
  identifyParams.returnGeometry = true;
  identifyParams.layerIds = [2,3,4];
  identifyParams.layerOption = esri.tasks.IdentifyParameters.LAYER_OPTION_ALL;
  identifyParams.width  = map.width;
  identifyParams.height = map.height;
Properties Detail

<Number> dpi

Resolution of the current map view in dots per inch.
Default value: 96

<Geometry> geometry

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

<Number> height

Height of the map currently being viewed in pixels.

<Number[]> layerIds

The layers to perform the find operation on. The layers are specified as a comma-separated list of layer ids. The list of ids is returned in ArcGISMapServiceLayer layerInfos.

<String> layerOption

Specifies which layers to use when using Identify. See the Constants table for valid values.
Default value: LAYER_OPTION_TOP

<Extent> mapExtent

The Extent or bounding box of the map currently being viewed. The mapExtent property is assumed to be in the spatial reference of the map unless sr has been specified.

The values for mapExtent, height, width, and dpi are used to determine the layers visible in the current extent. They are also used to calculate the search distance on the map based on the tolerance in screen pixels.

<Boolean> returnGeometry

If "true", the result set includes the geometry associated with each result. The default is "false".
Known values: true | false
Default value: false

<SpatialReference> spatialReference

The spatial reference of the input and output geometries as well as of the mapExtent. If sr is not specified, the geometry and the extent are assumed to be in the spatial reference of the map, and the output geometries will also be in the spatial reference of the map. See Projected Coordinate Systems and Geographic Coordinate Systems for the list of supported spatial references.

<Number> tolerance

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

<Number> width

Width of the map currently being viewed in pixels.