Without having to parse the error string. This allows you to uniquely identify the error

Shortcut for then(null, errback).Ĭlass is not a real class, but simply adds an id field to the standard JavaScriptĮrror object when an exception is thrown from Registers a callback that will be called when a promise is resolved or rejected. The errback function is called when there is an error. The callback function is called on success.

Then(callback: Function, errback: Function)Ĭreates a link in the asynchronous callable chain. The Tableau JavaScript API implements the Promises/A (Link opens in a new window) specification. Represents a promise to return a value from an asynchronous method in the future. The exception of VizManager, because that's a static class and always accessible.Īsynchronous and Error Classes Promise Class Note that there's always a way to traverse back up the containment hierarchy with parent pointers. The following class diagram shows the relationships between the top-level classes, as well as the inheritance hierarchy for the Sheet, Dashboard, Story and Worksheet classes. Tableau does provide support for potential bugs in the Tableau JavaScript API code itself, and for unmodified sample code that isn't working. For help with your code, submit questions and ask for help on the Tableau developer community forums. Tableau does not provide support for programs that customers create that use the Tableau JavaScript API. Protected variables or method start with an initial underscore ( _ ) character, indicating that it should not be referenced by the programmer. Namespaces, methods, parameters, and variables use camelCase (initial lower-case letter, with each subsequent word capitalized).Ĭonstants and enum values use UPPERCASE multi-word names use UPPERCASE_UNDERSCORE_DELIMITED. Tableau's JavaScript API follows these JavaScript standards for formatting names:Ĭlasses use PascalCase (initial capital letter, with each subsequent word capitalized). For more information, see Access the API. To use the JavaScript API, you just specify the URL to the JavaScript API file in your web page. The JavaScript API files are located on the server (including Tableau Cloud and Tableau Public).

This section describes classes and methods of the Tableau JavaScript API.

Javascript download event