Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: ImageServiceIdentifyParameters
[ AMD Module Require | Legacy Module Require ]
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
| Name | Summary |
|---|---|
| new ImageServiceIdentifyParameters() | Creates a new ImageServiceIdentifyParameters object. |
Properties
| Name | Type | Summary |
|---|---|---|
| geometry | Geometry | Input geometry that defines the location to be identified. |
| maxItemCount | Number | If the returnCatalogItems parameter is set to true, this parameter will take effect. |
| mosaicRule | MosaicRule | Specifies the mosaic rules defining the image sorting order. |
| noData | String | Number | The pixel or RGB color value representing no information. |
| noDataInterpretation | String | Used along with the noData property. |
| pixelSize | Symbol | Specify the pixel level being identified on the x and y axis. |
| pixelSizeX | Number | The pixel level being identified (or the resolution being looked at) on the x-axis. |
| pixelSizeY | Number | The pixel level being identified (or the resolution being looked at) on the y-axis. |
| renderingRule | RasterFunction | Specifies the rendering rule for how the requested image should be rendered. |
| returnCatalogItems | Boolean | If "true", returns both geometry and attributes of the catalog items. |
| returnGeometry | Boolean | When true, each feature in the catalog items includes the geometry. |
| returnPixelValues | Boolean | If true, returns the pixel values of all mosaicked raster catalog items under the requested geometry. |
| timeExtent | TimeExtent | Specify a time extent. |
Constructor Details
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
GeometryInput geometry that defines the location to be identified. The location can be a point or a polygon.
<Number
NumberIf the
returnCatalogItems parameter is set to true, this parameter will take effect. The default behavior is to return all raster catalog items within the requested geometry. Otherwise, the number of items returned will be the value specified in the maxItemCount or all eligible items, whichever number is smaller. Setting the property to 1 will return only the topmost raster and can improve the identify operation's performance significantly. Requires ArcGIS Enterprise 10.6.1 services. (Added at v3.25)<MosaicRule
MosaicRuleSpecifies the mosaic rules defining the image sorting order. When a mosaic rule is not specified, METHOD_CENTER is used.
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
StringUsed along with the noData property. (Added at v3.6)
Known values:
NODATA_MATCH_ALL | NODATA_MATCH_ANY<Symbol
SymbolSpecify 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
NumberThe 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
NumberThe 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
RasterFunctionSpecifies 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
BooleanIf "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
BooleanWhen 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<Boolean
BooleanIf
true, returns the pixel values of all mosaicked raster catalog items under the requested geometry. Set it to false when only the pixel value of mosaicked output is needed at requested geometry. Requires ArcGIS Enterprise 10.6.1 services. (Added at v3.25)Known values:
true | falseDefault value:
true<TimeExtent
TimeExtentSpecify a time extent. (Added at v3.5)