Class

SpotfireListBoxFilter

SpotfireListBoxFilter(filterDescription)

Represents a list box filter.

Constructor

new SpotfireListBoxFilter(filterDescription)

Parameters:
Name Type Description
filterDescription FilterDescription ▼
type SpotfireFiltersTypes ▼

The type of the filter.
rangeFilter String

The Range Filter type, see SpotfireRangeFilter for details on this filter.
itemFilter String

The Item Filter type, see SpotfireItemFilter for details on this filter.
radioButtonFilter String

The Radio Button Filter type, see SpotfireRadioButtonFilter for details on this filter.
checkBoxFilter String

The Check Box Filter type, see SpotfireCheckBoxFilter for details on this filter.
textFilter String

The Text Filter type, see SpotfireTextFilter for details on this filter.
listBoxFilter String

The List Box Filter type, see SpotfireListBoxFilter for details on this filter.
[ 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.
column String

The name of the column on which the filter is applied.
[ reset = true ] Boolean

Specifies whether the filter should be reset before applying the value.
value Object

The value to be set. The format of this parameter depends on the SpotfireFiltersTypes.
[ valueDataRange ] Object

A range definition to use the RangeFilter. For RangeFilter
[ min ] string | number

The minimum value of the range.
[ max ] string | number

The maximum value of the range.
[ includeEmpty ] boolean

Specifies if the filter must include empty values.
[ visualScale ] string

Specifies the visual scale for values.
[ checkBoxModeEnabled ] boolean

Indicates if the checkBox is enabled. For ListBoxFilter.
[ height ] number

The height of the list box. For ListBox Filter.
[ includeAllValues ] boolean

Specifies if all values must be included.
[ searchExpression ] string

Specifies the search expression. For ListBox Filter.
[ searchFieldVisible ] boolean

Specifies if the search fields is visible in the list box. For ListBox Filter.
value Array.<Object>

Array of values to check.
checkBoxModeEnabled Boolean

Indicates whether the instance should use check boxes to indicate filtered items.
height Number

The number of lines to show in the UI list box.
includeAllValues Boolean

Indicates whether all values should be included or not.
includeEmpty Boolean

Indicates whether the filter should include empty value rows.
searchExpression String

The search expression that determines which values are to be shown in the user interface. This property does not affect which rows are filtered out.
searchFieldVisible Boolean

Indicates whether the search field should be visible in the UI or not.