This repository contains a wiki which contains developer documentation. You are encouraged to use it and also contribute.
- 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 start. - Launch Tableau and use the sample in a dashboard.
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. 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.
Use Issues to log any problems or bugs you encounter in the docs or sample code.
When invoking something from JS over to the C++ code, if there is an unhanded exception the Qt browser seems to become completely messed up and will not set up the web channel communications correctly any more until the process is restarted. This means if you get an exception which escapes, you might need to restart tableau in order to get things working again.
The binaries for Web Engine on MacOS still aren’t building correctly. That means Frelard is Windows only for now :( The new binaries should be available very soon though.
Some configurations for remote desktop seem to have issues where the browser is rendered as a black box. Most common is from a Mac to a machine running Windows 7 although we have Windows 7 machines that work and some that don't. No ideas yet on the cause.
While you can technically do any remote debugging you want with a recent build of Chrome, the reality is we have a slightly outdate Chromium install which has some incompatibilities in the debugging layer of things. This means stuff like eval-ing from the console won’t work properly. Fear not, you can download a legacy build of Chrome and use it for remote debugging (simply go to http://localhost:8696). Stay tuned for more info on debugging tips.