Tableau Extensions API

https://tableau.github.io/extensions-api/api/
Admin
The Tableau Extensions API is a JavaScript library providing namespaces, classes, and methods for...
Tokens:101,000
Snippets:902
Trust Score:8.3
Update:1 day ago
Show doc for...
Tokens:
Raw
### saveAsync example

Source: https://tableau.github.io/extensions-api/api/interfaces/Settings.html

Example of using the saveAsync method to persist settings changes. The method should only be called in authoring mode. The example shows a promise chain with success and error handling.

```javascript
tableau.extensions.settings.saveAsync().then(result => {
   console.log('Settings saved.');
   // ... process results
}).catch((error) => {
  // ...
  // ... code for error handling
});
```

--------------------------------

### selectTuplesAsync example

Source: https://tableau.github.io/extensions-api/api/interfaces/Worksheet.html

Example of calling selectTuplesAsync on a click event, using Ctrl key to toggle selection. Includes a tooltip anchor point. Logs 'Done' on success or an error message on failure.

```javascript
svg.on('click', (mouseEvent) => {
const myClickedTuples = [10];
const ctrlKeyPressed = !!mouseEvent.ctrlKey;
const selectOption = ctrlKeyPressed ? tableau.SelectOptions.Toggle : tableau.SelectOptions.Simple;

tableau.extensions.worksheetContent.worksheet.selectTuplesAsync(myClickedTuples, selectOption, { tooltipAnchorPoint: { x: mouseEvent.pageX, y: mouseEvent.pageY } })
   .then(() => console.log('Done'))
   .catch((error) => console.log('Failed to select because of: ', error));
});
```

--------------------------------

### getLogicalTableDataAsync example

Source: https://tableau.github.io/extensions-api/api/interfaces/DataSource.html

Shows how to get data from a specific logical table in a data source. Uses worksheet.getDataSourcesAsync(), find() to select the data source by name, getLogicalTablesAsync() to get logical tables, then getLogicalTableDataAsync() with the first logical table's id. Logs the resulting data table.

```javascript
const dataSources = await worksheet.getDataSourcesAsync();
const dataSource = dataSources.find(datasource => datasource.name === "Sample - Superstore");
const logicalTables = await dataSource.getLogicalTablesAsync()
const dataTable = await dataSource.getLogicalTableDataAsync(logicalTables[0].id);
console.log(dataTable);
```

--------------------------------

### get

Source: https://tableau.github.io/extensions-api/api/interfaces/Settings.html

Gets a settings value or undefined if the value does not exist.

```APIDOC
## get

### Description
Gets a settings value or undefined if the value does not exist.

### Method
get

### Parameters
- **key** (string) - Required - The key to retrieve.

### Returns
- **undefined | string** - The value or undefined if it does not exist.
```

--------------------------------

### hoverTupleAsync example

Source: https://tableau.github.io/extensions-api/api/interfaces/Worksheet.html

Shows how to use hoverTupleAsync to execute hover actions and render a tooltip for a given tuple. The example passes a tooltip context with an anchor point based on the mouse event. Passing an invalid tuple id will not throw and will clear the tooltip.

```javascript
svg.on('mousemove', (mouseEvent) => {
 const myHoveredTuple = 10;
 tableau.extensions.worksheetContent.worksheet.hoverTupleAsync(myHoveredTuple, { tooltipAnchorPoint: { x: mouseEvent.pageX, y: mouseEvent.pageY } })
   .then(() => console.log('Done'))
   .catch((error) => console.log('Failed to hover because of: ', error));
 });
```

--------------------------------

### getUnderlyingDataAsync example

Source: https://tableau.github.io/extensions-api/api/interfaces/DataSource.html

Shows how to get underlying data from a specific data source using getUnderlyingDataAsync. It selects a data source by name, retrieves the data table, extracts unique values from a column, and logs them. Note: this method is deprecated; use getLogicalTableDataReaderAsync or getLogicalTableDataAsync instead.

```javascript
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);
```

--------------------------------

### leaveMarkNavigationAsync example

Source: https://tableau.github.io/extensions-api/api/interfaces/Worksheet.html

