Tableau Embedding API
    Preparing search index...

    Enumeration TableauEventType

    Represents the type of tableau embedding event that can be listened for.

    Index

    Authoring

    WorkbookPublished: "workbookpublished"

    Raised when the workbook has been published. This notification is sent when using embedded web authoring functionality.

    WorkbookPublishedAs: "workbookpublishedas"

    Raised when "publish as" is successful. This notification is sent when using embedded web authoring functionality.

    WorkbookReadyToClose: "workbookreadytoclose"

    Raised when the workbook is ready to close. This notification is sent when using embedded web authoring functionality.

    Authoring, Viewing

    EditInDesktopButtonClicked: "editindesktopbuttonclicked"

    Raised when the user clicks on the Edit In Desktop Button.

    FirstVizSizeKnown: "firstvizsizeknown"

    Fired when viz size is known

    Authoring, Viewing, AskData

    IframeSrcUpdated: "iframesrcupdated"

    Raised after the iframe src attribute has been updated

    VizLoadError: "vizloaderror"

    Raised when an error occurs while loading the contents of the webcomponent.

    Authoring, Viewing, Pulse

    FirstInteractive: "firstinteractive"

    Fired when a viz first becomes interactive

    Pulse

    FirstPulseMetricSizeKnown: "firstpulsemetricsizeknown"

    Fired when the Pulse metric size is known

    PulseError: "pulseerror"

    Fired when an internal Pulse error is encountered.

    PulseFiltersChanged: "pulsefilterschanged"

    Fired when the Pulse filters change

    PulseInsightDiscovered: "pulseinsightdiscovered"

    Fired when a Pulse insight is discovered

    PulseMetricSizeChanged: "pulsemetricsizechanged"

    Fired when the Pulse metric size changes

    PulseTimeDimensionChanged: "pulsetimedimensionchanged"

    Fired when the Pulse metric time dimension changes

    PulseUrlChanged: "pulseurlchanged"

    Fired when the Pulse URL changes

    Viewing

    CustomMarkContextMenuEvent: "custommarkcontextmenu"

    Raised when a custom mark context menu is clicked.

    CustomViewLoaded: "customviewloaded"

    Raised when a custom view has finished loading. This event is raised after the callback function for FirstInteractive (if any) has been called.

    CustomViewRemoved: "customviewremoved"

    Raised when a custom view has been removed.

    CustomViewSaved: "customviewsaved"

    Raised when a custom view has been saved (newly created or updated).

    CustomViewSetDefault: "customviewsetdefault"

    Raised when a custom view has been set as the default view for a workbook.

    EditButtonClicked: "editbuttonclicked"

    Raised when the user clicks on the Edit Button.

    FilterChanged: "filterchanged"

    Raised when any filter has changed state. You can use this event type with TableauViz objects.

    MarkSelectionChanged: "markselectionchanged"

    The selected marks on a visualization have changed. You can use this event type with TableauViz objects.

    ParameterChanged: "parameterchanged"

    A parameter has had its value modified. You can use this event type with [[Parameter]] objects.

    StoryPointSwitched: "storypointswitched"

    Raised after a new story point becomes active.

    SummaryDataChanged: "summarydatachanged"

    Raised when changes are made to summary data.

    TabSwitched: "tabswitched"

    Raised after a tab switch occurs (the active sheet has changed). Guarantees the viz object will be interactive after this.

    ToolbarStateChanged: "toolbarstatechanged"

    Raised when a toolbar button or control becomes available or becomes unavailable.

    UrlAction: "urlaction"

    Raised when a URL action occurs. See the UrlActionEvent class.