Constructor
new SpotfireListBoxFilter(filterDescription)
Represents a list box 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
|
Array.<Object> | Array of values to check. |
checkBoxModeEnabled
|
Boolean | Indicates whether or not 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 or not 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. |