Example of calling leaveMarkNavigationAsync when the Escape key is pressed to exit mark-level keyboard navigation. Logs 'Done' on success or an error message on failure.

```javascript
svg.on('keyup', (keyboardEvent) => {
  if (keyboardEvent.key == "Escape") {
    tableau.extensions.worksheetContent.worksheet
      .leaveMarkNavigationAsync()
      .then(() => console.log('Done'))
      .catch((error) => console.log('Failed to leave mark-level keyboard navigation because of: ', error));
  }
});
```

--------------------------------

### getTooltipTextAsync example

Source: https://tableau.github.io/extensions-api/api/interfaces/Worksheet.html

Shows how to use getTooltipTextAsync to retrieve tooltip text for a navigated tuple. The example listens for keyboard events to update the navigated tuple and then calls getTooltipTextAsync, logging the result or an error. Note that passing an invalid tuple id will not throw.

```javascript
let navigatedTuple = -1;
let updateScreenReaderElement = (screenReadertext) => {
  // updates an element to be read out by screen readers
};

let updateNavigatedTuple = (keyboardEvent) => {
  switch (keyboardEvent.key) {
    case 'ArrowLeft':
      navigatedTuple = navigatedTuple - 1;
      break;
    case 'ArrowRight':
      navigatedTuple = navigatedTuple + 1;
      break;
    default:
      break;
  }
  // do any work to show visual indication of a mark being navigated to
};

svg.on('keydown', (keyboardEvent) => {
  updateNavigatedTuple(keyboardEvent);
  tableau.extensions.worksheetContent.worksheet
    .getTooltipTextAsync(navigatedTuple)
    .then((response) => {
      console.log(response.result);
      updateScreenReaderElement(response.result);
    })
    .catch((error) => console.log('Failed to get tooltip text because of: ', error));
});
```

--------------------------------

### getUnderlyingTablesAsync example

Source: https://tableau.github.io/extensions-api/api/interfaces/Worksheet.html

Shows how to get the underlying logical tables used by the worksheet. The resulting logical tables are determined by the measures in the worksheet. If the data source has multiple logical tables but the worksheet only uses measures from one, only that one is returned.

```typescript
// Call to get the underlying logical tables used by the worksheet
worksheet.getUnderlyingTablesAsync().then(function (logicalTables) {
  // Get the first logical table's id
  const logicalTableId = logicalTables[0].id;

  // Use the above logicalTableId to then get worksheet's underlying data
  // by calling worksheet.getUnderlyingTableDataAsync(logicalTableId)

});
```

--------------------------------

### getUnderlyingTableDataReaderAsync example

Source: https://tableau.github.io/extensions-api/api/interfaces/Worksheet.html

Shows how to get the first page of underlying data using getUnderlyingTableDataReaderAsync. Requires a logical table ID from getUnderlyingTablesAsync. Only one active DataTableReader per logical table ID is supported. The default row limit is 1 million rows, configurable via ExtensionsAndEmbeddingReaderRowLimit.

```typescript
// Call to get the underlying logical tables used by the worksheet
const underlyingTablesData = await worksheet.getUnderlyingTablesAsync();
const logicalTableId = underlyingTablesData[0].id;
// Use the above logicalTableId to get the underlying data reader on the active sheet
const dataTableReader = await worksheet.getUnderlyingTableDataReaderAsync(logicalTableId);
const page = await dataTableReader.getPageAsync(0);
// ... process first page of data table ...
await dataTableReader.releaseAsync();
```

--------------------------------

### getParametersAsync

Source: https://tableau.github.io/extensions-api/api/interfaces/Dashboard.html

Gets all parameters in the dashboard.

```APIDOC
## getParametersAsync

### Description
Gets all parameters in the dashboard.

### Method
getParametersAsync

### Returns
- **Promise<Parameter[]>**
```

--------------------------------

### getAllPagesAsync example

Source: https://tableau.github.io/extensions-api/api/interfaces/DataTableReader.html

Fetches all pages of data into a single DataTable using the default page size. Assumes less than 4 million rows. Calls releaseAsync after fetching to free resources.

