ImageServiceIdentifyParameters
require(["esri/tasks/support/ImageServiceIdentifyParameters"], function(ImageServiceIdentifyParameters) { /* code goes here */ });esri/tasks/support/ImageServiceIdentifyParametersInput parameters for ImageServiceIdentifyTask.
Constructors
- new ImageServiceIdentifyParameters(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 | The name of the class. more details | more details | Accessor | |
| Point | Polygon | Input geometry that defines the location to be identified. more details | more details | ImageServiceIdentifyParameters | |
| MosaicRule | Specifies the mosaic rules defining the image sorting order. more details | more details | ImageServiceIdentifyParameters | |
| String | Number | The pixel or RGB color value representing no information. more details | more details | ImageServiceIdentifyParameters | |
| Symbol | Specifies the pixel level being identified on the x and y axis. more details | more details | ImageServiceIdentifyParameters | |
| Number | The pixel level being identified (or the resolution being looked at) on the x-axis. more details | more details | ImageServiceIdentifyParameters | |
| Number | The pixel level being identified (or the resolution being looked at) on the y-axis. more details | more details | ImageServiceIdentifyParameters | |
| RasterFunction | Specifies the rendering rule for how the requested image should be rendered. more details | more details | ImageServiceIdentifyParameters | |
| Boolean | If | more details | ImageServiceIdentifyParameters | |
| Boolean | When | more details | ImageServiceIdentifyParameters |
Property Details
- Since: ArcGIS API for JavaScript 4.7
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.
- mosaicRuleMosaicRule
Specifies the mosaic rules defining the image sorting order. When a mosaic rule is not specified,
centeris used.
The pixel or RGB color value representing no information. It can be defined as a number
noData = 0representing a pixel value or as a stringnoData = "58,128,187"representing an RGB color value.
- pixelSizeSymbol
Specifies the pixel level being identified on the x and y axis. Defaults to the base resolution of the dataset when not specified.
- pixelSizeXNumber
The pixel level being identified (or the resolution being looked at) on the x-axis. If not specified, it will default to the base resolution of the dataset.
- pixelSizeYNumber
The pixel level being identified (or the resolution being looked at) on the y-axis. If not specified, it will default to the base resolution of the dataset.
- renderingRuleRasterFunction
Specifies the rendering rule for how the requested image should be rendered.
- returnCatalogItemsBoolean
If
true, returns both geometry and attributes of the catalog items. Set tofalsewhen catalog items are not needed to significantly improve identify operation's performance.- Default Value:true
- returnGeometryBoolean
When
true, each feature in the catalog items includes the geometry. Set tofalseto not display the features on the map.- Default Value:false
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | ImageServiceIdentifyParameters |
Method Details
- toJSON(){Object}
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.