Click or drag to resize

includedFilterSettings Enumeration

This enumerator is used to specify how filter values should be retrieved if the get filter column functions of Filtering and FilteringScheme objects.
Remarks
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.
Checkbox hierarchy filters that loads data on request will return an empty list.

Namespace:  spotfire.webPlayer
Assembly:  ~/GetJavaScriptApi.ashx?Version=10.0
Syntax
JavaScript
spotfire.webPlayer.includedFilterSettings = function();
spotfire.webPlayer.includedFilterSettings.createEnum('spotfire.webPlayer.includedFilterSettings', false);
Members
  Member nameValueDescription
NONE0No values, for any filter type, is returned in the filter settings object.
ALL_WITH_CHECKED_HIERARCHY_NODES1For 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_NODES2For 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: 10.0, 7.14, 7.13, 7.12, 7.11, 7.10, 7.9, 7.8, 7.7, 7.6, 7.5, 7.0
See Also