```typescript
// To simplify the example, we assume we have less than 4m rows of data
// Since we are fetching all of the data, use the default page size in getSummaryDataReaderAsync
const dataTableReader = await worksheet.getSummaryDataReaderAsync();
const dataTable = await dataTableReader.getAllPagesAsync();
await dataTableReader.releaseAsync();
// ... process the data table ...
```

--------------------------------

### getPageAsync example

Source: https://tableau.github.io/extensions-api/api/interfaces/DataTableReader.html

Iterates through pages of data using a custom page size of 200. Fetches each page by index and processes it, then releases the reader.

```typescript
const pageRowCount = 200;
const dataTableReader = await worksheet.getSummaryDataReaderAsync(pageRowCount, options);
for (let currentPage = 0; currentPage < dataTableReader.pageCount; currentPage++) {
  const currentPageDataTable = await dataTableReader.getPageAsync(currentPage);
  // ... process current page ...
}
await dataTableReader.releaseAsync();
```

--------------------------------

### getAllDataSourcesAsync()

Source: https://tableau.github.io/extensions-api/api/interfaces/Workbook.html

Gets the data sources for this workbook. Note that calling this method might negatively impact performance and responsiveness of the viz that your extension is added to. The method is not entirely asynchronous and includes some serial operations.

```APIDOC
## getAllDataSourcesAsync()

### Description
Gets the data sources for this workbook. Note that calling this method might negatively impact performance and responsiveness of the viz that your extension is added to. The method is not entirely asynchronous and includes some serial operations.

### Method
Async method

### Endpoint
Workbook.getAllDataSourcesAsync()

### Parameters
None

### Returns
Promise<DataSource[]> - All data sources used in this workbook.

### Since
1.6.0 and Tableau 2021.3

### Defined in
packages/api-external-contract-js/src/ExternalContract/Extensions/WorkbookInterfaces.ts:17
```

--------------------------------

### getAnnotationsAsync example

Source: https://tableau.github.io/extensions-api/api/interfaces/Worksheet.html

Shows how to call getAnnotationsAsync() to retrieve annotations in the worksheet and log them to the console. Available since version 1.10.0 and Tableau 2022.4.

```typescript
let annotations = await worksheet.getAnnotationsAsync();
console.log(annotations);
```

--------------------------------

### getLogicalTablesAsync example

Source: https://tableau.github.io/extensions-api/api/interfaces/DataSource.html

Uses getLogicalTablesAsync to print the caption of each logical table to the console. The method returns a promise that resolves to an array of LogicalTable objects.

```javascript
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);
  });
});
```

--------------------------------

### getDataSourcesAsync example

Source: https://tableau.github.io/extensions-api/api/interfaces/Worksheet.html

Demonstrates finding a specific data source by name and chaining a call to getUnderlyingDataAsync() to access the data table. Note that calling getDataSourcesAsync() may negatively impact performance and is not entirely asynchronous.

```typescript
worksheet.getDataSourcesAsync().then(datasources => {
  dataSource = datasources.find(datasource => datasource.name === "Sample - Superstore");
  return dataSource.getUnderlyingDataAsync();
 }).then(dataTable => {
      // process the dataTable...
    });
```

--------------------------------

### Example inputSpec object for createVizImageAsync

Source: https://tableau.github.io/extensions-api/api/interfaces/Extensions.html

Defines an inputSpec object with data values, mark type, and encoding for a bar chart. Supports sorting by field. Used with createVizImageAsync.

```javascript
var myInputSpec = {
      description: 'A simple bar chart with embedded data.',
      data: {
          values: [
              { Category: 'A', Measure: 28, Weather: 10 },
              { Category: 'B', Measure: 55, Weather: 9 },
              { Category: 'C', Measure: 43, Weather: 8 },
          ]
      },
      mark: tableau.MarkType.Bar,
      encoding: {
          columns: { field: 'Category', type: tableau.VizImageEncodingType.Discrete },
          rows: { field: 'Measure', type: tableau.VizImageEncodingType.Continuous },
          sort: { field: 'Category', 'sortby': 'Weather', direction: tableau.VizImageSortDirectionType.Ascending }
      }
 };
```

--------------------------------

### initializeAsync(contextMenuCallbacks?: { [key: string]: () => {} }): Promise<void>

Source: https://tableau.github.io/extensions-api/api/interfaces/Extensions.html

