• Stars
    star
    268
  • Rank 153,144 (Top 4 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created over 7 years ago
  • Updated 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Extensions API sample code and developer docs.

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

Install Extensions API SDK Components and Start Server

  1. Open a command prompt window to the location where you cloned this repo.

  2. Install the Extensions API SDK components.

    npm install

  3. Build the TypeScript samples and install the Extensions API types library.

    npm run build

  4. Start the local Dashboard Extension server.

    npm start

  5. Launch Tableau and try the sample extensions in a dashboard. The samples are located in the Samples folder.

Note The local web server you start just serves to host the extension samples and extensions used in the tutorial, which have URLs similar to the following: http://localhost:8765/Samples/DataSources/datasources.html or http://localhost:8765/Samples-Typescript/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.

Typescript Development

Samples written in Typescript are located in the Samples-Typescript folder. If you want to use TypeScript to write your extensions, you can run a script that starts up the HTTP server and actively listens for changes to the .ts files located in the Samples-Typescript folder. You can then add your extension to the folder and use the script to transpile your extension to JavaScript.

  • To start the the HTTP server and listen for changes to the .ts files.

    npm run dev

For more information, see Use TypeScript with the Extensions API.

Sandboxed Extension Development Environment

Tableau is introducing development support for Sandboxed Extensions with Tableau 2019.3. Sandboxed Extensions run in a virtual sandbox and ensure the extension can’t make network calls outside of the hosting Tableau Server. The Extensions API SDK provides a local development environment that replicates the Tableau Hosting Cloud Service for Sandboxed Extensions. You can test your Sandboxed extensions locally with the same sandbox policies.

  1. Start the local Sandboxed Extension web server.

    npm run start-sandbox

  2. Launch Tableau (Tableau 2019.3 and later) and try the sample Sandboxed Extension in a dashboard. You can find the .trex file and sample code in the Samples\UINamespace-sandboxed folder.

For more information, see Create and Test Sandboxed Extensions.

Contributions

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). To submit a contribution, please fork the repository then submit a pull request to the main branch.

Code Style

Our sample code follows the Semi-Standard Style for JavaScript samples linting and tslint for TypeScript. If you add your own extension code to the Samples or Samples-Typescript directories, 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.

npx semistandard --fix to fix linting issues which can be fixed automatically.

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, or to discuss any proposed changes or additions.

More Repositories

1

TabPy

Execute Python code on the fly and display results in Tableau visualizations:
Python
1,558
star
2

webdataconnector

Bring the data you care about into Tableau
HTML
678
star
3

server-client-python

A Python library for the Tableau Server REST API
Python
656
star
4

rest-api-samples

Samples for the Tableau REST API
Python
379
star
5

document-api-python

Create and modify Tableau workbook and datasource files
Python
324
star
6

js-api-samples

Sample code for the Tableau JavaScript API
HTML
274
star
7

VizAlerts

Data-driven alerting for Tableau Server
Python
209
star
8

tableau-log-viewer

Tableau Log Viewer is a cross-platform tool for quickly glancing over Tableau log files
C++
168
star
9

hyper-api-samples

Sample code to get started with the Hyper API.
Python
134
star
10

community-tableau-server-insights

Community-built data sources for answering questions about Tableau Server
Python
125
star
11

TabMigrate

A lightweight tool for moving Tableau content between multiple Tableau Server environments
C#
120
star
12

Logshark

A Tableau log file analysis utility
C#
111
star
13

TabMon

A Tableau Server performance monitoring service
C#
109
star
14

connector-plugin-sdk

SDK for Developing Tableau Connector Plugins
Python
108
star
15

tabjolt

Load generator for Tableau Server
105
star
16

ts-checked-fsm

TypeScript library providing compile-time checking for state machine transitions
TypeScript
94
star
17

tableau-ui

React UI components that have the look-and-feel of Tableau.
CSS
92
star
18

query-graphs

A visualizer for queries - Hyper, Postgres, Tableau
TypeScript
88
star
19

server-install-script-samples

Sample code showing how to script Tableau Server installations
Python
83
star
20

altimeter

Graph AWS resources in Neptune
Python
82
star
21

metadata-api-samples

This repo holds samples using the Tableau Metadata API with Tableau Server or Tableau Online.
70
star
22

tableau-viz-lwc

(Archived) Lightning Web Component for embedding Tableau into Salesforce
65
star
23

embedding-playbook

You want to embed your Tableau content in lots of places. Start here.
CSS
57
star
24

tableau-server-in-kubernetes

Examples and documentation on how to run Tableau Server in a Container within a Kubernetes environment.
43
star
25

tabcmd

A Python based app that replicates the functionality of the existing TabCMD command line utility
Python
42
star
26

custom-portal-sample

Sample code showing how to integrate and embed Tableau in a web portal
HTML
39
star
27

webhooks-docs

Webhooks developer documentation and resources.
38
star
28

tableau-data-dictionary

This data dictionary provides information about the tables and views in the "workgroup" PostgreSQL database of the Tableau Server repository.
HTML
38
star
29

react-native-dns-lookup

A React Native module that leverages iOS and Android native networking libraries to lookup all of the IP addresses associated with a hostname
Objective-C
32
star
30

embedding-api-v3-samples

Samples for the Tableau Embedding API V3.
HTML
28
star
31

embedding-api-v3-guide

migration guide for moving to embedding api v3
28
star
32

mobile-app-bootstrap-react-native

