The requested page is not available for the requested platform. You are viewing the content for Default platform.

RangeFilterSelection Interface

A range in the Range Filter dashboard item.

Declaration

export interface RangeFilterSelection

Remarks

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.

Method

Description

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 | Date

Property Value

Type Description
number

A maximum number value in the range of the Range Filter dashboard item.

Date

A maximum date value in the range of the Range Filter dashboard item.

Remarks

The following code snippet shows how to set a range:

selectedRange.minimum = new Date(2017, 1, 1);
selectedRange.maximum = new Date(2017, 12, 31); 
See Also

minimum Property

Specifies a minimum value in the range of the Range Filter dashboard item.

Declaration

minimum: number | Date

Property Value

Type Description
number

A minimum number value in the range of the Range Filter dashboard item.

Date

A minimum date value in the range of the Range Filter dashboard item.

Remarks

The following code snippet shows how to set a range:

selectedRange.minimum = new Date(2017, 1, 1);
selectedRange.maximum = new Date(2017, 12, 31); 
See Also