KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #typescript #claude-code #codex #dsh #dsh-plugin #ai-agent #ai-agents #deepseek-harness #agent-skills #macos #cli

js-api-samples

★ 279 Open GitHub ↗

Sample code for the Tableau JavaScript API

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# js-api-samples

[![Deprecated](https://img.shields.io/badge/Deprecated-do%20not%20use-orange)](https://www.tableau.com/support-levels-it-and-developer-tools)

## Deprecated 
Do not use this project.
To get started with Tableau embedding, see https://github.com/tableau/embedding-playbook
For sample code that demonstrates the v3 embedding API, see https://github.com/tableau/embedding-api-v3-samples
For a guide to migrating your code to the v3 embedding API, see https://github.com/tableau/embedding-api-v3-guide

------------------

This repository contains samples for the Tableau JavaScript API. You will also find companion content here for the JS API video series. Official developer 
docs for the JS API can be found [here](https://onlinehelp.tableau.com/current/api/js_api/en-us/JavaScriptAPI/js_api.htm).

Getting Started
---------------
* Clone this repository
* Try the samples
* Use 'Issues' to note any bugs or to request new samples
* Let us know if you have samples of your own you'd like to share
* Check out the Tableau Developer Portal at http://developers.tableau.com for a tutorial, the official docs, and the community forum

JS API Samples
---------------
These are created and maintained by Tableau.

Demo | Source Code | Description
-------- |  -------- |  --------
[Basic Embed](http://tableau.github.io/js-api-samples/basicEmbed.html) | [basicEmbed.html](basicEmbed.html) | Embed a visualization in a div element. 
[Dynamic Load](http://tableau.github.io/js-api-samples/dynamicLoad.html) | [dynamicLoad.html](dynamicLoad.html) | Dynamically load and remove visualizations. Click the Previous and Next buttons to display other visualizations in a predefined list. 
[Export to PDF](http://tableau.github.io/js-api-samples/exportToPDF.html) | [exportToPDF.html](exportToPDF.html) | Export the current visualization view to a PDF file.
[Filter](http://tableau.github.io/js-api-samples/filter.html) | [filter.html](filter.html) | Apply a filter to a visualization using controls on the page.
[Get Data](http://tableau.github.io/js-api-samples/getDataBasic.html) | [getDataBasic.html](getDataBasic.html) |  Get the underlying data for the currently displayed viz.
[Resize](http://tableau.github.io/js-api-samples/resize.html) | [resize.html](resize.html) | Resize a visualization to a size that you specify. 
[Respond to Events](http://tableau.github.io/js-api-samples/respondToEvents.html) | [respondToEvents.html](respondToEvents.html) | Display information about marks as you select them.
[Select Marks](http://tableau.github.io/js-api-samples/selectMarks.html) | [selectMarks.html](selectMarks.html) | Select a set of marks in a visualization.

## Videos
The videos are hosted on YouTube:

| Title | Length | Learning Objectives |
| --- | --- | --- |
| [JS API: Introduction](https://youtu.be/Geppur9LDnw?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ) | 13:39 | Why to use JS API, how it works, get started using it, helpful resources Detailed Outline: [Learning objectives (00:50)](https://youtu.be/Geppur9LDnw?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=50) [Why use the JS API? (01:36)](https://youtu.be/Geppur9LDnw?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=96) [What do you need? (06:53)](https://youtu.be/Geppur9LDnw?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=413) [How it works (07:28)](https://youtu.be/Geppur9LDnw?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=448) [HTML & JS code (09:17)](https://youtu.be/Geppur9LDnw?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=557) [More resources (12:00)](https://youtu.be/Geppur9LDnw?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=720) |
| [JS API: Tutorial Walk-Through](https://youtu.be/QYxPzwhT08I?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ) | 27:09 | Embedding a viz, using Filters and Tabs, Selecting values, export to PDF and CSV, custom JavaScript for events Detailed Outline: [Learning objectives (01:22)](https://youtu.be/QYxPzwhT08I?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=82) [Starting the tutorial (02:20)](https://youtu.be/QYxPzwhT08I?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=140) [Embedding the viz (04:09)](https://youtu.be/QYxPzwhT08I?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=249) [Filtering (06:35)](https://youtu.be/QYxPzwhT08I?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=395) [Switching tabs (08:08)](https://youtu.be/QYxPzwhT08I?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=488) [Selecting values (09:21)](https://youtu.be/QYxPzwhT08I?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=561) [Chaining calls (11:12)](https://youtu.be/QYxPzwhT08I?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=672) [Working with sheets (15:26)](https://youtu.be/QYxPzwhT08I?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=926) [Using the toolbar (19:08)](https://youtu.be/QYxPzwhT08I?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=1148) [Eventing (20:39)](https://youtu.be/QYxPzwhT08I?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=1239) [More resources (25:35)](https://youtu.be/QYxPzwhT08I?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=1535) |
| [JS API: Embedding and Interactions](https://youtu.be/ylc3zdZ897g?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ) | 22:58 | More with embedding, switching tabs, filtering and selecting marks Detailed Outline: [Learning objectives (00:58)](https://youtu.be/ylc3zdZ897g?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=58) [Prerequisites (01:24)](https://youtu.be/ylc3zdZ897g?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=84) [Companion content set-up (02:15)](https://youtu.be/ylc3zdZ897g?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=135) [Project overview & coding environment (03:14)](https://youtu.be/ylc3zdZ897g?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=194) [Adding the JS API library (05:54)](https://youtu.be/ylc3zdZ897g?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=354) [Adding &lt;div&gt; for the viz (06:56)](https://youtu.be/ylc3zdZ897g?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=416) [Custom JS functions (07:40)](https://youtu.be/ylc3zdZ897g?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=460) [Load the viz (09:00)](https://youtu.be/ylc3zdZ897g?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=540) [Switching the view (13:18)](https://youtu.be/ylc3zdZ897g?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=798) [Applying a filter (15:28)](https://youtu.be/ylc3zdZ897g?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=928) [Selecting marks (19:05)](https://youtu.be/ylc3zdZ897g?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=1145) [More resources (21:10)](https://youtu.be/ylc3zdZ897g?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=1270) |
| [JS API: Tips and Tricks](https://youtu.be/0xXUYj4WCiU?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ) | 28:30 | Common 'gotchas', how to use asynchronous functions, creating event listeners Detailed Outline: [Learning objectives (01:05)](https://youtu.be/0xXUYj4WCiU?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=65) [Prerequisites (01:53)](https://youtu.be/0xXUYj4WCiU?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=113) [Getting started & set-up (02:41)](https://youtu.be/0xXUYj4WCiU?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=161) [Preview: final application (03:50)](https://youtu.be/0xXUYj4WCiU?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=230) [Understanding API versions (05:23)](https://youtu.be/0xXUYj4WCiU?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=323) [Tip: Publish sheets as tabs (06:57)](https://youtu.be/0xXUYj4WCiU?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=417) [Tip: Dashboards and ```javascript sheet.applyFilterAsync``` error (7:50)](https://youtu.be/0xXUYj4WCiU?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=470) [Tip: using async correctly (13:17)](https://youtu.be/0xXUYj4WCiU?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=797) [Event listeners (19:01)](https://youtu.be/0xXUYj4WCiU?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=1141) [Doing work as a viz loads (23:36)](https://youtu.be/0xXUYj4WCiU?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=1416) [More resources (26:21)](https://youtu.be/0xXUYj4WCiU?list=PL_qx68DwhYA8e_z9k7uoRw0zayoY35nUJ&t=1581) |

js-api-samples

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README