ImageHistogramParameters

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

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
more detailsAccessor
Extent|Polygon

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

more details
more detailsImageHistogramParameters
MosaicRule

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

more details
more detailsImageHistogramParameters
PixelSize

Specifies the pixel size (or the resolution).

more details
more detailsImageHistogramParameters
RasterFunction

Specifies the rendering rule from which to compute the statistics and histogram.

more details
more detailsImageHistogramParameters
TimeExtent

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

more details
more detailsImageHistogramParameters

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 MosaicRule

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 PixelSize

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.

renderingRule RasterFunction

Specifies the rendering rule from which to compute the statistics and histogram. The renderingRule defines how the image should be rendered. When a renderingRule is not specified, the current settings on the ImageryLayer will be used.

timeExtent TimeExtent

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
*

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

more details
more detailsImageHistogramParameters
Object

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

more details
more detailsImageHistogramParameters

Method Details

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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.
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.