Tableau Extensions Api (with TypeScript Example)

This project is a fork of the Tableau Extensions Api to demonstrate usage of Typescript with the extension API.

Generated JavaScript targets ES2017 (which works in Tableau 2019.1+) and takes advantages of features like classes, async/await, tslint's more advanced suggestions of when to use let/const.

The Samples\DataSources project trex project has been converted to Typescript and resides in the Samples\DataSources-TypeScript folder

To build

npm run build

To start in development mode where changes are recompiled on file save and the server is started.

npm run dev

When using an IDE like WebStorm, it may compile on save for you

Tableau Extensions API

Why the Tableau Extensions API?

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.

Setup and Running Samples

Prerequisites

• You must have Node.js and npm installed. You can get these from http://nodejs.org.

Setup

1. Copy the .trex files of the sample you wish to run to ~\Documents\My Tableau Repository (Beta)\Extensions so they are available to Tableau.
2. Open a command prompt window to the location where you cloned this repo.
3. Run npm install.
4. Run npm start.
5. Launch Tableau and use the sample in a dashboard.

Note The web server just serves the extension samples and tutorial, which have URLs similar to the following: http://localhost:8765/Samples/DataSources/datasources.html This 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.

Submissions

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.

Code Style

Our sample code follows the Semi-Standard Style. If you add your own extension code to the Samples directory, 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.

Contributions

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).

Documentation

Visit the project website and read the documentation here.

Issues

Use Issues to log any problems or bugs you encounter in the docs or sample code.