Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: IdentifyParameters
[ AMD Module Require | Legacy Module Require ]
require(["esri/tasks/IdentifyParameters"], function(IdentifyParameters) { /* code goes here */ });
Description
(Added at v1.0)
This data object is used as the identifyParameters argument to IdentifyTask.execute method. It specifies the criteria used to identify the features.Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new IdentifyParameters() | Creates a new IdentifyParameters object. |
Constants
| Name | 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. |
Properties
| Name | Type | Summary |
|---|---|---|
| dpi | Number | Resolution of the current map view in dots per inch. |
| dynamicLayerInfos | DynamicLayerInfo[] | An array of DynamicLayerInfos used to change the layer ordering or redefine the map. |
| geometry | Geometry | The geometry used to select features during Identify. |
| geometryPrecision | Number | Specifies the number of decimal places for the geometries returned by the query operation. |
| height | Number | Height of the map currently being viewed in pixels. |
| layerDefinitions | String[] | Array of layer definition expressions that allows you to filter the features of individual layers. |
| layerIds | Number[] | The layers to perform the identify operation on. |
| layerOption | String | Specifies which layers to use when using Identify. |
| layerTimeOptions | LayerTimeOptions[] | Array of LayerTimeOptions objects that allow you to define time options for the specified layers. |
| mapExtent | Extent | The Extent or bounding box of the map currently being viewed. |
| maxAllowableOffset | Number | The maximum allowable offset used for generalizing geometries returned by the identify operation. |
| returnFieldName | Boolean | If true, field names will be returned instead of field aliases. |
| returnGeometry | Boolean | If "true", the result set includes the geometry associated with each result. |
| returnUnformattedValues | Boolean | If true, the values in the result will not be formatted i.e. |
| spatialReference | SpatialReference | The spatial reference of the input and output geometries as well as of the mapExtent. |
| timeExtent | TimeExtent | Specify the time extent used by the identify task. |
| 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. |
Constructor Details
Creates a new IdentifyParameters object. The constructor takes no parameters.
Sample:
require([
"esri/tasks/IdentifyParameters", ...
], function(IdentifyParameters, ... ) {
var identifyParams = new IdentifyParameters();
...
});
Property Details
<DynamicLayerInfo[]
DynamicLayerInfo[]An array of DynamicLayerInfos used to change the layer ordering or redefine the map. When set the Identify operation will perform the identify against the dynamic layers. (Added at v2.7)
<Geometry
GeometryThe 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.
Sample:
identifyParams.geometry = evt.mapPoint;
<Number
NumberSpecifies the number of decimal places for the geometries returned by the query operation. (Added at v3.14)
Sample:
params.geometryPrecision = 1;<Number
NumberHeight of the map currently being viewed in pixels.
Sample:
require([
"esri/map", "esri/tasks/IdentifyParams", ...
], function(Map, IdentifyParams, ... ) {
var map = new Map( ... );
var identifyParams = new IdentifyParams();
identifyParams.height = map.height;
...
});
<String[]
String[]Array of layer definition expressions that allows you to filter the features of individual layers. Layer definitions with semicolons or colons are supported if using a map service published using ArcGIS Server 10.
Sample:
identifyParams.layerDefinitions[23] = "LANDUSE = 'COM'";
<Number[]
Number[]The layers to perform the identify operation on. The layers are specified as a comma-separated list of layer ids. The list of ids is returned in ArcGISDynamicMapServiceLayer layerInfos.
Sample:
identifyParams.layerIds = [23,25];
<String
StringSpecifies which layers to use when using Identify. See the Constants table for valid values.
Default value:
LAYER_OPTION_TOPSample:
require([
"esri/tasks/IdentifyParameters", ...
], function(IdentifyParameters, ... ) {
identifyParams.layerOption = IdentifyParameters.LAYER_OPTION_ALL;
...
});
<LayerTimeOptions[]
LayerTimeOptions[]Array of LayerTimeOptions objects that allow you to define time options for the specified layers. There is one object per sub-layer.
Sample:
require([
"esri/layers/LayerTimeOptions", "esri/layers/TimeInfo", ...
], function(LayerTimeOptions, TimeInfo, ... ) {
var timeOption1 = new LayerTimeOptions();
timeOption1.timeOffset = 4;
timeOption1.timeOffsetUnits = TimeInfo.UNIT_YEARS;
var options = [];
options[2]= timeOption1;
options[5] = timeOption2;
identifyParameters.layerTimeOptions = options;
...
});
<Extent
ExtentThe 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 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.
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.
Sample:
identifyParams.mapExtent = map.extent;
<Number
NumberThe 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 map is used. (Added at v2.0)
<Boolean
BooleanIf true, field names will be returned instead of field aliases. In case with layers with joins, fully qualified field names will be returned. Requires ArcGIS Server service 10.5 or greater. (Added at v3.22)
Default value:
falseSample:
identifyParams.returnFieldName = true;
<Boolean
BooleanIf "true", the result set includes the geometry associated with each result. The default is "false".
Known values:
true | falseDefault value:
falseSample:
identifyParams.returnGeometry = true;
<Boolean
BooleanIf 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. Subtype and domain values will be returned as numeric values instead of descriptions. Requires ArcGIS Server service 10.5 or greater. (Added at v3.22)
Default value:
falseSample:
identifyParams.returnUnformattedValues = true;
<SpatialReference
SpatialReferenceThe 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 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.
<TimeExtent
TimeExtentSpecify the time extent used by the identify task.
<Number
NumberThe distance in screen pixels from the specified geometry within which the identify should be performed.
Sample:
identifyParams.tolerance = 3;
<Number
NumberWidth of the map currently being viewed in pixels.
Sample:
require([
"esri/map", "esri/tasks/IdentifyParams", ...
], function(Map, IdentifyParams, ... ) {
var map = new Map( ... );
var identifyParams = new IdentifyParams();
identifyParams.width = map.width;
...
});