diff --git a/_includes/footer.html b/_includes/footer.html index 5b2182fa..b0c6efb7 100644 --- a/_includes/footer.html +++ b/_includes/footer.html @@ -2,7 +2,7 @@ diff --git a/_includes/head.html b/_includes/head.html index 0160982e..b2358ef0 100644 --- a/_includes/head.html +++ b/_includes/head.html @@ -1,6 +1,7 @@ + {% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %} diff --git a/_includes/header.html b/_includes/header.html index 8566222a..c67ed24d 100644 --- a/_includes/header.html +++ b/_includes/header.html @@ -9,14 +9,14 @@ - +
+
+ Developer Preview: This is preliminary documentation and is subject to change. +
{{ content }} {% include footer.html %} diff --git a/docs/search.md b/docs/search.md new file mode 100644 index 00000000..c35daec3 --- /dev/null +++ b/docs/search.md @@ -0,0 +1,5 @@ +--- +title: Search +layout: search +--- + diff --git a/docs/trex_api_about.md b/docs/trex_api_about.md index b5d9880e..088a7c16 100644 --- a/docs/trex_api_about.md +++ b/docs/trex_api_about.md @@ -3,11 +3,6 @@ title: Tableau Extensions API Basics layout: docs --- -
- Developer Preview: This is preliminary documentation and is subject to change. -
- - The Tableau Extensions API is organized by namespaces. The type of extension you create determines the set of namespaces the extension will have access to. For example, if you create and register a dashboard extension, the extension will have access to the `dashboardContent` namespace, which provides access to the dashboard object. When you have the dashboard object, you have access to all elements in the dashboard, including the worksheets, marks, filters, parameters, and data sources. diff --git a/docs/trex_debugging.md b/docs/trex_debugging.md index 76303214..a150c400 100644 --- a/docs/trex_debugging.md +++ b/docs/trex_debugging.md @@ -3,10 +3,6 @@ title: Remote Debugging of JavaScript and HTML layout: docs --- -
- Developer Preview: This is preliminary documentation and is subject to change. -
- A dashboard extension embeds a web page and runs a Chromium-based browser inside of Tableau. Fortunately, you can debug this embedded web browser using the remote debugging abilities built-in to Chromium. ## Setup diff --git a/docs/trex_events.md b/docs/trex_events.md index 1e6c812e..7d7c6f9b 100644 --- a/docs/trex_events.md +++ b/docs/trex_events.md @@ -3,11 +3,6 @@ title: Events and Event Handling layout: docs --- -
- Developer Preview: This is preliminary documentation and is subject to change. -
- - In Tableau dashboard extensions, event handling operates at the sheet level. In the Extensions API, the `sheet` is an abstract class that both `dashboard` and `worksheet` inhierit from. You can add event listeners on individual sheets in a dashboard or on the entire dashboard itself. If you have an event listener, when the specified event is raised, the callback method you provide is called to handle the event. You can use event listeners to trigger specific actions based upon dashboard interactions. The Tableau Extension API supports a range of events and provides methods for adding and removing event listeners. To manage the event listener, each sheet has an *event listener manager*. The manager provides a way to add or remove multiple events on sheets independently. @@ -32,4 +27,4 @@ In most cases, you can create an event listener by chaining the methods to the s sheet.getEventListenerManager().addEventListener(tableau.TableauEventName.MarksSelection, selectionChangedEvent); ``` -For more information, check out the example extension, SelectedMarksDemo. \ No newline at end of file +For more information, check out the example extension, SelectedMarksDemo. diff --git a/docs/trex_examples.md b/docs/trex_examples.md index cf79e404..93a6cf74 100644 --- a/docs/trex_examples.md +++ b/docs/trex_examples.md @@ -3,11 +3,6 @@ title: Dashboard Extension Samples layout: docs --- -
- Developer Preview: This is preliminary documentation and is subject to change. -
- - To examine the sample source code and to see how Tableau dashboard extensions work, you can clone or download the [Extensions API](https://github.com/tableau/extensions-api) repository on GitHub and run the samples. The samples are in the `Samples` folder. There is also a step-by-step tutorial you can follow in the `Tutorial` folder. You can also check out the dashboard extensions from the community, see [Community Extensions]({{ site.baseurl }}/community/). diff --git a/docs/trex_getstarted.md b/docs/trex_getstarted.md index 583dca6e..a493df1b 100644 --- a/docs/trex_getstarted.md +++ b/docs/trex_getstarted.md @@ -3,11 +3,6 @@ title: Get Started layout: docs --- -
- Developer Preview: This is preliminary documentation and is subject to change. -
- - The Tableau Extensions API allows developers to create extensions for Tableau. Tableau extensions are web applications that can interact and communicate with Tableau. This section will take you through the process of setting up Tableau to use one of the sample dashboard extensions. A dashboard extension is a web application that can be placed in the dashboard like any other dashboard object. diff --git a/docs/trex_manifest.md b/docs/trex_manifest.md index 2f0b4a2b..290e62ad 100644 --- a/docs/trex_manifest.md +++ b/docs/trex_manifest.md @@ -3,11 +3,6 @@ title: Tableau Extension Manifest File layout: docs --- -
- Developer Preview: This is preliminary documentation and is subject to change. -
- - The extension manifest file (`.trex`) contains metadata for the add-in and is used for registration. For details about a manifest or its fields, see the [Sample Manifest File](#sample-manifest-file) and [Elements of the Manifest File](#elements-of-the-manifest-file). diff --git a/docs/trex_release-notes.md b/docs/trex_release-notes.md index 0cb04609..08dbabae 100644 --- a/docs/trex_release-notes.md +++ b/docs/trex_release-notes.md @@ -3,7 +3,6 @@ title: Release Notes for the Tableau Extensions API layout: docs --- - **In this section** * TOC @@ -17,4 +16,4 @@ Initial release of the Tableau Extensions API. Provides supports for dashboard e Tableau Extensions API library: `tableau-extensions-0.6.0.js` -Tableau Desktop 10.5 beta \ No newline at end of file +Tableau Desktop 10.5 beta diff --git a/docs/trex_tutorial.md b/docs/trex_tutorial.md index b8f17bda..6659e1a6 100644 --- a/docs/trex_tutorial.md +++ b/docs/trex_tutorial.md @@ -1,12 +1,9 @@ --- title: Dashboard Extension Tutorial layout: docs +indexed_by_search: false --- -
- Developer Preview: This is preliminary documentation and is subject to change. -
- This tutorial walks you through the steps of creating and running a dashboard extension. The tutorial is based on the Marks Selection sample. This tutorial assumes you have downloaded or cloned the Extensions API repository. The code for the Marks Selection sample can be found in the `Tutorial` folder. You can either jump to that folder directly and check out the code, or you can follow the instructions on this page where we will walk through each step and create the files needed to build the extension. @@ -244,4 +241,4 @@ To take advantage of the settings API, we add calls to `tableau.extensions.setti The final step of our tutorial will be about performing actions on our dashboard. For our example, this will mean selecting a set of marks from a workbook which the user has previously bookmarked. Other examples of actions are things like filtering a viz, changing the value of a parameter, or refreshing a data source to update a viz. -To use the select marks API, we first need to get the worksheet we want to select marks for by searching for it by name. Once we have the worksheet back, we can call `worksheet.selectMarksAsync()`. \ No newline at end of file +To use the select marks API, we first need to get the worksheet we want to select marks for by searching for it by name. Once we have the worksheet back, we can call `worksheet.selectMarksAsync()`. diff --git a/docs/trex_using_addin.md b/docs/trex_using_addin.md index 51854a61..405248d7 100644 --- a/docs/trex_using_addin.md +++ b/docs/trex_using_addin.md @@ -1,7 +1,8 @@ --- title: Using a Tableau Add-In layout: docs ---- +indexed_by_search: false +--- When a Tableau Extension is installed, it appears on the dashboard sheet, under **Add-Ins**. You can use the extension like you would any other dashboard object. For information about creating and installing Tableau extensions, see [Creating a Tableau-Extension]({{site.baseurl}}/docs/trex_create.html). diff --git a/index.html b/index.html index 89f36dc3..bbf7e77e 100644 --- a/index.html +++ b/index.html @@ -32,7 +32,7 @@

API Reference

- News Link + News Link

Samples

View the sample extensions and add them to your dashboards in Tableau. Also check out the Community Extensions.