A React Native template for creating iOS and Android apps that embed Tableau vizzes
JavaScript
26
star
33

mobile-app-bootstrap-cordova

A Cordova template for creating iOS apps that embed Tableau vizzes
JavaScript
22
star
34

tableau-docker-samples

Samples for Dockers for Tableau Server/Online clients
21
star
35

hyper-db

Documentation for Hyper, the blazingly fast SQL engine powering analytics at Tableau and Salesforce
TypeScript
19
star
36

npm-pack-here

An alternative to the Yarn link and NPM link workflows, this tool packs a local NPM project and puts the packed contents into the given destination directories.
TypeScript
19
star
37

extension-data-driven-parameters

Automatically update your parameters based on your data!
JavaScript
18
star
38

datadev-hackathon

Resources and materials for Tableau #DataDev hackathons.
17
star
39

redshift-monitor

Capture, save, and analyze AWS Redshift performance metrics
JavaScript
17
star
40

analytics-extensions-api

Extend Tableau to dynamically include popular data science programming languages and external tools and platforms.
HTML
17
star
41

teenypath

A filesystem wrapper
C++
16
star
42

tableau-postman

This repo is for the Tableau REST API Postman collection hosted in the Salesforce Developers Postman workspace. Use the collection to call your Tableau Server or Tableau Cloud site for demonstrations, learning, development & testing of any method in the API.
16
star
43

tableau-migration-sdk

An SDK for building your own application to migrate to a new Tableau environment.
C#
15
star
44

Visualization-Linting

Code associated with a research project for experimenting with different ways of surfacing stylistic, analytic, or visual discrepancies in visualizations.
JavaScript
14
star
45

mobile-app-bootstrap-objc

An Objective-C template for creating iOS apps that embed Tableau vizzes
Objective-C
13
star
46

TabProvision

TabProvision is a flexible tool for automating user/role/groups provisioning in Tableau Cloud
C#
12
star
47

octopus-python-client

Python script and a GUI to manage Octopus deploy servers through the Octopus Restful APIs
Python
12
star
48

tc16

Companion tool for attendees of Tableau Conference 2016
CSS
11
star
49

tab-compare

TabCompare is a visual comparison tool to understand differences in dashboards across different versions of Tableau.
Python
11
star
50

tableau.github.io

Contains the content for Tableau's OSS contribution guidelines
HTML
10
star
51

connected-apps-jwt-samples

Java
9
star
52

emb-hot-ca-v3

Embedded Hands-on-training course materials. Connected Apps and Embedding API v3
CSS
8
star
53

extension-date-updater

Automatically update your date parameters to today's date.
TypeScript
8
star
54

discover-pane-template

Template for customizing the Tableau Desktop Discover Pane
HTML
8
star
55

extension-hierarchy-navigator-sandboxed

Visualize your flat/dimensional or recursive data in a Tree/Hierarchy Extension an a Tableau Dashboard
JavaScript
8
star
56

mobile-connected-client

Keep mobile users signed in with long-lived tokens. Works alone or in conjunction with the Mobile App Bootstrap
Objective-C
8
star
57

extension-parameter-actions

A Tableau extension that allows you to update parameter values from worksheet selections.
JavaScript
7
star
58

tableau-data-acceleration-client

A script to help administrators configure data acceleration for specific workbooks.
Python
7
star
59

extension-filter-bookmarks

Instantly revert your dashboards to predefined filter settings.
JavaScript
6
star
60

wdc3

Web Data Connector (WDC), connecting to web application data from Tableau.
6
star
61

redux-saga-observer

a library that provides observer patterns to redux-sagas, allowing powerful abstractions
TypeScript
5
star
62

bridgectl

Tableau Bridge Utilities
5
star
63

extension-jungle-book

This extension allows you to create filters using shapes mapped on top of images.
TypeScript
5
star
64

vail

VAIL (Visual Analytic Intent Language) is a language for modeling user intent, inferring missing or ambiguous intent, and figuring out how to effectively visualize intent
TypeScript
4
star
65

wdclib

Used to generate the WDC shim library
JavaScript
4
star
66

Tableau-TA

4
star
67

gradle-test-timeout

Gradle plugin to turn hanging JUnit4 tests into TestTimedOutExceptions
Kotlin
4
star
68

extension-single-checkbox-parameters

Dashboard extension which enables adding a parameter to a Tableau dashboard which will display in the UI as a single checkbox.
JavaScript
3
star
69

tableau-viz-lwc-samples

(Archived) This repository contains sample code that shows how you can add the Tableau Viz Lightning web component (LWC) within the body of another Lightning web component.
JavaScript
3
star
70

connectivity-support

Provides a set of tools which can be used to diagnose common infrastructure concerns in the connectivity layer.
C++
3
star
71

VizQL-Data-Service-API-Postman-Collection

2
star
72

create-tableau-dashboard-extension

JavaScript
2
star
73

extension-quick-what-if

A dashboard extension that allows you to create a list of controllable inputs based on values of a dimension for quick what-if analysis.
JavaScript
2
star
74

bridge_k8s_poc

Shell
2
star
75

hyper-api-dotnet

C#
2
star
76

sf-exp-cloud-tableau-embedded-analytics

JavaScript
1
star
77

bridge_docker_build

Shell
1
star
78

Accelerators

This repository is used to share external prerequisites for dashboard accelerators that are published to exchange.tableau.com
1
star
79

container_image_builder

Use this tool to install database drivers and other artifacts needed in your Tableau containers.
Shell
1
star