require(["esri/rest/support/ImageHistogramParameters"], (ImageHistogramParameters) => { /* code goes here */ });
import ImageHistogramParameters from "@arcgis/core/rest/support/ImageHistogramParameters.js";
esri/rest/support/ImageHistogramParameters
Input parameters for the computeHistograms or computeStatisticsHistograms method on ImageryLayer, or the computeStatisticsHistograms method on ImageryTileLayer.
- See also
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The name of the class. | Accessor | ||
Input geometry that defines the area of interest for which the histograms and statistics will be computed. | ImageHistogramParameters | ||
Specifies the mosaic rule on how individual images should be mosaicked when the histogram is computed. | ImageHistogramParameters | ||
Specifies the pixel size (or the resolution). | ImageHistogramParameters | ||
Specifies the raster function from which to compute the statistics and histogram. | ImageHistogramParameters | ||
A raster parameter for dynamic raster rendering input. | ImageHistogramParameters | ||
The time extent for which to compute the statistics and histogram. | ImageHistogramParameters |
Property Details
-
mosaicRule
mosaicRule MosaicRuleautocast
-
Specifies the mosaic rule on how individual images should be mosaicked when the histogram is computed. When a mosaic rule is not specified, the current settings on the ImageryLayer will be used.
-
Specifies the pixel size (or the resolution). If pixel size is not specified,
pixelSize
will default to the base resolution of the image service. The raster at the specified pixel size in the mosaic dataset will be used for the histogram calculation.
-
rasterFunction
rasterFunction RasterFunctionautocast
Since: ArcGIS Maps SDK for JavaScript 4.27ImageHistogramParameters since 4.20, rasterFunction added at 4.27. -
Specifies the raster function from which to compute the statistics and histogram. The rasterFunction defines how the image should be processed. When a renderingRule is not specified, the current settings on the ImageryLayer will be used.
-
renderingRule
renderingRule RasterFunctionautocast
Deprecated since version 4.27. Use rasterFunction instead. -
A raster parameter for dynamic raster rendering input.
-
timeExtent
timeExtent TimeExtentautocast
-
The time extent for which to compute the statistics and histogram. The time parameter is supported at ArcGIS Server 10.8 and later.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | ImageHistogramParameters | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | ImageHistogramParameters |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
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.Parameterjson 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.