ImageIdentifyParameters | References | ArcGIS Maps SDK for JavaScript

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

Inheritance:: ImageIdentifyParameters→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.20

Input parameters for imageService.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`ImageIdentifyParametersProperties`

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
`geometry`	`Point \| Polygon \| Extent`
`maxItemCount`	`number \| null \| undefined`
`mosaicRule`	`MosaicRule \| null \| undefined`
`pixelSize`	`Point \| null \| undefined`
`processAsMultidimensional`	`boolean`
`rasterFunction`	`RasterFunction \| null \| undefined`
`rasterFunctions`	`RasterFunction[] \| null \| undefined`
`returnCatalogItems`	`boolean`
`returnGeometry`	`boolean`
`returnPixelValues`	`boolean`
`timeExtent`	`TimeExtent \| null \| undefined`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

geometry

autocast Property

Type: Point | Polygon | Extent

Input geometry that defines the location to be identified. The location can be a point, a polygon or extent (requires 10.9.1 or newer server).

maxItemCount

Property

Type: number | null | undefined

Controls the maximum number of returned catalog items, set to 1 to return the top most raster only.

mosaicRule

autocast Property

Type: MosaicRule | null | undefined

Specifies the mosaic rules defining the image sorting order. When a mosaic rule is not specified, center is used.

pixelSize

autocast Property

Type: Point | null | undefined

Specifies the pixel level being identified on the x and y axis. Defaults to the base resolution of the dataset when not specified. The raster at the specified pixel size in the mosaic dataset will be used for the the ImageryLayer.identify() operation on an ImageryLayer.

Example

// set the pixel size parameter to match the current
// resolution of the view and spatial reference
let pixelSize = {
  x:view.resolution,
  y:view.resolution,
  spatialReference: view.spatialReference
}
// set the identify parameters
// data for the current view extent and resolution
let params = new ImageIdentifyParameters({
  geometry:  view.extent,
  pixelSize: pixelSize
});

// request info for a given location for the specified parameters
layer.identify(params).then((result) => {
  // results are returned and process it as needed.
  console.log("identify result", result);
})
.catch(function(error){
  console.log("error", error)
});

processAsMultidimensional

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 4.23

When true, the request is processed for all variables and dimensions. Pixel values from all slices along with additional properties describing the slices, will be returned. When false, the request is processed for the first or selected slices only. It is only applicable when the service is multidimensional. This capability is only available with image services published with ArcGIS Server 10.9 or greater.

Default value: false

rasterFunction

autocast Property

Type: RasterFunction | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.27

Specifies the raster function for how the requested image should be processed.

rasterFunctions

autocast Property

Type: RasterFunction[] | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.27

An array the raster functions to retrieve multiple processed pixel values.

returnCatalogItems

Property

Type: boolean

If true, returns both geometry and attributes of the catalog items. Set to false when catalog items are not needed to significantly improve identify operation's performance.

Default value: true

returnGeometry

Property

Type: boolean

When true, each feature in the catalog items includes the geometry. When false, the features will not display on the map.

Default value: true

returnPixelValues

Property

Type: boolean

If true, the pixel values of all raster catalog items under the requested geometry. Set to false when catalog item values are not needed to significantly improve identify operation's performance.

Default value: true

timeExtent

autocast Property

Type: TimeExtent | null | undefined

A time extent for a temporal data against time-aware imagery layer. For example, it can be used to discover land cover changes by decade.

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.