Click or drag to resize

Filtering Class

Contains filtering related functionality.
This object is created when the document is loaded. To get an instance of this object use the Document.filtering property.
Inheritance Hierarchy
SystemObject
  spotfire.webPlayerFiltering

Namespace:  spotfire.webPlayer
Assembly:  ~/GetJavaScriptApi.ashx?Version=10.0
Syntax
JavaScript
spotfire.webPlayer.Filtering = function();

Type.createClass(
	'spotfire.webPlayer.Filtering');

The Filtering type exposes the following members.

Constructors
  NameDescription
Public methodFiltering
Top
Methods
  NameDescription
Public methodgetActiveFilteringScheme
Get the information about the active filtering scheme.
Public methodgetAllModifiedFilterColumns
Get the information about all filter columns that do not have the default value selected in all filtering schemas.
Public methodgetFilterColumn
Get the information about a filter column.
Public methodgetFilteringScheme
Get the information about a filtering scheme.
Public methodgetFilteringSchemes
Get a list of all the filtering schemes in the document.
Public methodgetModifiedFilterColumns
Get the information about all filter columns that do not have the default value selected.
Public methodresetAllFilters
Resets all filters to the default values.
Public methodsetFilter
Set the value(s) of a filter column.
Public methodsetFilters
Apply new values to a list of filters.
Top
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