Initializes the extension. Optionally accepts a map of context menu callbacks. Returns a promise that resolves when initialization is complete.

```APIDOC
## initializeAsync(contextMenuCallbacks?: { [key: string]: () => {} }): Promise<void>

### Description
Initializes the extension. Optionally accepts a map of context menu callbacks. Returns a promise that resolves when initialization is complete.

### Method
initializeAsync

### Parameters
- **contextMenuCallbacks** (object) - Optional - A map of context menu callback functions.

### Returns
Promise<void> - A promise that resolves when initialization is complete.
```

--------------------------------

### initializeAsync(contextMenuCallbacks?: { [key: string]: () => {} }): Promise<void>

Source: https://tableau.github.io/extensions-api/api/interfaces/Extensions.html

Initializes the extension. This method must be called first before using any other Extension APIs. Optionally accepts a map of context menu item IDs to callback functions.

```APIDOC
## initializeAsync(contextMenuCallbacks?: { [key: string]: () => {} }): Promise<void>

### Description
This is the entry point for an Extension. This function must first be called in order to interact with any of the other Extension APIs. Optionally accepts a map of context menu item IDs to callback functions.

### Method
initializeAsync

### Parameters
- **contextMenuCallbacks** (object) - Optional - Maps the ids of context menu items to the function to be triggered when that context menu item is selected. The keys must match the keys registered in the `context-menu` element of the manifest. Currently, only a single context menu item is available (`'configure'`).

### Returns
Promise<void> - A promise that when resolved, the other Extension APIs will be available to use.

### Example
```javascript
$(document).ready(function () {
  tableau.extensions.initializeAsync({'configure': configure}).then(function() {
    // When the user clicks the Configure... context menu item,
    // the configure function specified as the argument here
    // is executed.
  });
});
```
```

--------------------------------

### Settings.getAll

Source: https://tableau.github.io/extensions-api/api/interfaces/Settings.html

Retrieves all settings as a key-value object.

```APIDOC
## Settings.getAll

### Description
Retrieves all settings as a key-value object.

### Method
`getAll(): { [key: string]: string }`

### Returns
- **{ [key: string]: string }** - An object containing all settings.
```

--------------------------------

### Get dashboard object by ID using getDashboardObjectById

Source: https://tableau.github.io/extensions-api/api/interfaces/Dashboard.html

Shows how to retrieve a dashboard object by its numeric ID. The example uses the dashboard from the extension's dashboard content and calls getDashboardObjectById(8). Returns undefined if the object is not found. Available since version 1.7.0 and Tableau 2021.4.

```javascript
var dashboard = tableau.extensions.dashboardContent.dashboard;
var myDashboardObject = dashboard.getDashboardObjectById(8);
```

--------------------------------

### getAll()

Source: https://tableau.github.io/extensions-api/api/interfaces/Settings.html

Returns a copy of all saved settings keys and values. Modifying the returned object has no effect on the actual settings.

```APIDOC
## getAll()

### Description
Returns a copy of all the saved settings keys and values. Modifying this value will have no effect on the class.

### Method
getAll

### Returns
- **{ [key: string]: string }** - All the saved settings keys and values in a dictionary.

### Source
Defined in packages/api-external-contract-js/src/ExternalContract/Extensions/Namespaces/Settings.ts:30
```

--------------------------------

### Initialize extension with configure callback

Source: https://tableau.github.io/extensions-api/api/interfaces/Extensions.html

Calls tableau.extensions.initializeAsync with a context menu callback for 'configure'. Must be called before using other Extension APIs. The promise resolves when other APIs are available.

```javascript
$(document).ready(function () {
  tableau.extensions.initializeAsync({'configure': configure}).then(function() {
  // When the user clicks the Configure... context menu item,
  // the configure function specified as the argument here
  // is executed.
  //
 });
});
```

--------------------------------

### Remove Annotation Example

Source: https://tableau.github.io/extensions-api/api/interfaces/Worksheet.html

Shows how to remove annotations from a worksheet using removeAnnotationAsync. The example iterates over an array of annotations and awaits the removal of each one.

```typescript
for (const annotation of annotations) {
  await worksheet.removeAnnotationAsync(annotation);
}
```

