Known Issues for the Embedding API v3


The following section describes some issues in the current release of the Tableau Embedding API v3 where the API or the platform does not behave as expected.

For information about what is new or has changed in each release, see the Release Notes for the Tableau Embedding API v3.

Worksheet in a story throws an error

  • A worksheet inside a story throws an error (operation not allowed on non-active sheet). On a workbook, calling activateSheetAsync() when switching tabs from a worksheet or dashboard to a story results in an error.

viz-filter doesn’t handle “All” correctly

  • The <viz-filter> child element of the <tableau-viz> web component does not handle the implicit “(All)” value correctly. In the Tableau user interface, the “(All)” value in a quick filter means show all values.

    If you embed a view that already has a filter applied, and you specify an empty string as the value (value = ""), which means “show all” or that no filter should be applied, the setting is ignored. The original filter value is still shown.

     <!-- Applies the filter value "2014" -->
 <tableau-viz 
    src="https://public.tableau.com/views/RegionalSampleWorkbook/College">
    <viz-filter field="Academic Year" value="2014"/> 
 </tableau-viz>

 <!-- Should show "(All)" values, but is ignored -->
 <tableau-viz 
    src="https://public.tableau.com/views/RegionalSampleWorkbook/College" >
    <viz-filter field="Academic Year" value=""/> 
 </tableau-viz>

Embedding an empty workbook without a data source crashes

  • If you use a URL to open an empty workbook without a data source and you are using a connected app for authentication, the session crashes and the connection is broken. See Embed New Empty Workbook on Tableau.

    Workaround:

    • Specify a data source in the URL

    • Don’t use a connected app for authentication. Use sign on instead.

Embedded data source without a password

If the view connects to an embedded data source (the data source is embedded into the workbook), the data source must contain the embedded credentials to access the data. In this scenario there is no way to prompt a user for the proper credentials and the view fails to load.


On This Page