Skip to content

Latest commit

 

History

History
67 lines (42 loc) · 1.75 KB

index.rst

File metadata and controls

67 lines (42 loc) · 1.75 KB
Raw

API Reference

This reference documentation is divided into 3 major sections:

  1. Connecting to the dashboard

How to initially connect to the Tableau dashboard

  1. Tableau objects

Classes that represent things you can see on the dashboard (filters, parameters, marks, etc.)

  1. Change event classes

Classes that represent change events on the dashboard (mark selection, filter change, parameter change, etc.)

Connecting to the dashboard

api.get_dashboard is the recommended way to connect to the Tableau Dashboard.

client_code.api

Tableau objects

These are the things you can see on the dashboard (filters, parameters, worksheets, etc.).

client_code.model.proxies

Change event classes

You will encounter these classes when registering event handlers. For example, when registering the 'filter_changed' event:

# in some form code
def __init__(self):
   # setup code omitted
   self.dashboard.register_event_handler('filter_changed', self.my_event_handler)

def my_event_handler(self, event):
   filter = event.filter

event in this case will be an instance of the ~client_code.model.proxies.FilterChangedEvent class.

client_code.model.proxies

Displaying Dialogues

client_code.dialogs

Technical Reference

client_code.model.proxies