MarkinggetMarking Method (string, string, string, int, MarkingonMarkingCallback, Boolean) |
Get the currentlly marked rows.
Namespace:
spotfire.webPlayer
Assembly:
~/GetJavaScriptApi.ashx?Version=14.2
Syntax function getMarking(markingName, dataTableName, dataColumnNames, maxRows, callback, distinctTuples);
Parameters
- markingName
- Type: Systemstring
The name of the marking. - dataTableName
- Type: Systemstring
The name of the data table for the columns. - dataColumnNames
- Type: Systemstring
Array of data column names that should be included in the result. - maxRows
- Type: Systemint
Maximum number of rows to get. - 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. - distinctTuples
- Type: SystemBoolean
If true, only distinct tuples will be returned. If false, all underlying rows will be returned.
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