import HistogramViewModel from "@arcgis/core/widgets/Histogram/HistogramViewModel.js";const HistogramViewModel = await $arcgis.import("@arcgis/core/widgets/Histogram/HistogramViewModel.js");- Inheritance:
- HistogramViewModel→
Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.12
Provides the logic for the Histogram widget.
Constructors
Constructor
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
See the properties table for a list of all the
properties that may be passed into the constructor.
Properties
Any properties can be set, retrieved or listened to. See the
Watch for changes
topic.
| Property | Type | Class |
|---|---|---|
| | ||
binRange readonly | | |
HistogramBin[] | null | undefined | | |
declaredClass readonly inherited | ||
| | ||
| | ||
| | ||
range readonly | | |
state readonly | |
average
Property
The statistical average of the data in the histogram. You would typically
get this value from the avg property of
SummaryStatisticsResult,
which is the result of the
summaryStatistics function.
When set, this value will render on the histogram with a symbol indicating it is the average.
Examples
// sets result returned from a smart mapping method// to the histogramhistogramVM.average = response.statistics.avg;histogramVM.average = 34.5; binRange
readonly Property
- Type
- number
The range of values for the histogram calculated from the bins. This is calculated by subtracting the min value of the first bin from the max value of the last bin.
bins
Property
- Type
- HistogramBin[] | null | undefined
An array of objects representing each bin in the histogram. This information is typically returned from the histogram function.
Examples
// sets the bins of the histogram from the bins in the histogram() resulthistogramVM.bins = histogramResult.bins;// Creates a histogram with 7 bins.histogramVM.bins = [ { minValue: 0, maxValue: 10, count: 4 }, { minValue: 10.1, maxValue: 20, count: 14 }, { minValue: 20.1, maxValue: 30, count: 9 }, { minValue: 30.1, maxValue: 40, count: 34 }, { minValue: 40.1, maxValue: 50, count: 351 }, { minValue: 50.1, maxValue: 60, count: 100 }, { minValue: 60.1, maxValue: 70, count: 1 }]; labelFormatFunction
Property
- Type
- HistogramLabelFormatFunction | null | undefined
A function used to format labels. Overrides the default label formatter.
Example
// For thumb values, rounds each label to whole numbers.slider.viewModel.labelFormatFunction = function(value) { return value.toFixed(0);}