require(["esri/renderers/smartMapping/statistics/histogram"], function(histogram) { /* code goes here */ });
Function: esri/renderers/smartMapping/statistics/histogram
Since: ArcGIS API for JavaScript 4.2

Generates a histogram based on data in a Layer for a given field. The returned object can be used for displaying a histogram in the UI within visualization authoring applications and analytical apps that query and display statistics.

Known Limitations

Only FeatureLayer, SceneLayer, and PointCloudLayer layer types are supported, except in the following scenarios:

  • FeatureLayers created with source graphics or feature collections.
  • SceneLayers without the supportsRenderer and supportsLayerQuery capabilities enabled, unless a predefined statistics object is passed to the statistics parameter of the method in conjunction with the layer. To check a SceneLayer's capabilities, use the getFieldInfoUsage() method.

Method Overview

NameReturn TypeSummaryFunction
Promise<HistogramResult>

Generates a histogram for data returned from a field in a given layer.

more details
more detailshistogram

Method Details

histogram(params){Promise<HistogramResult>}

Generates a histogram for data returned from a field in a given layer. The returned object can be used for displaying a histogram to the UI in visualization authoring applications and analytical apps that query and display statistics.

Parameters:
params Object

See the table below for details on parameters that may be passed to this function.

Specification:

The layer for which to generate a histogram.

field String
optional

The name of the numeric field for which the histogram will be generated.

normalizationField String
optional

The field by which to normalize the values returned from the given field.

classificationMethod String
optional

The method for classifying the data. See the table below for a list of possible values.

Possible ValueDescription
natural-breaksData values that cluster are placed into a single class. Class breaks occur where gaps exist between clusters. You should use this method if your data is unevenly distributed; that is, many features have the same or similar values and there are gaps between groups of values.
equal-intervalEach class has an equal range of values; in other words, the difference between the high and low value is equal for each class. You should use this method if your data is evenly distributed and you want to emphasize the difference in values between the features.
quantileEach class has roughly the same number of features. If your data is evenly distributed and you want to emphasize the difference in relative position between features, you should use the quantile classification method. If, for example, the point values are divided into five classes, points in the highest class would fall into the top fifth of all points.
standard-deviationClass breaks are placed above and below the mean value at intervals of 1, 0.5, or 0.25 standard deviations until all the data values are included in a class.
standardDeviationInterval Number
optional

When classificationMethod = "standard-deviation", this sets the interval at which each class break should be set (e.g. 0.25, 0.33, 0.5, 1).

minValue Number
optional

The minimum bounding value for the histogram. Use this in conjunction with maxValue to generate a histogram between custom lower and upper bounds.

maxValue Number
optional

The maximum bounding value for the histogram. Use this in conjunction with minValue to generate a histogram between custom lower and upper bounds.

numBins Number
optional

Indicates the number of classes to generate for the histogram.

Default Value: 10

Returns:
TypeDescription
Promise< HistogramResult>Resolves to an instance of HistogramResult.

Type Definitions

HistogramResult

The result returned from the histogram() method.

Properties:

An array of objects representing each bin in the histogram.

Specification:
count Number

The number of features that are contained between the indicated minValue and maxValue.

minValue Number

The minimum value of the bin.

maxValue Number

The maximum value of the bin.

minValue Number

The minimum value returned by the field.

maxValue Number

The maximum value returned by the field.

API Reference search results

NameTypeModule

There were no match results from your search criteria.