Spotfire 14.3 Web Player JavaScript API Reference
spotfire.webPlayer
Application Class
Application.onClosedCallback Function
Application.onErrorCallback Function
Application.onLoggedOutCallback Function
Application.onOpenedCallback Function
authenticate Function
AuthenticationSettings Class
AuthToken Class
columnDataType Enumeration
connect Function
ConnectSettings Class
createApplication Function
Customization Class
Data Class
Data.onGetDataTableCallback Function
Data.onGetDataTablesCallback Function
Data.onRangeChangedCallback Function
DataColumn Class
DataColumnRangeState Structure
DataTable Class
DataTable.onGetDataColumnCallback Function
DataTable.onGetDataColumnsCallback Function
DistinctValues Class
Document Class
Document.onDocumentReadyCallback Function
Document.onGetBookmarkNamesCallback Function
Document.onGetBookmarksCallback Function
Document.onGetDocumentMetadataCallback Function
Document.onGetDocumentStateCallback Function
Document.onGetPageCallback Function
Document.onGetPagesCallback Function
Document.onGetReportsCallback Function
DocumentMetadata Class
DocumentState Class
errorCodes Enumeration
FilterColumn Class
Filtering Class
Filtering.onGetFilteringSchemeCallback Function
Filtering.onGetFilteringSchemesCallback Function
filteringOperation Enumeration
FilteringScheme Class
FilterSettings Structure
filterType Enumeration
includedFilterSettings Enumeration
Marking Class
Marking.onGetMarkingNames Function
Marking.onMarkingCallback Function
markingOperation Enumeration
oauthEnd Function
onApplicationLoadedCallback Function
onCreateLoginElementCallback Function
onGetDistinctValuesCallback Function
onGetFilterColumnCallback Function
onGetFilterColumnsCallback Function
onGetPropertiesCallback Function
onGetPropertyCallback Function
PageState Structure
Property Class
setApiVersion Function
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=14.3
Syntax
JavaScript
Copy
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: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also