From 758fbb2835131508aff5e37adc6eb4b0b526f40f Mon Sep 17 00:00:00 2001 From: Noah Beasley <1342007+jakkyn@users.noreply.github.com> Date: Wed, 29 Aug 2018 15:47:13 -0700 Subject: [PATCH 1/4] Update readme.md (#152) Fixed typo of the word 'extension' in third sentence. --- Tutorial/readme.md | 2 +- docs/trex_release-notes.md | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+), 1 deletion(-) diff --git a/Tutorial/readme.md b/Tutorial/readme.md index 3270142a..fe52defd 100644 --- a/Tutorial/readme.md +++ b/Tutorial/readme.md @@ -2,7 +2,7 @@ This project contains a tutorial designed to explain the various components of authoring and using a Dashboard Extension in Tableau. -This tutorial demonstrates a number of different aspects of the Dashboard Extensions API. The goal of this extenison is to display a data table summarizing the selected marks on a particular worksheet on a dashboard (similar to clicking view data on a tooltip). When the selected marks change, we want to update the data table with the newly selected marks. Then we will add functionality which allows the user to click on any column of data in the selected marks and filter the viz down to the domain of that column. +This tutorial demonstrates a number of different aspects of the Dashboard Extensions API. The goal of this extension is to display a data table summarizing the selected marks on a particular worksheet on a dashboard (similar to clicking view data on a tooltip). When the selected marks change, we want to update the data table with the newly selected marks. Then we will add functionality which allows the user to click on any column of data in the selected marks and filter the viz down to the domain of that column. ### Prerequisites diff --git a/docs/trex_release-notes.md b/docs/trex_release-notes.md index 95ea9cbb..d87315d3 100644 --- a/docs/trex_release-notes.md +++ b/docs/trex_release-notes.md @@ -82,6 +82,25 @@ Bugs fixed in this release: - XSD validation of `minApiVersion` accepted only single digit version numbers (for example, `0.12` would fail). - Permissions denied error message would disappear after the dashboard zone was reloaded. +### Developer Preview (0.12.8) +*April 13, 2018* + +Update of the Tableau Extensions API +- Tableau Extensions API library: `tableau-extensions-0.12.8.js` +- Tableau Desktop, Tableau Server (from [Extensions API Developer Preview](https://prerelease.tableau.com/project/home.html?cap=52e2710a0793434d82142736c7ab3029){:target="_blank"}) + +Changes in this release: + +- This release of Tableau introduces a minor change in the workbook format that affects extensions. If you saved a workbook with an extension using an earlier version of Tableau, and then open the workbook with this current Tableau release, the workbook will open, but it will not have the extension. You will have to add the extension back in using the latest release of Tableau. + +Bugs fixed in this release: + +- Certain keyboard shortcuts were intercepted by Tableau and not passed on to the extension. This is now fixed, with the excecption of **cmd + V** on Mac, which will be fixed in a later release. ([Issues #76](https://github.com/tableau/extensions-api/issues/76)) +- Calls to `getSummaryDataAsync()` or `getUnderlyingDataAsync()` would not return the correct data types for the columns. Column property `datatype` returned `string` for all columns, regardless of actual data type of column. +- Web Authoring would throw an exception when an extension is added. +- XSD validation of `minApiVersion` accepted only single digit version numbers (for example, `0.12` would fail). +- Permissions denied error message would disappear after the dashboard zone was reloaded. + --- ### Developer Preview (0.12.7) From 9af4dc297931d3b86aa7dc7fc9338e8bcafdffd0 Mon Sep 17 00:00:00 2001 From: Dave Hagen Date: Thu, 30 Aug 2018 10:07:23 -0700 Subject: [PATCH 2/4] Update trex_configure.md (#156) Fixed JavaScript typo found by @jakkyn --- docs/trex_configure.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/trex_configure.md b/docs/trex_configure.md index 8eb31239..5d4334a3 100644 --- a/docs/trex_configure.md +++ b/docs/trex_configure.md @@ -84,7 +84,7 @@ $(document).ready(function () { })(); ``` -In the JavScript code for the popup dialog window, you would add your code for initializing the dialog and for setting and saving the configuration settings. +In the JavaScript code for the popup dialog window, you would add your code for initializing the dialog and for setting and saving the configuration settings. ```javascript From 2d1187c69158f6bf941a89e2763475e08223f0a0 Mon Sep 17 00:00:00 2001 From: Dave Hagen Date: Thu, 30 Aug 2018 10:13:39 -0700 Subject: [PATCH 3/4] Update trex_getstarted.md (#157) Fixed error found by @jakkyn - In the Choose dialog box, the Choose button is now My Extensions. --- docs/trex_getstarted.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/trex_getstarted.md b/docs/trex_getstarted.md index c89f6c21..dec46252 100644 --- a/docs/trex_getstarted.md +++ b/docs/trex_getstarted.md @@ -92,7 +92,7 @@ To use the dashboard extension samples, you need to start up a web server on you 2. In the dashboard, under **Objects**, select **Extension** and drag it on to the dashboard. ![]({{site.baseurl}}/assets/frelard_objects_extension.png){:height="25%" width="25%"} -3. In the **Choose an Extension** dialog box, click **Choose**. +3. In the **Choose an Extension** dialog box, click **My Extensions**. Every Tableau extension has a manifest file (`.trex`) that describes the extension and identifies the location of the web application. 4. Browse to the directory where the samples are located. For example, if you downloaded or cloned the GitHub repository, go to `\extensions-api\Samples`. 5. Open the `DataSources.trex` file. From 764371b367b912e3f950a94c3954f72397d59e90 Mon Sep 17 00:00:00 2001 From: Dave Hagen Date: Thu, 11 Oct 2018 11:09:49 -0700 Subject: [PATCH 4/4] Update trex_overview.md Add a what you can do list --- docs/trex_overview.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/trex_overview.md b/docs/trex_overview.md index 2221a440..9028e39a 100644 --- a/docs/trex_overview.md +++ b/docs/trex_overview.md @@ -12,10 +12,18 @@ layout: docs {:toc} ## Components of a Tableau dashboard extension -A Tableau extension consists of a manifest file (`.trex`), a web page that uses a Tableau-provided JavaScript library, and the JavaScript file (or files) that contain your extension logic. The Tableau extensions are supported on Tableau Desktop. +A Tableau extension consists of a manifest file (`.trex`), a web page that uses a Tableau-provided JavaScript library, and the JavaScript file (or files) that contain your extension logic. The Tableau extensions are supported on Tableau Desktop, Tableau Server, and Tableau Online. ![]({{site.baseurl}}/assets/extensions_dashboard_diagram.png) +## What can you do with a dashboard extension? + +Plenty! Using the Extensions API, you can create dashboard extensions that enable customers to integrate and interact with data from other applications directly in Tableau. + +* Integrate with third-party APIs inside the dashboard. +* Use third-party charting libraries like `d3.js` to add custom visualizations. +* Create an extension that has write-back functionality, so users can modify data in a viz and have that change automatically update the source data in the database or web application. +* Build custom viz and interactivity types, such as a filter replacement with a custom interface and network diagram. ## Extensions API library @@ -29,4 +37,4 @@ The Extensions API and the Embedded API (also known as the [JavaScript API](http * You can use the Embedded API for embedding Tableau dashboards in web pages (for example, blog posts), or in line of business applications. * You can use the Extensions API for integrating web applications into zones in Tableau dashboards. -The Extensions API and Embedded API share a similar programming model, but there are differences. The two APIs are not designed to be used together. In the Embedded API, the `Viz` or `VizManager` is the highest-level object. However, in the Extensions API there is no object model or concept for a `Viz` or `VizManager`. For the Extensions API, the workbook is the highest-level object a developer interacts with. \ No newline at end of file +The Extensions API and Embedded API share a similar programming model, but there are differences. The two APIs are not designed to be used together. In the Embedded API, the `Viz` or `VizManager` is the highest-level object. However, in the Extensions API there is no object model or concept for a `Viz` or `VizManager`. For the Extensions API, the workbook is the highest-level object a developer interacts with.