Input parameters for ImageIdentifyTask.
- See also:
Constructors
-
new ImageIdentifyParameters(properties)
-
Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | more details The name of the class. | more details | Accessor | |
Point|Polygon | more details Input geometry that defines the location to be identified. | more details | ImageIdentifyParameters | |
Number | more details Controls the maximum number of returned catalog items, set to 1 to return the top most raster only. | more details | ImageIdentifyParameters | |
MosaicRule | more details Specifies the mosaic rules defining the image sorting order. | more details | ImageIdentifyParameters | |
PixelSize | more details Specifies the pixel level being identified on the x and y axis. | more details | ImageIdentifyParameters | |
RasterFunction | more details Specifies the rendering rule for how the requested image should be rendered. | more details | ImageIdentifyParameters | |
RasterFunction | more details An array the rendering rules to retrieve multiple processed pixel values. | more details | ImageIdentifyParameters | |
Boolean | more details If | more details | ImageIdentifyParameters | |
Boolean | more details When | more details | ImageIdentifyParameters | |
Boolean | more details If | more details | ImageIdentifyParameters | |
TimeExtent | more details A time extent for a temporal data against time-aware imagery layer. | more details | ImageIdentifyParameters |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
Input geometry that defines the location to be identified. The location can be a point or a polygon.
-
maxItemCount NumberSince: ArcGIS API for JavaScript 4.20
-
Controls the maximum number of returned catalog items, set to 1 to return the top most raster only.
-
mosaicRule MosaicRuleautocast
-
Specifies the mosaic rules defining the image sorting order. When a mosaic rule is not specified,
center
is used.
-
Specifies the pixel level being identified on the x and y axis. Defaults to the base resolution of the dataset when not specified.
-
renderingRule RasterFunctionautocast
-
Specifies the rendering rule for how the requested image should be rendered.
-
renderingRules RasterFunctionSince: ArcGIS API for JavaScript 4.20
-
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 tofalse
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. Whenfalse
, the features will not display on the map.- Default Value:false
-
returnPixelValues BooleanSince: ArcGIS API for JavaScript 4.20
-
If
true
, the pixel values of all raster catalog items under the requested geometry. Set tofalse
when catalog item values are not needed to significantly improve identify operation's performance.
-
timeExtent TimeExtentautocastSince: ArcGIS API for JavaScript 4.20
-
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 details | ImageIdentifyParameters | |
Object | more details Converts an instance of this class to its ArcGIS portal JSON representation. | more details | ImageIdentifyParameters |
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 ObjectA 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.
Type Definitions
-
PixelSize Object
-
Specifies the pixel size (or the resolution). The raster at the specified pixel size in the mosaic dataset will be used for the the identify, histogram or statistics calculations on an ImageryLayer.
- Properties:
-
x Number
Represents the size of one pixel in map units along the x axis.
y NumberRepresents the size of one pixel in map units along the y axis.
spatialReference ObjectSpatial reference to be used for the request. The spatial reference of the image service will be used if not specified.
- See also:
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: { wkid: view.spatialReference.wkid } } // set the histogram parameters to request // data for the current view extent and resolution let params = new ImageHistogramParameters({ geometry: view.extent, pixelSize: pixelSize }); // request for histograms for the specified parameters layer.computeHistograms(params).then(function(results){ // results are returned and process it as needed. console.log("histograms", results); }) .catch(function(err){ console.log("err", err) });