Packagecom.esri.ags.tasks.supportClasses
Classpublic class IdentifyParameters
InheritanceIdentifyParameters Inheritance Object

Input parameters for an IdentifyTask.

Note: The IdentifyTask uses default map service settings, and thus will not take into account any layer visibility changes made on a map service displayed on the map.

View the examples

See also

com.esri.ags.tasks.IdentifyTask
Live Sample - Identify features.

Public Properties
 PropertyDefined By
  dpi : Number = 96
Resolution of the current map view in dots per inch.
IdentifyParameters
  geometry : Geometry
The geometry used to select features during Identify.
IdentifyParameters
  height : Number
Height of the map currently being viewed in pixels.
IdentifyParameters
  layerDefinitions : Array
Array of layer definition expressions that allows you to filter the features of individual layers in the results.
IdentifyParameters
  layerIds : Array
The layers to perform the Identify operation on.
IdentifyParameters
  layerOption : String = top
Specifies which method to use when using Identify.
IdentifyParameters
  layerTimeOptions : Array
Array of LayerTimeOptions that allow you to override how a layer is identified in reference to the timeExtent [added in version 2.0].
IdentifyParameters
  mapExtent : Extent
The extent or bounding box of the map currently being viewed.
IdentifyParameters
  maxAllowableOffset : Number
The maximum allowable offset used for generalizing geometries returned by the Identify operation.
IdentifyParameters
  returnGeometry : Boolean = false
If true, the result set include the geometry associated with each result.
IdentifyParameters
  spatialReference : SpatialReference
The well-known ID of the spatial reference of the input and output geometries as well as of the mapExtent.
IdentifyParameters
  timeExtent : TimeExtent
The time instant or the time extent within which the identify should be performed [added in version 2.0].
IdentifyParameters
  tolerance : Number = 2
The distance in screen pixels from the specified geometry within which the identify should be performed.
IdentifyParameters
  width : Number
Width of the map currently being viewed in pixels.
IdentifyParameters
Public Constants
 ConstantDefined By
  LAYER_OPTION_ALL : String = all
[static] All layers are identified, even if they are not visible.
IdentifyParameters
  LAYER_OPTION_TOP : String = top
[static] Only the topmost visible layer is identified.
IdentifyParameters
  LAYER_OPTION_VISIBLE : String = visible
[static] All visible layers are identified.
IdentifyParameters
Property Detail
dpiproperty
public var dpi:Number = 96

Resolution of the current map view in dots per inch.

The default value is 96.

geometryproperty 
public var geometry:Geometry

The geometry used to select features during Identify. The most common geometry used with Identify is a point.

heightproperty 
public var height:Number

Height of the map currently being viewed in pixels.

layerDefinitionsproperty 
public var layerDefinitions:Array

Since : ArcGIS API for Flex 2.0

Array of layer definition expressions that allows you to filter the features of individual layers in the results. Requires ArcGIS Server 10.0 or above.

layerIdsproperty 
public var layerIds:Array

The layers to perform the Identify operation on. The ID is returned in layerInfos. Only applies when layerOption is "all" or "visible".


Example
ActionScript to use layerIds: 
     myIdentifyParams.layerIds = [0,1,2];
layerOptionproperty 
public var layerOption:String = top

Specifies which method to use when using Identify.

Performance note: it is better to identify on as few layers as possible. 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.

layerTimeOptionsproperty 
public var layerTimeOptions:Array

Since : ArcGIS API for Flex 2.0

Array of LayerTimeOptions that allow you to override how a layer is identified in reference to the timeExtent [added in version 2.0]. Requires ArcGIS Server 10.0 or above.

See also

com.esri.ags.layers.supportClasses.LayerTimeOptions
mapExtentproperty 
public var 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 and imageDisplay 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.

maxAllowableOffsetproperty 
public var maxAllowableOffset:Number

Since : ArcGIS API for Flex 2.0

The maximum allowable offset used for generalizing geometries returned by the Identify operation. The units are the same as the returned features. Requires ArcGIS Server 10.0 or above.

returnGeometryproperty 
public var returnGeometry:Boolean = false

If true, the result set include the geometry associated with each result. Since the geometry makes up a significant portion of the response, only use when you plan to use the geometry of the feature, for example, to include them on a map.

The default value is false.

spatialReferenceproperty 
public var spatialReference:SpatialReference

The well-known ID of 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

timeExtentproperty 
public var timeExtent:TimeExtent

Since : ArcGIS API for Flex 2.0

The time instant or the time extent within which the identify should be performed [added in version 2.0]. Set the TimeExtent's startTime and endTime to the same time to define a time instant. Requires ArcGIS Server 10.0 or above.

toleranceproperty 
public var tolerance:Number = 2

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

Note: as of version 1.1, the tolerance property is now optional.

The default value is 2 pixels.

widthproperty 
public var width:Number

Width of the map currently being viewed in pixels.

Constant Detail
LAYER_OPTION_ALLConstant
public static const LAYER_OPTION_ALL:String = all

All layers are identified, even if they are not visible.

LAYER_OPTION_TOPConstant 
public static const LAYER_OPTION_TOP:String = top

Only the topmost visible layer is identified.

LAYER_OPTION_VISIBLEConstant 
public static const LAYER_OPTION_VISIBLE:String = visible

All visible layers are identified.

Examples
ActionScript to use IdentifyParameters: 
 var identifyParams:IdentifyParameters = new IdentifyParameters();
 identifyParams.geometry = mapPoint;
 identifyParams.layerOption = IdentifyParameters.LAYER_OPTION_TOP;
 identifyParams.height = myMap.height;
 identifyParams.width = myMap.width;
 identifyParams.mapExtent = myMap.extent;
 identifyParams.spatialReference = myMap.spatialReference;
 identifyTask.execute(identifyParams);



© 2008-2011 Esri, Inc. All rights reserved.

Wed Nov 30 2011, 04:19 PM -08:00