--------------------------------

### Settings.get

Source: https://tableau.github.io/extensions-api/api/interfaces/Settings.html

Retrieves the value of the setting with the specified key. Returns undefined if the key does not exist.

```APIDOC
## Settings.get

### Description
Retrieves the value of the setting with the specified key. Returns undefined if the key does not exist.

### Method
`get(key: string): undefined | string`

### Parameters
- **key** (string) - Required - The key of the setting to retrieve.

### Returns
- **undefined | string** - The value of the setting, or undefined if not found.
```

--------------------------------

### initializeDialogAsync(): Promise<string>

Source: https://tableau.github.io/extensions-api/api/interfaces/Extensions.html

Initializes the extension as a dialog. Returns a promise that resolves to a string (likely a dialog identifier or result).

```APIDOC
## initializeDialogAsync(): Promise<string>

### Description
Initializes the extension as a dialog. Returns a promise that resolves to a string (likely a dialog identifier or result).

### Method
initializeDialogAsync

### Returns
Promise<string> - A promise that resolves to a string.
```

--------------------------------

### getDashboardObjectById

Source: https://tableau.github.io/extensions-api/api/interfaces/Dashboard.html

Gets a dashboard object by its ID.

```APIDOC
## getDashboardObjectById

### Description
Gets a dashboard object by its ID.

### Method
getDashboardObjectById

### Parameters
- **id** (string) - Required - The ID of the dashboard object.

### Returns
- **DashboardObject**
```

--------------------------------

### getFiltersAsync

Source: https://tableau.github.io/extensions-api/api/interfaces/Dashboard.html

Gets the filters applied to a worksheet in the dashboard.

```APIDOC
## getFiltersAsync

### Description
Gets the filters applied to a worksheet in the dashboard.

### Method
getFiltersAsync

### Parameters
- **worksheetName** (string) - Required - The name of the worksheet.

### Returns
- **Promise<Filter[]>**
```

--------------------------------

### createVizImageAsync(inputSpec: object): Promise<string>

Source: https://tableau.github.io/extensions-api/api/interfaces/Extensions.html

Creates an image of the visualization. Returns a promise that resolves to a string (likely a data URL or base64 encoded image).

```APIDOC
## createVizImageAsync(inputSpec: object): Promise<string>

### Description
Creates an image of the visualization. Returns a promise that resolves to a string (likely a data URL or base64 encoded image).

### Method
createVizImageAsync

### Parameters
- **inputSpec** (object) - Required - The specification for the image to create.

### Returns
Promise<string> - A promise that resolves to a string representing the image.
```

--------------------------------

### initializeDialogAsync()

Source: https://tableau.github.io/extensions-api/api/interfaces/Extensions.html

Initializes an extension running inside a dialog box. Must be called before using other Extension APIs in the dialog context. Returns a promise that resolves with the initial payload from the parent extension.

```APIDOC
## initializeDialogAsync()

### Description
Initializes an extension running inside a dialog box. Must be called before using other Extension APIs in the dialog context. Returns a promise that resolves with the initial payload from the parent extension.

### Method
initializeDialogAsync

### Endpoint
Extensions.initializeDialogAsync()

### Parameters
None

### Returns
Promise<string> - A promise that resolves to the initial payload string sent by the parent extension via displayDialogAsync.

### Example
```typescript
const payload = await tableau.extensions.initializeDialogAsync();
```
```

--------------------------------

### Filter Interface

Source: https://tableau.github.io/extensions-api/api/interfaces/Filter.html

The Filter interface is an abstract base class for all filter types. It defines properties for field ID, field name, filter type, and worksheet name, along with methods to get applied worksheets, get the field, and set applied worksheets.

