Skip To ContentArcGIS for DevelopersSign In Dashboard

HistogramViewModel

require(["esri/widgets/Histogram/HistogramViewModel"], function(HistogramVM) { /* code goes here */ });
Class: esri/widgets/Histogram/HistogramViewModel
Inheritance: HistogramViewModel Accessor
Since: ArcGIS API for JavaScript 4.12

Provides the logic for the Histogram widget.

See also:

Constructors

new HistogramViewModel(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.
NameTypeSummaryClass
Number

The statistical average of the data in the histogram.

more details
more detailsHistogramViewModel
Number

The range of values for the histogram calculated from the bins.

more details
more detailsHistogramViewModel
Bin[]

An array of objects representing each bin in the histogram.

more details
more detailsHistogramViewModel
String

The name of the class.

more details
more detailsAccessor
LabelFormatter

A function used to format labels.

more details
more detailsHistogramViewModel
Number

The maximum value or bound of the entire histogram.

more details
more detailsHistogramViewModel
Number

The minimum value or bound of the entire histogram.

more details
more detailsHistogramViewModel
Number

The range of values for the histogram.

more details
more detailsHistogramViewModel
String

The current state of the view model.

more details
more detailsHistogramViewModel

Property Details

average Number

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 histogram
histogramVM.average = response.statistics.avg;
histogramVM.average = 34.5;
binRange Numberreadonly

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 Bin[]

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() result
histogramVM.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 }
];
declaredClass Stringreadonly inherited

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

labelFormatFunction LabelFormatter

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);
}
max Number

The maximum value or bound of the entire histogram. This should match the maximum bound of the last bin.

Examples:
histogramVM.max = 100;
// sets result returned from a smart mapping method
// to the histogram
histogramVM.max = response.statistics.max;
min Number

The minimum value or bound of the entire histogram. This should match the minimum bound of the first bin.

Examples:
histogramVM.min = 0;
// sets result returned from a smart mapping method
// to the histogram
histogramVM.min = response.statistics.min;
range Numberreadonly

The range of values for the histogram. This is calculated by subtracting the min from the max.

state Stringreadonly

The current state of the view model.

Possible Values: ready | disabled

API Reference search results

NameTypeModule
Loading...