MarkingonChanged Method (string, string, string, int, MarkingonMarkingCallback, string, Boolean) |
Sets up an event listner for marking changed connected to a specific filtering scheme.
Namespace:
spotfire.webPlayer
Assembly:
~/GetJavaScriptApi.ashx?Version=14.4
Syntaxfunction onChanged(markingName, dataTableName, dataColumnNames, maxRows, callback, intersectionFilteringName, distinctTuples);
Parameters
- markingName
- Type: Systemstring
The marking name in which to listen for changes. - dataTableName
- Type: Systemstring
The name of the data table in which to listen for marking changes. - dataColumnNames
- Type: Systemstring
Array of data column names that should be included in the result. - maxRows
- Type: Systemint
The maximum number of marked rows to return. - callback
- Type: spotfire.webPlayerMarkingonMarkingCallback
The event handler with the following signature:
function(array) {}.
The array has the following format:
array["Column Name"][n], where n is the data row index. - intersectionFilteringName
- Type: Systemstring
Only raise the event if marking changes ocurrs in the intersection
between the displayed data from the filtering scheme and the displayed data from the marking parameters.
- distinctTuples
- Type: SystemBoolean
If true, only distinct tuples will be returned. If false, all underlying rows will be returned.
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