The Extensions API lets you do more without leaving Tableau. Build Tableau extensions that can interact and communicate with Tableau, and embed them directly in your workbooks.
- You must have Node.js and npm installed. You can get these from http://nodejs.org.
- Copy the
.trexfiles of the sample you wish to run to~\Documents\My Tableau Repository (Beta)\Extensionsso they are available to Tableau. - Open a command prompt window to the location where you cloned this repo.
- Run
npm install. - Run
npm run build. - Run
npm start. - Launch Tableau and use the sample in a dashboard.
Samples written in Typescript are located in the Samples-Typescript folder. To support local typescript development, npm run dev command starts up the http server and actively listens for changes to the .ts files located in the Sample-Typescript folder.
Note The web server just serves the extension samples and tutorial, which have URLs similar to the following:
http://localhost:8765/Samples/DataSources/datasources.htmlorhttp://localhost:8765/Samples-Typescript/DataSources/datasources.htmlThis local web server is not intended to serve the Extensions API Help pages. View the Help on GitHub at https://tableau.github.io/extensions-api.
We would love submissions to either the Docs or Sample code! To contribute, first sign our CLA that can be found here. To submit a contribution, please fork the repository then submit a pull request to the submissions branch.
Our sample code follows the Semi-Standard Style for JavaScript samples linting and tslint for TypeScript. If you add your own extension code to the Samples or Samples-Typescript directories, you can run npm run lint to validate the style of your code. Please run this command before submitting any pull requests for Sample code.
Code contributions and improvements by the community are welcomed! See the LICENSE file for current open-source licensing and use information.
Before we can accept pull requests from contributors, we require a signed Contributor License Agreement (CLA).
Visit the project website and read the documentation here.
Use Issues to log any problems or bugs you encounter in the docs or sample code.