RangeFilterSelection Interface
A range in the Range Filter dashboard item.
Declaration
export interface RangeFilterSelectionRemarks
Use the RangeFilterSelection.minimum and RangeFilterSelection.maximum properties to specify the required range.
The table below lists methods that return or accept the RangeFilterSelection object.
- ViewerApiExtension.getEntireRange
- Returns the visible range for the specified Range Filter dashboard item.
- ViewerApiExtension.getCurrentRange
- Returns the currently selected range in the specified Range Filter dashboard item.
- ViewerApiExtension.setRange
- Selects the required range in the specified Range Filter / Date Filter dashboard item.
Properties
maximum Property
Specifies a maximum value in the range of the Range Filter dashboard item.
Declaration
maximum: number | DateProperty Value
| Type | Description |
|---|---|
| number | A maximum number value in the range of the Range Filter dashboard item. |
| Date | The Date object that corresponds to the maximum value of the selection. |
Remarks
The following code snippet shows how to set a range:
var selectedRange = { minimum: new Date(2020, 1, 1), maximum: new Date(2020, 12, 31)}
This example shows how to apply a master filter in the Web Dashboard on the client side:
minimum Property
Specifies a minimum value in the range of the Range Filter dashboard item.
Declaration
minimum: number | DateProperty Value
| Type | Description |
|---|---|
| number | A minimum number value in the range of the Range Filter dashboard item. |
| Date | The Date object that corresponds to the minimum value of the selection. |
Remarks
The following code snippet shows how to set a range:
var selectedRange = { minimum: new Date(2020, 1, 1), maximum: new Date(2020, 12, 31)}
This example shows how to apply a master filter in the Web Dashboard on the client side: