Click or drag to resize

FilteringgetFilterColumn Method

Get the information about a filter column.

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

Parameters

filteringSchemeName
Type: Systemstring
The filtering scheme name where the filter column is located.
dataTableName
Type: Systemstring
The data table name in which the filter column is located.
dataColumnName
Type: Systemstring
The name of the filter column.
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.webPlayeronGetFilterColumnCallback
The event handler with the following signature:
function(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