```APIDOC
## Interface Filter

### Description
An abstract base class for all of the filter types.

### Properties
- **fieldId** (string) - The ID of the field associated with the filter.
- **fieldName** (string) - The name of the field associated with the filter.
- **filterType** (FilterType) - The type of the filter (e.g., categorical, hierarchical, range, relative date).
- **worksheetName** (string) - The name of the worksheet where the filter is applied.

### Methods

#### getAppliedWorksheetsAsync()
Returns a promise that resolves to an array of worksheet names to which the filter is applied.

**Returns:** Promise<string[]>

#### getFieldAsync()
Returns a promise that resolves to the Field object associated with the filter.

**Returns:** Promise<Field>

#### setAppliedWorksheetsAsync(applyToWorksheets: string[])
Sets the worksheets to which the filter is applied. Takes an array of worksheet names and returns a promise that resolves to the updated array of worksheet names.

**Parameters:**
- **applyToWorksheets** (string[]) - The array of worksheet names to apply the filter to.

**Returns:** Promise<string[]>
```

--------------------------------

### hoverTupleAsync(hoveredTuple, tooltip?, allowHoverActions?)

Source: https://tableau.github.io/extensions-api/api/interfaces/Worksheet.html

Simulates hovering over a tuple, optionally showing a tooltip and allowing hover actions.

```APIDOC
## hoverTupleAsync(hoveredTuple, tooltip?, allowHoverActions?)

### Description
Simulates hovering over a tuple, optionally showing a tooltip and allowing hover actions.

### Method
Async method

### Signature
`hoverTupleAsync(hoveredTuple: number, tooltip?: null | TooltipContext, allowHoverActions?: boolean): Promise<void>`

### Parameters
#### Required Parameters
- **hoveredTuple** (number) - The ID of the tuple to hover.

#### Optional Parameters
- **tooltip** (null | TooltipContext) - Optional. Tooltip context to display.
- **allowHoverActions** (boolean) - Optional. Whether to allow hover actions.

### Returns
- **Promise<void>** - A promise that resolves when the hover action is complete.

### Example
```typescript
await worksheet.hoverTupleAsync(123);
```
```

--------------------------------

### Get underlying data table using getUnderlyingTableDataAsync

Source: https://tableau.github.io/extensions-api/api/interfaces/Worksheet.html

Retrieves the underlying data table for the first logical table. Use getUnderlyingTablesAsync to get logical table IDs. The maxRows option defaults to 0 (all rows), but the API limits results to 10,000 rows; check isTotalRowCountLimited to detect truncation.

```typescript
const logicalTables = await worksheet.getUnderlyingTablesAsync();
const dataTable = await worksheet.getUnderlyingTableDataAsync(logicalTables[0].id)
// process the dataTable...
```

--------------------------------

### getUnderlyingDataAsync

Source: https://tableau.github.io/extensions-api/api/interfaces/Worksheet.html

Gets the underlying data table for this worksheet. This method is deprecated; use getUnderlyingTableDataReaderAsync or getUnderlyingTableDataAsync instead.

```APIDOC
## getUnderlyingDataAsync

### Description
Gets the underlying data table for this worksheet. This method is deprecated; use getUnderlyingTableDataReaderAsync or getUnderlyingTableDataAsync instead.

### Method
Async method (returns Promise)

### Signature
```typescript
getUnderlyingDataAsync(options?: GetUnderlyingDataOptions): Promise<DataTable>
```

### Parameters
- **options** (GetUnderlyingDataOptions) - Optional - Collection of options to change the behavior of the call.

### Returns
Promise<DataTable> - A data table containing the underlying data for the worksheet.

### Deprecated
Use `Worksheet.getUnderlyingTableDataReaderAsync` or `Worksheet.getUnderlyingTableDataAsync`.
```

--------------------------------

### getHighlightedMarksAsync

Source: https://tableau.github.io/extensions-api/api/interfaces/Worksheet.html

Gets the data for the marks which are currently highlighted on the worksheet. If there are no marks currently highlighted, an empty model is returned.

```APIDOC
## getHighlightedMarksAsync()

### Description
Gets the data for the marks which are currently highlighted on the worksheet. If there are no marks currently highlighted, an empty model is returned.

### Method
Async method

### Endpoint
Worksheet.getHighlightedMarksAsync()

### Parameters
None

### Returns
Promise<MarksCollection> - The marks which are selected.
```

--------------------------------

### createVizImageAsync(inputSpec: object): Promise<string>

Source: https://tableau.github.io/extensions-api/api/interfaces/Extensions.html

Creates a viz image from an input specification object. Returns a promise that resolves to an SVG string.

