Class

SpotfireRangeFilter

SpotfireRangeFilter(filterDescription)

Constructor

new SpotfireRangeFilter(filterDescription)

Represents a range filter.

Parameters:
Name Type Description
filterDescription filterDescription
type SpotfireFiltersTypes  {Enum} 

The type of the filter.

Enum options: rangeFilter, itemFilter, radioButtonFilter, checkBoxFilter, textFilter, listBoxFilter
column String

The name of the column on which the filter is applied.

[ filteringScheme ] String

The name of the filtering scheme in which the filter is added. If not specified, the active filtering scheme will be used.

[ dataTable ] String

The name of the data table on which the filter is applied. If not specified, the active data table will be used.

[ reset = false ] Boolean

Indicates whether the filter should be reset or not.

value Object

The range of values to be filtered.

min any

Determines the low limit of the range.

max any

Determines the high limit of the range.

valueDataRange Object

The minimum and maximum values of the filter.

min any

Determines the low limit of the range.

max any

Determines the high limit of the range.

includeEmpty Boolean

Indicates whether or not the filter should include empty value rows.

visualScale SpotfireFilterVisualScales  {Enum} 

The scale transformation to be applied to the filter.

Enum options: log10, linear