- Source:
- API-4.1.js, line 13
Methods
exportFilteredData(datatablename, folderpath, filename, fileformat, columns, numRows)
Export filtered data of a TIBCO Spotfire Data Table.
Parameters:
Name | Type | Description |
---|---|---|
datatablename |
string | The name of data table to export. If empty, the Spotfire active data table is used. |
folderpath |
string | The UNC where data will be exported into. |
filename |
string | The name of export file. |
fileformat |
string | The name of . |
columns |
string | The name of the columns to export separated by comma(,). |
numRows |
string | The number of rows that will be exported. |
- Source:
- API-4.1.js, line 3618
Throws:
-
If the data table does not exist in the document.
-
If the folder cannot be reached.
-
If the columns does not exist in the data table.
getCheckBoxFilterCheckedValues(columnname, delimiter) → {string}
Gets checked values in the specified CheckBox Filter.
Parameters:
Name | Type | Description |
---|---|---|
columnname |
string | Name of the column on which create the filter. |
delimiter |
string | Delimiter to use to separate checked values. |
- Source:
- API-4.1.js, line 3702
Returns:
Values checked by the CheckBox Filter. Null if a problem occur during the process.
- Type
- string
getFilterType(columnname) → {string}
Gets the type of the filter applied on the provided column.
Parameters:
Name | Type | Description |
---|---|---|
columnname |
string | Name of the column on which create the filter. |
- Source:
- API-4.1.js, line 3685
Returns:
the display name of the filter type. Null if a problem occur during the process.
- Type
- string
getRangeFilterHighValue(columnname) → {string}
Gets the High value of a Range Filter.
Parameters:
Name | Type | Description |
---|---|---|
columnname |
string | Name of the column associated to the filter. |
- Source:
- API-4.1.js, line 3736
Returns:
High value of the Range Filter. Null if a problem occur during the process.
- Type
- string
Throws:
If the collection of filters cannot be getted.
getRangeFilterLowValue(columnname) → {string}
Gets the Low value of a Range Filter.
Parameters:
Name | Type | Description |
---|---|---|
columnname |
string | Name of the column associated to the filter. |
- Source:
- API-4.1.js, line 3719
Returns:
Low value of the Range Filter. Null if a problem occur during the process.
- Type
- string
Throws:
If the collection of filters cannot be getted.
resetAllFilters()
Resets all filters of the active Filtering Scheme in the document.
- Source:
- API-4.1.js, line 3814
resetAllVisibleFilters()
Resets all visible filters of the active Filtering Scheme in the document.
- Source:
- API-4.1.js, line 3827
resetCheckBoxFilterCheckedValues(columnname)
Resets the specified CheckBox Filter.
Parameters:
Name | Type | Description |
---|---|---|
columnname |
string | Name of the column on which create the filter. |
- Source:
- API-4.1.js, line 3787
resetRangeFilterValueRange(columnname)
Resets the specified Range Filter.
Parameters:
Name | Type | Description |
---|---|---|
columnname |
string | Name of the column on which create the filter. |
- Source:
- API-4.1.js, line 3801
setCheckBoxFilterCheckedValues(columnname, values, delimiter, keepemptychecked)
Sets the values checked by the specified CheckBox Filter. A reset is performed before setting values.
Parameters:
Name | Type | Description |
---|---|---|
columnname |
string | Name of the column on which create the filter. |
values |
string | List of values to checked delimited with "delimiter". |
delimiter |
string | Delimiter used in the list of values. |
keepemptychecked |
string | Optional boolean to set the "include empty value" value (false to uncheck it). |
- Source:
- API-4.1.js, line 3755
Throws:
If the targeted filter is not a check box filter.
setRangeFilterValueRange(columnname, values, delimiter, keepemptychecked)
Sets the value range of the specified Range Filter. A reset is performed before setting values.
Parameters:
Name | Type | Description |
---|---|---|
columnname |
string | Name of the column on which create the filter. |
values |
string | The two values to use for the value range, delimited with "delimiter". |
delimiter |
string | Delimiter used in the list of values. |
keepemptychecked |
string | Optional boolean to set the "include empty value" value (false to uncheck it). |
- Source:
- API-4.1.js, line 3773
Throws:
If the targeted filter is not a range filter.
uploadFilteredData(datatablename, urlServerRoot, sessionID, destinationpath, filename, fileformat, columns)
Upload filtered data of a Tibco Spotfire Data Table to Pipeline Pilot.
Parameters:
Name | Type | Description |
---|---|---|
datatablename |
string | The name of data table to upload. If empty, the Spotfire active data table is used. |
urlServerRoot |
string | The root URL of the Pipeline Pilot Server. |
sessionID |
string | The Pipeline Pilot session ID. |
destinationpath |
string | The destination path where data will be exported into. |
filename |
string | The name of upload file. |
fileformat |
string | The format of the uploaded file. |
columns |
string | The name of the columns to upload separated by comma(,). |
- Source:
- API-4.1.js, line 3499
Throws:
-
If the data table does not exist in the document.
-
If the columns does not exist in the data table.