```APIDOC
## createVizImageAsync(inputSpec: object): Promise<string>

### Description
Creates a viz image from an input specification object. The inputSpec object contains embedded data and visual spec details. Returns a promise that resolves to an SVG string.

### Method
createVizImageAsync

### Parameters
- **inputSpec** (object) - Required - The object containing the embedded data and visual spec details.

### Returns
Promise<string> - A promise that when resolved, returns the viz as an SVG.

### Since
1.8.0 and Tableau 2021.4

### Example
```javascript
tableau.extensions.createVizImageAsync(myInputSpec);
```

### Input Spec Example
```javascript
var myInputSpec = {
  description: 'A simple bar chart with embedded data.',
  data: {
    values: [
      { Category: 'A', Measure: 28, Weather: 10 },
      { Category: 'B', Measure: 55, Weather: 9 },
      { Category: 'C', Measure: 43, Weather: 8 },
    ]
  },
  mark: tableau.MarkType.Bar,
  encoding: {
    columns: { field: 'Category', type: tableau.VizImageEncodingType.Discrete },
    rows: { field: 'Measure', type: tableau.VizImageEncodingType.Continuous },
    sort: { field: 'Category', 'sortby': 'Weather', direction: tableau.VizImageSortDirectionType.Ascending }
  }
};
```

### Additional Information
For additional information on using the `createVizImageAsync` method, see [Add Tableau Viz to Your Dashboard Extensions](https://tableau.github.io/extensions-api/docs/core/trex_tableau_viz).
For additional information about setting options in the `inputSpec` object, see [Tableau Viz Reference](https://tableau.github.io/extensions-api/docs/trex_tableau_viz_ref).
```

--------------------------------

### getVisualSpecificationAsync

Source: https://tableau.github.io/extensions-api/api/interfaces/Worksheet.html

Returns the visual specification for the worksheet, which can be used to get the mappings from fields to encodings backing the visual within the worksheet.

```APIDOC
## getVisualSpecificationAsync()

### Description
Returns the visual specification for the worksheet, which can be used to get the mappings from fields to encodings backing the visual within the worksheet.

### Method
getVisualSpecificationAsync()

### Parameters
None

### Returns
- **Promise<VisualSpecification>** - Promise containing the VisualSpecification

### Since
1.11.0 and Tableau 2024.1

### Defined in
packages/api-external-contract-js/src/ExternalContract/Extensions/SheetInterfaces.ts:527
```

--------------------------------

### getLogicalTablesAsync()

Source: https://tableau.github.io/extensions-api/api/interfaces/DataSource.html

Gets the underlying logical tables used in the data source. Returns a promise that resolves to an array of LogicalTable objects.

```APIDOC
## getLogicalTablesAsync()

### Description
Gets the underlying logical tables used in the data source.

### Method
Async method

### Endpoint
N/A (SDK method)

### Parameters
None

### Returns
Promise<LogicalTable[]> - An array of logical tables that are currently used in the data source.

### Example
```javascript
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);
  });
});
```

### Since
1.4.0
```

--------------------------------

### getSummaryColumnsInfoAsync

Source: https://tableau.github.io/extensions-api/api/interfaces/Worksheet.html

Gets the columns that are returned with getSummaryDataAsync. Returns a Promise that resolves to an array of Column objects. Available since version 1.5.0.

```APIDOC
## getSummaryColumnsInfoAsync()

### Description
Gets the columns that are returned with `getSummaryDataAsync`.

### Method
Async method

### Signature
`getSummaryColumnsInfoAsync(): Promise<Column[]>`

### Parameters
None

### Returns
- **Promise<Column[]>** - The array of columns that describe the data in the worksheet.

### Since
1.5.0
```

--------------------------------

### setZoneVisibilityAsync: Using a Map for zoneVisibilityMap

Source: https://tableau.github.io/extensions-api/api/interfaces/Dashboard.html

Shows how to use a Map for the zoneVisibilityMap parameter of setZoneVisibilityAsync, as supported since version 1.4.0. The Map maps zone IDs to visibility types.

```javascript
var zoneVisibilityMap = new Map;
zoneVisibilityMap.set(10, tableau.ZoneVisibilityType.Show);
zoneVisibilityMap.set(8, tableau.ZoneVisibilityType.Hide);
```

