Click or drag to resize

FilteringgetModifiedFilterColumns Method

Get the information about all filter columns that do not have the default value selected.

Namespace:  spotfire.webPlayer
Assembly:  ~/GetJavaScriptApi.ashx?Version=11.8
Syntax
JavaScript
function getModifiedFilterColumns(filteringSchemeName, includedFilterSettings, callback);

Parameters

filteringSchemeName
Type: Systemstring
The filtering scheme name where the filter columns are located.
includedFilterSettings
Type: spotfire.webPlayerincludedFilterSettings
How the filter values should be returned.
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.
callback
Type: spotfire.webPlayeronGetFilterColumnsCallback
A call back function with the following signature:
function(filterColumns) {}.
Where filterColumns is an array of FilterColumn.
Version Information

Supported in: 11.8, 11.7, 11.6, 11.5, 11.4, 11.3, 11.2, 11.1, 11.0, 10.10, 7.11
See Also