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=14.3

Syntax

JavaScript

Copy

spotfire.webPlayer.Filtering = function();

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

The Filtering type exposes the following members.

Constructors

	Name	Description
	Filtering

Top

Methods

	Name	Description
	getActiveFilteringScheme	Get the information about the active filtering scheme.
	getAllModifiedFilterColumns	Get the information about all filter columns that do not have the default value selected in all filtering schemas.
	getFilterColumn	Get the information about a filter column.
	getFilteringScheme	Get the information about a filtering scheme.
	getFilteringSchemes	Get a list of all the filtering schemes in the document.
	getModifiedFilterColumns	Get the information about all filter columns that do not have the default value selected.
	resetAllFilters	Resets all filters to the default values.
	setFilter	Set the value(s) of a filter column.
	setFilters	Apply new values to a list of filters.

Top

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

Reference

spotfire.webPlayer Namespace