ImageServiceIdentifyParameters

AMD: require(["esri/tasks/support/ImageServiceIdentifyParameters"], (ImageServiceIdentifyParameters) => { /* code goes here */ });
ESM: import ImageServiceIdentifyParameters from "@arcgis/core/tasks/support/ImageServiceIdentifyParameters";
Class: esri/tasks/support/ImageServiceIdentifyParameters
Inheritance: ImageServiceIdentifyParameters Accessor
Since: ArcGIS API for JavaScript 4.0
Deprecated since version 4.18. Use ImageIdentifyParameters instead.

Input parameters for ImageServiceIdentifyTask.

See also:

Constructors

new ImageServiceIdentifyParameters(properties)
Parameter:
properties Object
optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Point|Polygonmore details

Input geometry that defines the location to be identified.

more detailsImageServiceIdentifyParameters
Numbermore details

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

more detailsImageServiceIdentifyParameters
MosaicRulemore details

Specifies the mosaic rules defining the image sorting order.

more detailsImageServiceIdentifyParameters
Pointmore details

Specifies the pixel level being identified on the x and y axis.

more detailsImageServiceIdentifyParameters
RasterFunctionmore details

Specifies the rendering rule for how the requested image should be rendered.

more detailsImageServiceIdentifyParameters
RasterFunctionmore details

An array the rendering rules to retrieve multiple processed pixel values.

more detailsImageServiceIdentifyParameters
Booleanmore details

If true, returns both geometry and attributes of the catalog items.

more detailsImageServiceIdentifyParameters
Booleanmore details

When true, each feature in the catalog items includes the geometry.

more detailsImageServiceIdentifyParameters
Booleanmore details

If true, the pixel values of all raster catalog items under the requested geometry.

more detailsImageServiceIdentifyParameters
TimeExtentmore details

A time extent for a temporal data against time-aware imagery layer.

more detailsImageServiceIdentifyParameters

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

geometry Point|Polygon

Input geometry that defines the location to be identified. The location can be a point or a polygon.

maxItemCount Number
Since: ArcGIS API for JavaScript 4.12

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

mosaicRule MosaicRule

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

pixelSize Point

Specifies the pixel level being identified on the x and y axis. Defaults to the base resolution of the dataset when not specified.

renderingRule RasterFunction

Specifies the rendering rule for how the requested image should be rendered.

renderingRules RasterFunction
Since: ArcGIS API for JavaScript 4.12

An array the rendering rules to retrieve multiple processed pixel values.

returnCatalogItems 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.

returnGeometry Boolean

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

Default Value:false
returnPixelValues Boolean
Since: ArcGIS API for JavaScript 4.12

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.

timeExtent TimeExtent
Since: ArcGIS API for JavaScript 4.12

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.

Method Overview

Name Return Type Summary Class
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsImageServiceIdentifyParameters
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsImageServiceIdentifyParameters

Method Details

fromJSON(json){*}static

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.

Parameter:
json Object

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:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

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

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.