ImageHistogramParameters

AMD: require(["esri/rest/support/ImageHistogramParameters"], (ImageHistogramParameters) => { /* code goes here */ });
ESM: import ImageHistogramParameters from "@arcgis/core/rest/support/ImageHistogramParameters.js";
Class: esri/rest/support/ImageHistogramParameters
Inheritance: ImageHistogramParameters Accessor
Since: ArcGIS Maps SDK for JavaScript 4.20

Input parameters for the computeHistograms or computeStatisticsHistograms method on ImageryLayer.

See also

Constructors

new ImageHistogramParameters(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.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
Accessor
Extent|Polygon

Input geometry that defines the area of interest for which the histograms and statistics will be computed.

more details
ImageHistogramParameters
MosaicRule

Specifies the mosaic rule on how individual images should be mosaicked when the histogram is computed.

more details
ImageHistogramParameters
PixelSize

Specifies the pixel size (or the resolution).

more details
ImageHistogramParameters
RasterFunction

Specifies the raster function from which to compute the statistics and histogram.

more details
ImageHistogramParameters
RasterFunction

A raster parameter for dynamic raster rendering input.

more details
ImageHistogramParameters
TimeExtent

The time extent for which to compute the statistics and histogram.

more details
ImageHistogramParameters

Property Details

declaredClass Stringreadonly inherited

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

geometry Extent|Polygon

Input geometry that defines the area of interest for which the histograms and statistics will be computed. The geometry can be an extent or a polygon.

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.

pixelSize PixelSizeautocast

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 RasterFunctionautocast
Since: ArcGIS Maps SDK for JavaScript 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 RasterFunctionautocast
Deprecated since version 4.27. Use rasterFunction instead.

A raster parameter for dynamic raster rendering input.

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

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
ImageHistogramParameters
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

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

more details
ImageHistogramParameters

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 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();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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.

fromJSON(json){*}static

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.

Parameter
json Object

A 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.

Returns
Type Description
* Returns a new instance of this class.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type 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");
}
removeHandles(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.