Click or drag to resize

FilteringSchemegetDefaultFilterColumns Method

Get the information about the filer columns in the default filtering scheme and data table.

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

Parameters

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) {}.
The parameter is an array of filterColumns.
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