Was this page helpful?
Yes No

Parameters for Embed Code

You can configure an embedded view using either of these methods:

Object parameters for JavaScript tags

Object Parameter Values Description Examples
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 Online 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/'>

<param name="host_url" value="http://localhost/">

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"/>
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]

If you refer to the Tableau Server or Tableau Online URL to confirm the value of name, exclude the session ID (:iid=<n>) at the end of the URL.

<param name='name' value='ExampleCoSales/Sales'/>

<param name='name' value="ExampleCoSales/Sales/jsmith@example.com/EastRegionSales'/>

: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 Online.)

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 in the Tableau Server Administrator help. <param name='path' value='trusted/Etdpsm_Ew6rJY-9kRrALjauU/views/workbookQ4/SalesQ4'/>

http://tableauserver/trusted/Etdpsm_Ew6rJY-9kRrALjauU/views/workbookQ4/SalesQ4?:embed=yes&:tabs=yes

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 in the Tableau Server help. <param name='site_root' value='/#/Sales'/>

<param name='site_root' value=''/>

subscriptions no Hides the Subscriptions button in the toolbar, which lets users set up email subscriptions to receive snapshots of views at regular intervals.

<param name='subscriptions' value='no'/>

tabs yes; no Displays or hides tabs. <param name='tabs' value='yes'/>
ticket

(Tableau Server only. Not applicable to Tableau Online.)

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 in the Tableau Server help. <param name='ticket' value='9D1ObyqDQmSIOyQpKdy4Sw==:dg62gCsSE0QRArXNTOp6mlJ5'/>

http://tableauserver/trusted/9D1ObyqDQmSIOyQpKdy4Sw==:dg62gCsSE0QRArXNTOp6mlJ5/views/workbookQ4/SalesQ4?:embed=yes&:tabs=yes

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
: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 Online 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 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 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
:record_performance

(Tableau Server only. Not applicable to Tableau Online.)

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 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 Online. See Refresh Data or Pause Automatic Updates for details.

Tip: To continually refresh a view, in the <head> section of the web page, add <meta http-equiv="refresh" content="#">, where # is the number of seconds between refreshes.

http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:refresh=yes
:render

(Tableau Server only. Not applicable to Tableau Online.)

true; false; number If client-side rendering is enabled (the default), setting this to false forces server-side rendering for the session. If client-side rendering is disabled, setting this to true enables it 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 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
: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
:showAppBanner false Hides the “Open in Tableau Mobile” banner in mobile web browsers. http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:showAppBanner=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
: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