Generates a histogram for statistical purposes.more details
Generates a histogram for statistical purposes. 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.optionalfield String
The name of the numeric field for which the histogram will be generated.optionalnormalizationField String
The field by which to normalize the values returned from the given
The method for classifying the data. See the table below for a list of possible values.
Possible Value Description natural-breaks Data 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-interval Each 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. quantile Each 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-deviation Class breaks are placed above and below the mean value at intervals of
0.25standard deviations until all the data values are included in a class.optionalstandardDeviationInterval Number
classificationMethod = "standard-deviation", this sets the interval at which each class break should be set (e.g.
The minimum bounding value for the histogram. Use this in conjunction with
maxValueto generate a histogram between custom lower and upper bounds.
The maximum bounding value for the histogram. Use this in conjunction with
minValueto generate a histogram between custom lower and upper bounds.optionalnumBins Number
Indicates the number of classes to generate for the histogram.
Default Value: 10Returns:
Type Description Promise Resolves to an instance of HistogramResult.
The result returned from the histogram() method.Properties:bins Object
An array of objects representing each bin in the histogram.Specification:count Number
The number of features that are contained between the indicated
The minimum value of the bin.
The maximum value of the bin.
The minimum value returned by the field.
The maximum value returned by the field.