import HistogramRangeSliderViewModel from "@arcgis/core/widgets/HistogramRangeSlider/HistogramRangeSliderViewModel.js";const HistogramRangeSliderViewModel = await $arcgis.import("@arcgis/core/widgets/HistogramRangeSlider/HistogramRangeSliderViewModel.js");- Inheritance:
- HistogramRangeSliderViewModel→
SliderViewModel→ Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.12
Provides the logic for the HistogramRangeSlider widget.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
| | ||
HistogramBin[] | null | undefined | | |
declaredClass readonly inherited | ||
effectiveMax inherited | ||
effectiveMin inherited | ||
inputFormatFunction inherited | ||
inputParseFunction inherited | ||
| | ||
labels readonly inherited | ||
max inherited | ||
min inherited | ||
precision inherited | ||
| | ||
| | ||
state readonly inherited | ||
thumbsConstrained inherited | ||
values inherited |
average
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.
Examples
// sets result returned from a smart mapping method// to the histogramhistogramSliderVM.average = response.statistics.avg;histogramSliderVM.average = 34.5; bins
- 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 }]; effectiveMax
- Since
- ArcGIS Maps SDK for JavaScript 4.23
When set, the user is restricted from moving slider thumbs to positions higher than
this value. This value should be less than the slider max.
The effectiveMax and effectiveMin allow you to represent ranges of values in a dataset that cannot
be filtered or selected with the slider. This can be useful when using the slider to
represent datasets with outliers, or scale ranges not suitable for a layer.
Example
// slider.viewModel.max = 100slider.viewModel.effectiveMax = 60;// now the user cannot slide thumbs above// 60 even though the slider track displays// values up to 100. effectiveMin
- Since
- ArcGIS Maps SDK for JavaScript 4.23
When set, the user is restricted from moving slider thumbs to positions less than
this value. This value should be greater than the slider min.
The effectiveMin and effectiveMax allow you to represent ranges of values in a dataset that cannot
be filtered or selected with the slider. This can be useful when using the slider to
represent datasets with outliers, or scale ranges not suitable for a layer.
Example
// slider.viewModel.min = 0slider.viewModel.effectiveMin = 4;// now the user cannot slide thumbs below// 4 even though the slider track displays// values down to 0. inputFormatFunction
- Type
- InputFormatFunction | null | undefined
A function used to format user inputs. As opposed to labelFormatFunction, which formats
thumb labels, the inputFormatFunction formats thumb values in the input element when the user begins
to edit them.
The image below demonstrates how slider input values resemble corresponding slider values by default
and won't match the formatting set in labelFormatFunction.
If you want to format slider input values so they match thumb labels, you can pass the same function set in labelFormatFunction to
inputFormatFunction for consistent formatting.
However, if an inputFormatFunction is specified, you must also write a corresponding
inputParseFunction to parse user inputs to understandable slider values. In most cases, if
you specify an inputFormatFunction, you should set the labelFormatFunction to the same value
for consistency between labels and inputs.
This property overrides the default input formatter, which formats by calling toString() on the input value.
- See also
Example
// Formats the slider input to abbreviated numbers with units// e.g. a thumb at position 1500 will render with an input label of 1.5kslider.inputFormatFunction = function(value, type){ if(value >= 1000000){ return (value / 1000000).toPrecision(3) + "m" } if(value >= 100000){ return (value / 1000).toPrecision(3) + "k" } if(value >= 1000){ return (value / 1000).toPrecision(2) + "k" } return value.toFixed(0);} inputParseFunction
- Type
- InputParseFunction | null | undefined
Function used to parse slider inputs formatted by the inputFormatFunction.
This property must be set if an inputFormatFunction is set. Otherwise the slider values will
likely not update to their expected positions.
Overrides the default input parses, which is a parsed floating point number.
- See also
Example
// Parses the slider input (a string value) to a number value understandable to the slider// This assumes the slider was already configured with an inputFormatFunction// For example, if the input is 1.5k this function will parse// it to a value of 1500slider.inputParseFunction = function(value, type, index){ let charLength = value.length; let valuePrefix = parseFloat(value.substring(0,charLength-1)); let finalChar = value.substring(charLength-1);
if(parseFloat(finalChar) >= 0){ return parseFloat(value); } if(finalChar === "k"){ return valuePrefix * 1000; } if(finalChar === "m"){ return valuePrefix * 1000000; } return value;} labelFormatFunction
- Type
- LabelFormatFunction
A modified version of SliderViewModel.labelFormatFunction, which is a custom function used to format labels. Overrides the default label formatter.
Example
// For thumb values, rounds each label to whole numbers.// Note the actual value of the thumb continues to be stored// based on the indicated data `precision` despite this formattingsliderViewModel.labelFormatFunction = function(value, type) { return (type === "value") ? value.toFixed(0) : value;} labels
- Type
- LabelInfos
An array of strings associated with values generated using an internal label formatter or the values returned from labelFormatFunction.
max
The maximum possible data/thumb value of the slider. In the constructor, if one of the values
specified in values is greater than the max value specified
in this property, then the max will update to the highest value in values.
Example
sliderViewModel.max = 100; min
The minimum possible data/thumb value of the slider. In the constructor, if one of the values
specified in values is less than the min value specified
in this property, then the min will update to the lowest value in values.
Example
sliderViewModel.min = 0; precision
- Type
- number
Defines how slider values should be rounded. This number indicates the number of decimal places slider values should round to when they have been moved.
This value also indicates the precision of thumb labels when the data range
(max - min) is less than 10.
When the data range is larger than 10, labels display with a precision of
no more than two decimal places, though actual slider thumb values will maintain the
precision specified in this property.
For example, given the default precision of 4, and the following slider configuration,
The label of the thumb will display two decimal places, but the precision of the actual
thumb value will not be lost even when the user slides or moves the thumb.
const slider = new SliderVM({ min: 20, max: 100, // data range of 80 values: [50.4331], // thumb label will display 50.43 // thumb value will maintain precision, so // value will remain at 50.4331});If the user manually enters a value that has a higher precision than what's indicated by this property, the precision of that thumb value will be maintained until the thumb is moved by the user. At that point, the value will be rounded according to the indicated precision.
If thumb labels aren't visible, they must be enabled with Slider.labelInputsEnabled.
Keep in mind this property rounds thumb values and shouldn't be used exclusively
for formatting purposes. To format thumb labels, use the labelFormatFunction
property.
- Default value
- 4
Example
sliderViewModel.precision = 7; rangeType
- Type
- RangeType
Determines the SQL where clause generated in generateWhereClause() for filtering purposes. The value set here determines the number of values allowed on the slider.
See the table below for a description and requirements of all possible values. value1 refers to
the value of the first thumb position. value2 refers to the value of the final thumb position, if applicable.
| Possible Value | Number of values | Where clause |
|---|---|---|
| equal | 1 | ${field} = ${value1} |
| not-equal | 1 | ${field} <> ${value1} |
| less-than | 1 | ${field} < ${value1} |
| greater-than | 1 | ${field} > ${value1} |
| at-most | 1 | ${field} <= ${value1} |
| at-least | 1 | ${field} >= ${value1} |
| between | 2 | ${field} BETWEEN ${value1} AND ${value2} |
| not-between | 2 | ${field} NOT BETWEEN ${value1} AND ${value2} |
- See also
- Default value
- "equal"
Example
// renders the histogram so that all bins between// the two handles are shaded with a blue colorslider.viewModel.rangeType = "between";
// filters the layer view based on the configuration// of the sliderlayerView.filter = { where: slider.viewModel.generateWhereClause("POPULATION")};
// if slider min is 1,000 and max is 10,000, the following is generated// layerView.filter.where = 'POPULATION >= 1000 AND POPULATION <= 10000' state
- Type
- SliderViewModelState
The state of the view model.
thumbsConstrained
- Type
- boolean
When false, the user can freely move any slider thumb to any
position along the track. By default, a
thumb's position is constrained to the positions of neighboring thumbs so
you cannot move one thumb past another. Set this property to false to
disable this constraining behavior.
- Default value
- true
Example
// allows the user to freely move slider// thumbs to any position along the trackslider.viewModel.thumbsConstrained = false; values
An array of numbers representing absolute thumb positions on the slider.
- See also
Example
const slider = new SliderVM({ min: 20, max: 100, // data range of 80 values: [50.4331], // thumb label will display 50.43 // thumb value will maintain precision, so // value will remain at 50.4331});Methods
| Method | Signature | Class |
|---|---|---|
defaultInputFormatFunction inherited | defaultInputFormatFunction(value: number): string | |
defaultInputParseFunction inherited | defaultInputParseFunction(value: string): number | |
defaultLabelFormatFunction inherited | defaultLabelFormatFunction(value: number): string | |
generateWhereClause(field: string): string | null | undefined | | |
getBounds inherited | getBounds(): Bounds | |
getBoundsForValueAtIndex inherited | getBoundsForValueAtIndex(index: number): Bounds | |
getLabelForValue inherited | getLabelForValue(value: number | null | undefined, type?: SliderFormatType, index?: number): string | null | undefined | |
setValue inherited | setValue(index: number, value: number): void | |
toPrecision inherited | toPrecision(value: number): number |
defaultInputFormatFunction
- Signature
-
defaultInputFormatFunction (value: number): string
The default input format function available for use as a fallback in custom formatting implementations.
defaultInputParseFunction
- Signature
-
defaultInputParseFunction (value: string): number
The default input parsing function available for use as a fallback in custom parsing implementations.
defaultLabelFormatFunction
- Signature
-
defaultLabelFormatFunction (value: number): string
The default label format function, available for use as a fallback in custom formatting implementations.
generateWhereClause
- Signature
-
generateWhereClause (field: string): string | null | undefined
Generates a SQL where clause based on a given field and the slider's rangeType. This is a convenience function for data filtering or data queries.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| field | Name of the field used in the where clause. This field should correspond to the data used to generate the histogram associated with the slider. | |
Example
// renders the histogram so that all bins between// the two handles are shaded with a blue color by defaultslider.viewModel.rangeType = "between";
// filters the layerview based on the configuration// of the sliderlayerView.filter = { where: slider.viewModel.generateWhereClause("POPULATION")} getBounds
- Signature
-
getBounds (): Bounds
- Since
- ArcGIS Maps SDK for JavaScript 4.23
Returns the effective bounds of the slider. If effectiveMin and effectiveMax are set on the slider, then those values will be returned. If not, then the min and max are returned.
- Returns
- Bounds
The effective bounds of the slider.
getBoundsForValueAtIndex
- Signature
-
getBoundsForValueAtIndex (index: number): Bounds
Returns the min and max bounds for a 'value' at the provided index. Also used internally to provide accessibility information via HTMLElement properties
getLabelForValue
- Signature
-
getLabelForValue (value: number | null | undefined, type?: SliderFormatType, index?: number): string | null | undefined
Returns the formatted label for a provided value.
setValue
- Signature
-
setValue (index: number, value: number): void
toPrecision
- Signature
-
toPrecision (value: number): number
- Since
- ArcGIS Maps SDK for JavaScript 4.14
Rounds the given value to the number of decimal places specified in the precision property set on the view model.
- See also