--------------------------------

### getUnderlyingDataAsync(options?)

Source: https://tableau.github.io/extensions-api/api/interfaces/DataSource.html

Gets a page of data from the underlying data of the data source. This method is deprecated; use getLogicalTableDataReaderAsync or getLogicalTableDataAsync instead.

```APIDOC
## getUnderlyingDataAsync(options?)

### Description
Returns a promise containing a page of data from the underlying data of the data source.

### Method
Async method

### Endpoint
N/A (SDK method)

### Parameters
- `options` (DataSourceUnderlyingDataOptions) - Optional - Collection of options to change the behavior of the call.

### Returns
Promise<DataTable> - A promise containing a page of data from the underlying data of the data source.

### Example
```javascript
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);
```

### Deprecated
Use DataSource.getLogicalTableDataReaderAsync or DataSource.getLogicalTableDataAsync.
```

--------------------------------

### hoverTupleAsync(hoveredTuple: number, tooltip?: null | TooltipContext, allowHoverActions?: boolean): Promise<void>

Source: https://tableau.github.io/extensions-api/api/interfaces/Worksheet.html

Method to execute hover actions and render tooltip for a given tuple representing a mark in the visualization. If the tooltip parameter is included it will show the tooltip when the mark is hovered over. If null or no tooltip parameter is passed, no tooltip is shown. Hover actions are run by default, but passing false for the allowHoverActions parameter will prevent their execution.

```APIDOC
## hoverTupleAsync(hoveredTuple: number, tooltip?: null | TooltipContext, allowHoverActions?: boolean): Promise<void>

### Description
Method to execute hover actions and render tooltip for a given tuple representing a mark in the visualization. If the tooltip parameter is included it will show the tooltip when the mark is hovered over. If null or no tooltip parameter is passed, no tooltip is shown. Hover actions are run by default, but passing false for the allowHoverActions parameter will prevent their execution.

### Method
Async method

### Parameters
- **hoveredTuple** (number) - Required - The tuple id for the mark. To find the tuple id, subtract the index of the row from the total number of rows. For example, if you have 10 rows, the third row has tuple id 7 (10 - 3 = 7). The last row always has tuple id 1.
- **tooltip** (null | TooltipContext) - Optional - If included, shows the tooltip when the mark is hovered over. If null or omitted, no tooltip is shown.
- **allowHoverActions** (boolean) - Optional - If false, prevents execution of hover actions. Defaults to true.

### Returns
Promise<void> - Resolves when the extension host has successfully been informed of the request. Rejects on error.

### Since
1.12.0 and Tableau 2024.2

### Example
```javascript
svg.on('mousemove', (mouseEvent) => {
 const myHoveredTuple = 10;
 tableau.extensions.worksheetContent.worksheet.hoverTupleAsync(myHoveredTuple, { tooltipAnchorPoint: { x: mouseEvent.pageX, y: mouseEvent.pageY } })
   .then(() => console.log('Done'))
   .catch((error) => console.log('Failed to hover because of: ', error));
 });
```
```

--------------------------------

### getDashboardObjectById(dashboardObjectId: number): undefined | DashboardObject

Source: https://tableau.github.io/extensions-api/api/interfaces/Dashboard.html

Gets the specified dashboard object by its id. Returns undefined if the dashboard object is not found.

```APIDOC
## getDashboardObjectById(dashboardObjectId: number): undefined | DashboardObject

### Description
Gets the specified dashboard object by its id. If a dashboard object is not found this method returns undefined.

### Method
getDashboardObjectById

### Parameters
- **dashboardObjectId** (number) - Required - The id of an object on the dashboard.

### Returns
undefined | DashboardObject - The dashboard object with that id. Returns undefined if the dashboard object is not found.

### Since
1.7.0 and Tableau 2021.4

### Example
```javascript
var dashboard = tableau.extensions.dashboardContent.dashboard;
var myDashboardObject = dashboard.getDashboardObjectById(8);
```

### Defined In
packages/api-external-contract-js/src/ExternalContract/Extensions/SheetInterfaces.ts:821
```
Tokens:
Raw