IdentifyParameters | References | ArcGIS Maps SDK for JavaScript

import IdentifyParameters from "@arcgis/core/rest/support/IdentifyParameters.js";

Inheritance:: IdentifyParameters→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.20

Input parameters for the identify.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`IdentifyParametersProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`dpi`	`number`
`gdbVersion`	`string \| null \| undefined`
`geometry`	`GeometryUnion \| null \| undefined`
`geometryPrecision`	`number \| null \| undefined`
`height`	`number`
`historicMoment`	`Date \| null \| undefined`
`layerIds`	`number[] \| null \| undefined`
`layerOption`	`"top" \| "visible" \| "all" \| "popup"`
`mapExtent`	`Extent \| null \| undefined`
`maxAllowableOffset`	`number \| null \| undefined`
`returnFieldName`	`boolean`
`returnGeometry`	`boolean`
`returnM`	`boolean`
`returnUnformattedValues`	`boolean`
`returnZ`	`boolean`
`spatialReference`	`SpatialReference \| null \| undefined`
`sublayers`	`Collection<Sublayer> \| null \| undefined`
`timeExtent`	`TimeExtent \| null \| undefined`
`tolerance`	`number \| null \| undefined`
`width`	`number`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

dpi

Property

Type: number

Resolution of the current map view in dots per inch.

Default value: 96

gdbVersion

Property

Type: string | null | undefined

Specify the geodatabase version to search.

geometry

autocast Property

Type: GeometryUnion | null | undefined

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.

geometryPrecision

Property

Type: number | null | undefined

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

height

Property

Type: number

Height of the View in pixels.

Default value: 400

historicMoment

autocast Property

Type: Date | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.29

The historic moment to identify. This parameter applies only if the supportsQueryWithHistoricMoment capability of the service being queried is true. This setting is provided in the layer resource.

layerIds

Property

Type: number[] | null | undefined

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

layerOption

Property

Type: "top" | "visible" | "all" | "popup"

Specifies which layers to use when using Identify.

Possible values	Description
top	Only the top-most visible layer on the service is identified.
visible	All visible layers on the service are identified.
all	All layers on the service 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.
popup	All visible layers with a popupTemplate. `sublayers` is required for this option.

Default value: "top"

mapExtent

autocast Property

Type: Extent | null | undefined

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.

maxAllowableOffset

Property

Type: number | null | undefined

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.

returnFieldName

Property

Type: boolean

If true, field names will be returned instead of field aliases. Requires ArcGIS Server service 10.5 or greater.

Default value: true

returnGeometry

Property

Type: boolean

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

Default value: false

returnM

Property

Type: boolean

When true, indicates that M values will be returned.

Default value: false

returnUnformattedValues

Property

Type: boolean

If 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. Requires ArcGIS Server service 10.5 or greater.

Default value: true

returnZ

Property

Type: boolean

When true, indicates that z-values will be returned.

Default value: false

spatialReference

autocast Property

Type: SpatialReference | null | undefined

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.

sublayers

autocast Property

Type: Collection<Sublayer> | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.22

An Collection of Sublayer objects used to change the layer ordering and/or rendering, or redefine the map.

Usually this property is set with the layer's MapImageLayer.sublayers.

See also

Identify - ArcGIS Server REST API

Example

const {
  extent: maxExtent,
  spatialReference,
  width,
  height,
  timeExtent,
} = view;

const parameters = new IdentifyParameters({
  sublayers: layer.sublayers,
  layerOption: "popup",
  returnGeometry: true,
  geometry: maxExtent.center,
  tolerance: 5,
  height,
  mapExtent,
  spatialReference,
  timeExtent,
  width,
});

identify(layer.url, parameters).then((response) => {
  // process the response
});

timeExtent

autocast Property

Type: TimeExtent | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.22

Specify the time extent used by identify.

tolerance

Property

Type: number | null | undefined

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

width

Property

Type: number

Width of the current map view in pixels.

Default value: 400

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameters

Parameter	Type	Description	Required
json	`any`	A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns: any
Returns a new instance of this class.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.