This enumerator is used to specify how filter values should be retrieved if the get
filter column functions of Filtering and FilteringScheme objects.
Namespace: spotfire.webPlayerRemarks
For filter types other than the check box hierarchy filter,
any of the last two values can be used to get the value(s) of the filter.
Note, for some filter types like the checkbox hierarchy filter, the value can contain large amounts of data.
Note, for some filter types like the checkbox hierarchy filter, the value can contain large amounts of data.
Assembly: ~/GetJavaScriptApi.ashx?Version=5.0
Syntax
JavaScript |
---|
spotfire.webPlayer.includedFilterSettings = function(); spotfire.webPlayer.includedFilterSettings.createEnum('spotfire.webPlayer.includedFilterSettings', false); |
Members
Member name | Value | Description | |
---|---|---|---|
NONE | 0 | No values, for any filter type, is returned in the filter settings object. | |
ALL_WITH_CHECKED_HIERARCHY_NODES | 1 | For check box hierarchy filters, return the names of all checked values in the hierarchy. For all other filter types return the selected value(s). | |
ALL_WITH_UNCHECKED_HIERARCHY_NODES | 2 | For check box hierarchy filters, return the names of all unchecked values in the hierarchy. For all other filter types return the selected value(s). |
Version Information
Supported in: 6.0, 5.5, 5.0, 4.0, 3.2