An array of table summary objects that are currently used in the data source.
An array of descriptions of the connections within this data source.
Gets the underlying data table for the given logical table id.
Collection of options to change the behavior of the call.
A data table containing the underlying data of the data source.
Gets the underlying logical tables used in the data source.
An array of logical tables that are currently used in the data source.
The following example uses the getLogicalTablesAsync
method to print the names of the
the logical tables to the console.
dataSource.getLogicalTablesAsync().then(function (logicalTables) {
// Loop through each table that was used in creating this data source
logicalTables.forEach(function (table) {
console.log(table.caption);
});
});
Collection of options to change the behavior of the call.
Returns a promise containing a page of data from the underlying data of the data source.
The following example shows use of the getUnderlyingDataAsync()
method to get the underlying data from a specific data source.
The example uses the JavaScript find()
method to select the workbook and data source.
const dataSources = await worksheet.getDataSourcesAsync();
const dataSource = dataSources.find(datasource => datasource.name === "Sample - Superstore");
const dataTable = await dataSource.getUnderlyingDataAsync();
let field = dataTable.columns.find(column => column.fieldName === "Sub-Category");
let list = [];
for (let row of dataTable.data) {
list.push(row[field.index].value);
}
let values = list.filter((el, i, arr) => arr.indexOf(el) === i);
console.log(values);
This call has the same functionality as clicking the Refresh option on a data source in Tableau. This does not refresh an extract.
Note: The refreshAsync()
method is intended to be used in scenarios where manual
interaction causes a need to refresh the data in the Tableau visualization. The method is not,
as currently designed, meant to support or emulate streaming or live visualizations.
Extensions that use the method to refresh aggressively or automatically
can cause issues on Tableau Server and Tableau Online and are subject to being blocked
by the Tableau Online administrator.
This call does not currently support refreshing live Google Sheet data sources.
Promise that resolves when the data source has finished refreshing.
Represents the data source used by a Worksheet.