FilteringgetFilterColumn Method |
Get the information about a filter column.
Namespace:
spotfire.webPlayer
Assembly:
~/GetJavaScriptApi.ashx?Version=14.4
Syntaxfunction 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: 14.4, 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also