trexjacket, a Pythonic wrapper for the Tableau Extensions API

Welcome to the online documentation for trexjacket, an open source Python wrapper for the Tableau Extensions API.

New here?

Consider viewing the Getting Started document.

Want to start building?

Head to the Building a Chat Extension tutorial.

Here to dive into the details?

Head to the API Reference section.

Installation

To get started using trexjacket :

  1. (If using Anvil X) Add the following third party dependency token: 4WJSBYGUAK63RAJO.

  2. Import it like this:

from trexjacket.api import get_dashboard
  1. Start building!

1from trexjacket.api import get_dashboard
2
3dashboard = get_dashboard()
4dashboard.get_worksheet('Sale Map').register_event_handler('selection_change', handle_selection)
5
6def handle_selection(event):
7    """ This function executes when a user clicks a mark on a dashboard """
8    print(f'A user chose these marks: {event.get_selected_marks()}')

Outline

Indices and tables