The best way to learn how to build your own extensions is to look at the sample code. To examine the sample source files to see how Tableau dashboard extensions work, you can clone or download the Extensions API SDK on GitHub and run the samples or the tutorial.
To download the Extensions API SDK, if you have not already done so, see Get Started.
You can also create dashboard extensions using TypeScript. See the TypeScript sample code in Samples-TypeScript on GitHub.
You can also check out the dashboard extensions from the community, see Community Extensions.
In this section
The following instructions assume that you have already downloaded and extracted the files or have cloned the Extensions API SDK to your desktop.
The dashboard extension samples are in the
Samples folder. There is also a step-by-step tutorial you can follow in the
Shows how to use the
getDataSourcesAsync function to find the names of the data sources for each worksheet in the dashboard. Like the Filtering sample, the DataSources sample makes use the
Promise.all function to combine the promises from the asynchronous calls together, and then waits for them to resolve.
Demonstrates how to use the
getFiltersAsync function to find and display the active filters in the dashboard and calls the
addEventListener function to set a
FilterChanged event on each workbook in the dashboard. Any time a filter value is changed, the extension refreshes the table that displays the active filters.
Finds and displays all the parameters in the dashboard and then sets an event listener that waits for a parameter to change, which triggers a refresh.
settings namespace to save settings (key-value pairs) for the extension. Demonstrates how you can save settings for each instance of an extension, which enables sharing common views of a workbook.
Demonstrates how you can use the
UI namespace to create a modal dialog box (or popup) that runs another extension, which allows users to interact and change the settings for the parent extension. This sample controls the background auto-refresh interval for data sources in a dashboard.
Walks you through the step-by-step process of creating and refining an extension that displays a summarized table of the currently selected marks.
The Samples-Typscript folder shows how you can use the Extensions API type definitions to create extensions in TypeScript. The sample extensions include TypeScript versions of the Datasources, Filtering, and Parameters samples. For more information, see Use the TypeScript samples and Use TypeScript with the Extensions API.
To use the dashboard extension samples, you need to start up a web server on your computer to host the HTML pages. If you downloaded or cloned the Extensions API repository, you can start the web service in the root directory of the repository on your computer. These commands start the Node.js basic service
The samples are set up so that the web server is using port
8765. If you need to specify a different port instead of
8765, you can change ports using another Node.js or
extensions-api folder, you can start the
http-server using one of the following commands. Replace
PORT with the port you are using (for example,
To install the
http-serveron your computer globally and to also start the server:
npm install http-server -g && http-server -p PORT
If you have already installed
http-server, you can start the server directly:
http-server -p PORT
The port you use for the web server also has to match the port specified in the manifest file (
.trex) for the server.
<source-location> <url>http://localhost:PORT/samples/parameters/parameters.html</url> </source-location>
After you start the web server to host the sample extensions, you can try the extensions in Tableau.
.trexfile (for example,
.trex) that describes the extension and identifies the location of the web application.
Build the TypeScript samples:
npm run build
Run lint with the semistandard package.
npm run lint
npm run dev
\extensions-api\Samples-Typescript. The folder contains the TypeScript versions of the Datasources, Filtering, and Parameters samples.
webpack.config.jsfile for your extension TypeScript file. Update the path to your extension in the
.trexfile. Build and run your extension using the same commands you use to build the samples. For more information, see Use TypeScript with the Extensions API.