Use Cases for Tableau Next Embedding

These use cases show end-to-end examples of functionality for your embedding code.

For embedded components, perform interactive operations only after the component has rendered. Alternatively, you can use the COMPONENT_LOADED event, performing operations within its callback.

This example shows how to get the list of filters for a dashboard when the dashboard component loads.

This example shows how to listen for the UPDATED_FILTERS event and apply the updated filter to the dashboard.

This example shows how to get the list the pages for a dashboard and then render that dashboard page.

Use the customViewId to embed a dashboard with a saved interactive state, such as pre-applied filters or context from a shared dashboard page. You can embed custom views when:

• You want users to view a dashboard in a specific saved state.
• You are embedding dashboard URLs that contain the customViewId query parameter.
• You required consistent interactivity context across sessions or channels.

This example shows the AnalyticsDashboard component with the customViewId.

The customViewId is part of the dashboard URL when a custom view is rendered. In this example, the customViewId is cview_abc123.

If the customViewId is omitted, the dashboard renders to the default page and view.

If the customViewId is invalid or not accessible, the dashboard renders to the default page and view.