Was this page helpful?
Yes No
User Guide > Embed Views and Dashboards > Parameters for Embed Code

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
customViews no Hides the Remember my changes option. <param name='customViews' value='no'/>
device desktop; tablet; phone If a dashboard has layouts for mobile devices, it displays a specific layout, regardless of the device type. If this parameter isn't set, Tableau Server detects screen size and loads the appropriate layout. See Embed Dashboards for examples. <param name='device' value='phone'/>
filter string Customizes what data is displayed when the view opens. You can also filter by 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, the default load order is the order in which the views are listed. Use this setting to override that order. 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]

Format optional custom view names like this: username@domain/[custom view name]

If you refer to the Tableau Server 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 string For trusted authentication only, cannot be used with the ticket parameter. Overrides value of the name parameter and is used as the URL. 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 the display of the Share menu in an embedded view. The default is true, displaying the Share menu. Removing this parameter has the same effect as setting showShareOptions to false. <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=''/>

tabs yes; no Displays or hides tabs. <param name='tabs' value='yes'/>
ticket 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. 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

URL Parameter Values Description Examples
:customViews no Hides the 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, it displays a specific layout, regardless of the device type. If this parameter isn't set, Tableau Server detects screen size and loads the appropriate layout. See Embed Dashboards for examples. http://tabserver/views/sales/sales_dashboard?:device=tablet
:embed yes Required URL parameter. Hides the top navigation area, better blending the view blend 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 yes Starts a performance recording for a view. Add this at the end of the URL, immediately before the session ID (:iid=<n>). See Create a Performance Recording in the Tableau Server help. http://tabserver/views/Sales2013/Regions?:recordperformance=yes
:refresh yes This URL parameter renders the view using the latest data, rather than a cache from Tableau Server. 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 true; false; number If client-side rendering is enabled (which is 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 can be used to test a complexity threshold. See About Client-Side Rendering in the 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
: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