Click or drag to resize

FilteringSchemegetFilterColumn Method

Get the information about a filer column.

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

Parameters

dataTableName
Type: Systemstring
The name of the data table for the filter column.
dataColumnName
Type: Systemstring
The name of the data column to retieve.
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
A call back function with the following signature:
function(FilterColumn) {}.
Version Information

Supported in: 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also