Embed Code Parameters for Views
The embed code for Tableau Server 2022.3 and later and Tableau Cloud has changed to use the Embedding API v3. For a current list of classes and methods in the Embedding API v3, see the Embedding API Reference in the Embedding API help. The information in this topic is for prior versions of embedding (using the Tableau JavaScript API v1 and v2).
Parameters for prior versions of embedding
You can configure an embedded view using either of these methods:
Object parameters for JavaScript tags
| Object Parameter | Values | Description | Examples |
|---|---|---|---|
dataDetails | no | Hides the Data Details button in the toolbar, which lets users see details about the data used in that view. | <param name='dataDetails' value='no' /> |
showDataDetails | yes | If Tableau Catalogue is enabled, it shows the view with the Data Details pane open. | <param name='showDataDetails' value='yes' /> |
alerts | no | Hides the Alerts button in the toolbar, which lets users create data-driven alerts. | <param name='alerts' value='no'/> |
customViews | no | Hides the View button in the toolbar, which lets users save custom views. | <param name='customViews' value='no'/> |
device | desktop; tablet; phone | If a dashboard has layouts for mobile devices, displays a specific layout, regardless of screen size. If this parameter isn't set, Tableau Server or Tableau Cloud detects screen size and loads a corresponding layout. See Embed Dashboards for examples. | <param name='device' value='phone'/> |
filter | string | Filters the data displayed when the view opens. You can also filter using URL parameters. | <param name='filter' value='Team=Blue'/> |
host_url | string | Required. The server name as it appears in the URL. | <param name='host_url' value='http://myserver.exampleco.com/'>
|
linktarget | string | The target window name for external hyperlinks. | <param name="linktarget" value="_blank"/> |
load-order | number | When multiple views are embedded, determines the order in which they load on the page. Negative numbers are allowed. | <param name="load-order" value="2"/> |
mobile | yes | Displays touch-optimised quick filters for mobile devices. | <param
name='mobile' value='yes'/> |
name | string | Required object parameter, with this structure: [workbook name]/[sheet name]/[optional custom view name] Format optional custom view names like this: username@domain/[custom view name] | <param name='name' value='ExampleCoSales/Sales'/>
|
:original_view | yes | If the name parameter refers to a workbook or sheet URL (and does not explicitly refer to a custom view) including this parameter displays the view as the original view. | <param name='filter' value=':original_view=yes'/> |
path(Tableau Server only. Not applicable to Tableau Cloud.) | string | For trusted authentication only, cannot be used with the ticket parameter. Overrides value of the name parameter and is used as the URL. For more information, see Display the View with the Ticket(Link opens in a new window) in the Tableau Server Administrator help. | <param name='path' value='trusted/Etdpsm_Ew6rJY-9kRrALjauU/views/workbookQ4/SalesQ4'/>
|
showShareOptions | true; false | Controls whether the Share options are displayed in an embedded view. | <param name='showShareOptions' value='true' /> |
site_root | string | Required. The site name. The Default site value is null (value=''). If your server is multi-site and you want to use trusted authentication, see Display the View with the Ticket(Link opens in a new window) in the Tableau Server help. | <param name='site_root' value='/#/Sales'/>
|
subscriptions | no | Hides the Subscriptions button in the toolbar, which lets users set up email subscriptions to receive snapshots of views at regular intervals. |
|
tabs | yes; no | Displays or hides tabs. | <param name='tabs' value='yes'/> |
ticket(Tableau Server only. Not applicable to Tableau Cloud.) | string | For trusted authentication only, cannot be used with the path object parameter. Must be used with name object to construct the trusted ticket redemption URL. For more information, see Display the View with the Ticket(Link opens in a new window) in the Tableau Server help. | <param name='ticket' value='9D1ObyqDQmSIOyQpKdy4Sw==:dg62gCsSE0QRArXNTOp6mlJ5'/>
|
toolbar | yes; no; top | The toolbar is displayed on the bottom by default. The toolbar is placed above the view when you set this parameter to topand excluded from the embedded view when you set it to no. | <param name='toolbar' value='top'/> |
tooltip | yes; no | Tooltips are displayed by default If you set this parameter to no, however, tooltips are excluded from the embedded view. | <param name='tooltip' value='no'/> |
URL parameters for iframe tags
Note: Before you add URL parameters, remove :iid=[#] at the end of the URL. This is a temporary view counter for your current browser session.
| URL Parameter | Values | Description | Examples |
|---|---|---|---|
:dataDetails | no | Hides the Data Details button in the toolbar, which lets users see details about the data used in that view. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:dataDetails=no |
:showDataDetails | yes | If Tableau Catalogue is enabled, it shows the view with the Data Details pane open. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:showDataDetails=yes |
:alerts | no | Hides the Alerts button in an embedded view. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:alerts=no |
:customViews | no | Remember my changes option. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:customViews=no |
:device | desktop; tablet; phone | If a dashboard has layouts for mobile devices, displays a specific layout, regardless of screen size. If this parameter isn't set, Tableau Server or Tableau Cloud detects screen size and loads a corresponding layout. See Embed Dashboards for examples. | http://tabserver/views/sales/sales_dashboard?:device=tablet |
:display_count(Tableau Public only) | yes | Shows the total number of pageviews when you click the Tableau logo at the lower left. | https://public.tableau.com/en-us/s/gallery/what-emoji-say-about-music?:display_count=yes |
:embed | yes | Required URL parameter. Hides the top navigation area, better blending of the view into your web page. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes |
:format | pdf; png | Displays a view as a PDF or .png file. | http://tabserver/views/Sales/Q2?:format=pdf |
:highdpi | false | Renders a view using standard DPI (dots per inch) for high-resolution displays and devices. | http://tableauserver/views/Sales/Q2?:highdpi=false |
:linktarget | string | The target window name for external hyperlinks. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:linktarget=_blank |
:openid_hd | string | Used when authenticating with OpenID Connect. Specifies the hosted domain to which a user belongs. For example, you might use this option if you do not want to render the domain selection pane. Used in conjunction with :openid_login_hint to specify the full user identifier. | http://tabserver/views/Sales/Q2?:openid_hd=example.com |
:openid_login_hint | string | Used when authenticating with OpenID Connect. Specifies the full user identifier (email address). Used in conjunction with :openid_hd to specify the hosted domain to which the user belongs. | http://tabserver/views/Sales/Q2?:openid_login_hint=tara@example.com |
:record_performance(Tableau Server only. Not applicable to Tableau Cloud.) | yes | Starts a performance recording for a view. Add this at the end of the URL, immediately before the session ID (:iid=<n>). For more information, see Create a Performance Recording(Link opens in a new window) in Tableau Server help. | http://tabserver/views/Sales2013/Regions?:recordperformance=yes |
:refresh | yes | Renders the view using the latest data from Tableau Server or Tableau Cloud. Tip: To continually refresh a view, in the | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:refresh=yes |
:render | true; false; number | If client-side rendering is enabled (the default), setting this to false forces server-side rendering for the session. Setting this to true forces client-side rendering for the session.A number from 1 to 100 can be entered to set the complexity threshold above which views are rendered by the server. For more information, see About Client-Side Rendering(Link opens in a new window) in Tableau Server help. | http://tabserver/views/Date-Time/DateCalcs?:render=false |
:revert | all; filters; sorts; axes; shelves | Returns the item to its original state. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:revert=all |
:showAppBanner | false | Hides the “Open in Tableau Mobile” banner in mobile web browsers. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:showAppBanner=false |
:showAskData | false | Hides the Ask Data button in the toolbar in an embedded view. By default the Ask Data button displays. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:showAskData=false |
:showShareOptions | true; false | Controls whether the Share options are displayed in an embedded view. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:showShareOptions=true |
:showVizHome(Tableau Public only) | yes; no | Shows or hides the content navigation interface of Tableau Public. Set to no when embedding vizzes in other web pages. | https://public.tableau.com/en-us/s/gallery/what-emoji-say-about-music?:showVizHome=no |
:subscriptions | no | Hides the Subscribe button in an embedded view. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:subscriptions=no |
:tabs | yes; no | Displays or hides tabs. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:tabs=no |
:toolbar | yes; no; top | The toolbar is displayed by default on the bottom when this parameter is not set. When no the toolbar is excluded from the embedded view. When top, the toolbar is placed above the view. | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:toolbar=no |
:tooltip | yes; no | Tooltips are displayed by default in a view when this parameter is not set. If set to no, tooltips are excluded from the embedded view. | http://tabserver/views/workbookQ4/SalesQ4?:embed=yes&:tooltip=no |