• Public
  • Public/Protected
  • All

Embedding API

Tableau Embedding API

This is preliminary documentation and is subject to change

The Tableau Embedding API is a JavaScript library and is organized into the classes and methods for embedding Tableau visualizations into your own web applications.

Note The Embedding API library is located on the server (including Tableau Online and Tableau Public). There is no separate download. To use the Embedding API, you just specify the URL to the JavaScript library (tableau-3.min.js) in your web page. For example, to load the Embedding API from a Tableau server called example.com, you would add this line to your web page:

<script src="https://example.com/javascripts/api/tableau-3.min.js"></script>

Tip To see all the methods and properties for the Embedding API interfaces, select the Inherited option in the upper-right corner of your browser window. This option shows any methods and properties inherited from base classes.

Style and Conventions

The Embedding API follows these JavaScript standards for formatting names:

  • Classes use UpperCamelCase (initial capital letter, with each subsequent word capitalized).

  • Namespaces, methods, parameters, and variables use lowerCamelCase (initial lower-case letter, with each subsequent word capitalized).

  • Constants and enum values use UPPERCASE; multi-word names use UPPERCASE_UNDERSCORE_DELIMITED.

  • Protected variables or method start with an initial underscore (_) character, indicating that it should not be referenced by the programmer.