Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _includes/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<footer>
<div class="row">
<hr class="footer-hr">
<p>This site is open source. Suggestions and pull requests are welcome on our <a href="https://github.com/tableau/ProjectFrelard">GitHub page</a>.</p>
<p>This site is open source. Suggestions and pull requests are welcome on our <a href="https://github.com/tableau/extensions-api">GitHub page</a>.</p>
<p>(c) Copyright 2017 Tableau</p>
</div>
</footer>
1 change: 1 addition & 0 deletions _includes/head.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="robots" content="noindex">

<title>{% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %}</title>
<meta name="description" content="{% if page.excerpt %}{{ page.excerpt | strip_html | strip_newlines | truncate: 160 }}{% else %}{{ site.description }}{% endif %}">
Expand Down
4 changes: 2 additions & 2 deletions _includes/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand navbar-brand-logo" href="{{ site.baseurl }}/#">Tableau Extensions API - <b><i>Developer Preview</i></b></a>
<a class="navbar-brand navbar-brand-logo" href="{{ site.baseurl }}/#">Tableau Extensions API <span class="hidden-xs">- <b><i>Developer Preview</i></span></b></a>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li><a href="{{ site.baseurl }}/docs/trex_getstarted.html">Docs</a></li>
<li><a href="{{ site.baseurl }}/docs/index.html" target="_blank">API Reference</a></li>
<li><a href="{{ site.baseurl }}/docs/trex_examples.html">Samples</a></li>
<li><a href="{{ site.baseurl }}/community/">Community Extensions</a></li>
<li><a href="{{ site.baseurl }}/community/">Community Extensions</a></li>
<li><a target="_blank" href="https://community.tableau.com/community/developers/">Forum</a></li>
<li><a href="{{ site.baseurl }}/docs/trex_release-notes.html">Release Notes</a></li>
</ul>
Expand Down
3 changes: 3 additions & 0 deletions _layouts/docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ <h1>{{ page.title }}</h1>
<a href="https://github.com/tableau/projectfrelard/issues" class="edit-links"><span class="glyphicon glyphicon-flag"></span> Submit an issue</a>
</div>
<br />
<div class="alert alert-info">
<i><b>Developer Preview:</b> This is preliminary documentation and is subject to change.</i>
</div>
{{ content }}
{% include footer.html %}
</div>
Expand Down
5 changes: 5 additions & 0 deletions docs/search.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: Search
layout: search
---

5 changes: 0 additions & 5 deletions docs/trex_api_about.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@ title: Tableau Extensions API Basics
layout: docs
---

<div class="alert alert-info">
<i><b>Developer Preview:</b> This is preliminary documentation and is subject to change.</i>
</div>


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.


Expand Down
4 changes: 0 additions & 4 deletions docs/trex_debugging.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,6 @@ title: Remote Debugging of JavaScript and HTML
layout: docs
---

<div class="alert alert-info">
<i><b>Developer Preview:</b> This is preliminary documentation and is subject to change.</i>
</div>

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
Expand Down
7 changes: 1 addition & 6 deletions docs/trex_events.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@ title: Events and Event Handling
layout: docs
---

<div class="alert alert-info">
<i><b>Developer Preview:</b> This is preliminary documentation and is subject to change.</i>
</div>


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.
Expand All @@ -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.
For more information, check out the example extension, SelectedMarksDemo.
5 changes: 0 additions & 5 deletions docs/trex_examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@ title: Dashboard Extension Samples
layout: docs
---

<div class="alert alert-info">
<i><b>Developer Preview:</b> This is preliminary documentation and is subject to change.</i>
</div>


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/).
Expand Down
5 changes: 0 additions & 5 deletions docs/trex_getstarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@ title: Get Started
layout: docs
---

<div class="alert alert-info">
<i><b>Developer Preview:</b> This is preliminary documentation and is subject to change.</i>
</div>


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.
Expand Down
5 changes: 0 additions & 5 deletions docs/trex_manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,6 @@ title: Tableau Extension Manifest File
layout: docs
---

<div class="alert alert-info">
<i><b>Developer Preview:</b> This is preliminary documentation and is subject to change.</i>
</div>


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).
Expand Down
3 changes: 1 addition & 2 deletions docs/trex_release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ title: Release Notes for the Tableau Extensions API
layout: docs
---


**In this section**

* TOC
Expand All @@ -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
Tableau Desktop 10.5 beta
7 changes: 2 additions & 5 deletions docs/trex_tutorial.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
---
title: Dashboard Extension Tutorial
layout: docs
indexed_by_search: false
---

<div class="alert alert-info">
<i><b>Developer Preview:</b> This is preliminary documentation and is subject to change.</i>
</div>

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.
Expand Down Expand Up @@ -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()`.
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()`.
3 changes: 2 additions & 1 deletion docs/trex_using_addin.md
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h3>API Reference</h3>
</div>
<div class="col-md-3 text-center">
<div class="thumbnail thumb-home">
<a href="{{ site.baseurl }}/docs/trex_examples.html"><img src="{{ site.baseurl }}/assets/tflx.png" class="img-home" alt="News Link"></a>
<a href="{{ site.baseurl }}/docs/trex_examples.html"><img src="{{ site.baseurl }}/assets/flex.png" class="img-home" alt="News Link"></a>
<div class="caption">
<h3>Samples</h3>
<p>View the sample extensions and add them to your dashboards in Tableau. Also check out the <a href="{{ site.baseurl }}/community/">Community Extensions.</a></p>
Expand Down