ImageServiceIdentifyParameters

require(["esri/tasks/support/ImageServiceIdentifyParameters"], function(ImageServiceIdentifyParameters) { /* code goes here */ });
Class: esri/tasks/support/ImageServiceIdentifyParameters
Inheritance: ImageServiceIdentifyParameters Accessor
Since: ArcGIS API for JavaScript 4.0

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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
Point | Polygon

Input geometry that defines the location to be identified.

more details
more detailsImageServiceIdentifyParameters
MosaicRule

Specifies the mosaic rules defining the image sorting order.

more details
more detailsImageServiceIdentifyParameters
String | Number

The pixel or RGB color value representing no information.

more details
more detailsImageServiceIdentifyParameters
Symbol

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

more details
more detailsImageServiceIdentifyParameters
Number

The pixel level being identified (or the resolution being looked at) on the x-axis.

more details
more detailsImageServiceIdentifyParameters
Number

The pixel level being identified (or the resolution being looked at) on the y-axis.

more details
more detailsImageServiceIdentifyParameters
RasterFunction

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

more details
more detailsImageServiceIdentifyParameters
Boolean

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

more details
more detailsImageServiceIdentifyParameters
Boolean

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

more details
more detailsImageServiceIdentifyParameters

Property Details

declaredClassStringreadonly inherited

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

geometryPoint|Polygon

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, center is used.

The pixel or RGB color value representing no information. It can be defined as a number noData = 0 representing a pixel value or as a string noData = "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 to false when 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 to false to not display the features on the map.

Default Value: false

Method Overview

NameReturn TypeSummaryClass
Object

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

more details
more detailsImageServiceIdentifyParameters

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:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.