Hide Table of Contents
esri/dijit/util
esri/layer/pixelFilters
esri/process
esri/workers
Class: ImageServiceIdentifyParameters

require(["esri/tasks/ImageServiceIdentifyParameters"], function(ImageServiceIdentifyParameters) { /* code goes here */ });

Description

(Added at v2.0)
Input parameters for the ImageServiceIdentifyTask.

Samples

Search for samples that use this class.

Constructors

NameSummary
new ImageServiceIdentifyParameters()Creates a new ImageServiceIdentifyParameters object.

Properties

NameTypeSummary
geometryGeometryInput geometry that defines the location to be identified.
mosaicRuleMosaicRuleSpecifies the mosaic rules defining the image sorting order.
noDataString | NumberThe pixel or RGB color value representing no information.
noDataInterpretationStringUsed along with the noData property.
pixelSizeSymbolSpecify the pixel level being identified on the x and y axis.
pixelSizeXNumberThe pixel level being identified (or the resolution being looked at) on the x-axis.
pixelSizeYNumberThe pixel level being identified (or the resolution being looked at) on the y-axis.
renderingRuleRasterFunctionSpecifies the rendering rule for how the requested image should be rendered.
returnCatalogItemsBooleanIf "true", returns both geometry and attributes of the catalog items.
returnGeometryBooleanWhen true, each feature in the catalog items includes the geometry.
timeExtentTimeExtentSpecify a time extent.
Constructor Details

new ImageServiceIdentifyParameters()

Creates a new ImageServiceIdentifyParameters object.
Sample:
require([
  "esri/tasks/ImageServiceIdentifyParameters", "esri/geometry/Point", ... 
], function(ImageServiceIdentifyParameters, Point, ... ) {
  var imageParams = new ImageServiceIdentifyParameters();
  var point = new Point( ... );
  imageParams.geometry = point;
  ...
});
Property Details

<Geometry> geometry

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

<MosaicRule> mosaicRule

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

<String | Number> noData

The pixel or RGB color value representing no information. It can be defined as a number noData=0 where it is a pixel value or as a string noData="58,128,187" where it is an RGB color value. (Added at v3.6)

<String> noDataInterpretation

Used along with the noData property. (Added at v3.6)
Known values: NODATA_MATCH_ALL | NODATA_MATCH_ANY

<Symbol> pixelSize

Specify the pixel level being identified on the x and y axis. Defaults to the base resolution of the dataset when not specified. (Added at v3.5)

<Number> pixelSizeX

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.

<Number> pixelSizeY

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.

<RasterFunction> renderingRule

Specifies the rendering rule for how the requested image should be rendered. View the Raster Functions help topic in the REST help for more details. (Added at v3.7)
Sample:
require([
  "esri/tasks/ImageServiceIdentifyParameters", "esri/layers/RasterFunction", ... 
], function(ImageServiceIdentifyParameters, RasterFunction, ... ) {
  var params = new ImageServiceIdentifyParameters();
  var rasterFunction = new RasterFunction();
  rasterFunction.functionName = "Hillshade";

  rasterFunction.arguments = {
    "Azimuth":215.0,
    "Altitude":75.0,
    "ZFactor":0.3
  };
  rasterFunction.variableName = "DEM";
  params.renderingRule = rasterFunction;
  ...
});

<Boolean> returnCatalogItems

If "true", returns both geometry and attributes of the catalog items. Set it to false when catalog items are not needed to improve identify operation's performance significantly. (Added at v3.6)
Known values: true | false

<Boolean> returnGeometry

When true, each feature in the catalog items includes the geometry. Set to false if the features will not be displayed on the map. The default value is false. (Added at v3.5)
Known values: true | false

<TimeExtent> timeExtent

Specify a time extent. (Added at v3.5)