Extensions API sample code and developer docs.
Clone or download
d45 Adding the doc updates for TC18 (#166)
* Update readme.md (#152)

Fixed typo of the word 'extension' in third sentence.

* Update trex_configure.md (#156)

Fixed JavaScript typo found by @jakkyn

* Update trex_getstarted.md (#157)

Fixed error found by @jakkyn - In the Choose dialog box, the Choose button is now My Extensions.

* Update trex_overview.md (#160)

Added the "what you can do list" to the overview page

* Doc update to add design guidelines, tableau UI links, and localhost info (#165)

Adding the doc updates for TC18 (Design Guidelines, Tableau UI link).

* Update trex_security.md

adding a comma to help fix a weird sentence.
Latest commit 0dbfcc9 Oct 22, 2018

README.md

Tableau Extensions API

Tableau Supported

Image of Flex the T-Rex

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

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.