Supported objects and events
trexwrapper
enables the user to listen and respond to events on objects in a Tableau dashboard using event handlers.
Objects are the pieces of the Tableau dashboard that a user interacts with. The following objects are supported:
Dashboard (
Dashboard
)Worksheet (
Worksheet
)Filter (
Filter
)Parameter (
Parameter
)Datasource (
Datasource
)
Events are triggered when a user interacts with objects on the dashboard. The following events are supported:
Changing a filter (
FilterChangedEvent
)Changing a parameter (
ParameterChangedEvent
)Selecting marks (
MarksSelectedEvent
)
Event handlers are the functions and methods that respond to the events above. These functions can do anything you want them to! For example:
1from trexjacket.api import get_dashboard
2dashboard = get_dashboard().register_event_handler('selection_changed', notify_selection)
3
4def notify_selection(event):
5 print(f'Someone selected these marks: {event.get_selected_marks()}')