为视图嵌入代码参数

适用于： Tableau Cloud, Tableau Public, Tableau Server

Tableau Server 2022.3 及更高版本以及 Tableau Cloud 的嵌入代码已更改为使用嵌入 API v3。有关嵌入 API v3 中的类和方法的最新列表，请参见嵌入 API 帮助中的嵌入 API 参考。本主题中的信息适用于嵌入的早期版本（使用 Tableau JavaScript API v1 和 v2）。

嵌入的早期版本的参数

您可以使用以下任一方法配置嵌入式视图：

JavaScript 标记的对象参数

对象参数值描述示例
dataDetailsno在工具栏中隐藏“数据详细信息”按钮，该按钮使用户可以查看有关该视图中使用的数据的详细信息。<param name='dataDetails' value='no' />
showDataDetailsyes如果启用了 Tableau Catalog，则显示打开了“数据详细信息”窗格的视图。<param name='showDataDetails' value='yes' />
alertsno隐藏工具栏中的“通知”按钮，该按钮使用户能创建数据驱动型通知。<param name='alerts' value='no'/>
customViewsno隐藏工具栏中的“视图”按钮，该按钮使用户能保存自定义视图。<param name='customViews' value='no'/>
devicedesktop; tablet; phone如果仪表板具有适用于移动设备的布局，则会显示一个特定布局，而不考虑屏幕大小。如果未设置此参数，则 Tableau Server 或 Tableau Cloud 会检测屏幕大小并加载对应的布局。有关示例，请参见嵌入仪表板。<param name='device' value='phone'/>
filter字符串筛选在视图打开时显示的数据。您也可以使用 URL 参数进行筛选。<param name='filter' value='Team=Blue'/>
host_url字符串必需。显示在 URL 中的服务器名称。<param name='host_url' value='http://myserver.exampleco.com/'>

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

linktarget字符串外部超链接的目标窗口名称。<param name="linktarget" value="_blank"/>
load-order数字当嵌入多个视图时，确定视图在页面上的加载顺序。允许使用负数。<param name="load-order" value="2"/>
mobileyes显示针对移动设备的触摸优化快速筛选器。<param name='mobile' value='yes'/>
name字符串所需的对象参数，具有此结构：[工作簿名称]/[工作表名称]/[可选自定义视图名称]

按如下方式设置可选自定义视图名称的格式：username@domain/[custom view name]

如果参考 Tableau Server 或 Tableau Cloud URL 来确认 name 的值，请不要包括 URL 末尾的会话 ID (:iid=<n>)。

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

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

:original_viewyes如果 name 参数引用工作簿或工作表 URL（并且未显式引用自定义视图），则包括此参数会将视图显示为原始视图。<param name='filter' value=':original_view=yes'/>
path

（仅限 Tableau Server。不适用于 Tableau Cloud。）

字符串仅适用于受信任的身份验证，不能与 ticket 参数一起使用。覆盖 name 参数的值并用作 URL。有关详细信息，请参见 Tableau Server 管理员帮助中的显示视图及票证(链接在新窗口中打开)。<param name='path' value='trusted/Etdpsm_Ew6rJY-9kRrALjauU/views/workbookQ4/SalesQ4'/>

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

showShareOptionstrue；false控制是否在嵌入视图中显示“共享”选项。<param name='showShareOptions' value='true' />
site_root字符串必需。站点名称。默认站点值为空 (value='')。如果服务器为多站点服务器，并且您希望使用受信任的身份验证，请参见 Tableau Server 帮助中的显示视图及票证(链接在新窗口中打开)。<param name='site_root' value='/#/Sales'/>

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

subscriptionsno隐藏工具栏中的“订阅”按钮，该按钮使用户能设置电子邮件订阅以定期接收视图的快照。

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

tabsyes; no显示或隐藏选项卡。<param name='tabs' value='yes'/>
ticket

（仅限 Tableau Server。不适用于 Tableau Cloud。）

字符串仅适用于受信任的身份验证，不能与 path 对象参数一起使用。必须与 name 对象一起使用以构造受信任的票证兑现 URL。有关详细信息，请参见 Tableau Server 帮助中的显示视图及票证(链接在新窗口中打开)。<param name='ticket' value='9D1ObyqDQmSIOyQpKdy4Sw==:dg62gCsSE0QRArXNTOp6mlJ5'/>

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

toolbaryes; no; top工具栏默认情况下显示在底部。当您将此参数设置为 top 时，工具栏放在视图上方，当您将其设置为 no 时，则会将工具栏从嵌入式视图中排除。<param name='toolbar' value='top'/>
tooltipyes; no如果将此参数设置为 no，则默认情况下显示工具提示，但是，将从嵌入式视图中排除工具提示。<param name='tooltip' value='no'/>

iframe 标记的 URL 参数

注意：在添加 URL 参数之前，请移除 URL 末尾的 :iid=[#]。这是当前浏览器会话的临时视图计数器。

URL 参数值描述示例
:dataDetailsno在工具栏中隐藏“数据详细信息”按钮，该按钮使用户可以查看有关该视图中使用的数据的详细信息。http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:dataDetails=no
:showDataDetailsyes如果启用了 Tableau Catalog，则显示打开了“数据详细信息”窗格的视图。http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:showDataDetails=yes
:alertsno隐藏嵌入视图中的“通知”按钮。http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:alerts=no
:customViewsno“记住我的更改”选项。http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:customViews=no
:devicedesktop; tablet; phone如果仪表板具有适用于移动设备的布局，则会显示一个特定布局，而不考虑屏幕大小。如果未设置此参数，则 Tableau Server 或 Tableau Cloud 会检测屏幕大小并加载对应的布局。有关示例，请参见嵌入仪表板。http://tabserver/views/sales/sales_dashboard?:device=tablet
:display_count

（仅限 Tableau Public）

yes单击左下方的 Tableau 徽标时显示总浏览量。https://public.tableau.com/en-us/s/gallery/what-emoji-say-about-music?:display_count=yes
:embedyes必需的 URL 参数。隐藏顶部导航区域，使视图更好地混合到网页中。http://tabserver/views/Date-Time/DateCalcs?:embed=yes
:formatpdf; png以 PDF 或 .png 文件显示视图。http://tabserver/views/Sales/Q2?:format=pdf
:highdpifalse在高分辨率显示屏和设备上使用标准 DPI（每英寸点数）呈现视图。http://tableauserver/views/Sales/Q2?:highdpi=false
:linktarget字符串外部超链接的目标窗口名称。http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:linktarget=_blank
:openid_hd字符串在使用 OpenID Connect 进行身份验证时使用。指定用户所属的托管域。举例来说，如果您不想呈现域选择窗格，则可以使用此选项。配合 :openid_login_hint 使用以指定完整的用户标识符。http://tabserver/views/Sales/Q2?:openid_hd=example.com
:openid_login_hint字符串在使用 OpenID Connect 进行身份验证时使用。指定完整的用户标识符（电子邮件地址）。配合 :openid_hd 使用以指定用户所属的托管域。http://tabserver/views/Sales/Q2?:openid_login_hint=tara@example.com
：record_performance

（仅限 Tableau Server。不适用于 Tableau Cloud。）

yes为视图启动性能记录。在紧靠会话 ID 之前的 URL 末尾添加此项 (:iid=<n>)。有关详细信息，请参见 Tableau Server 帮助中的创建性能记录(链接在新窗口中打开)。http://tabserver/views/Sales2013/Regions?:recordperformance=yes
:refreshyes使用 Tableau Server 或 Tableau Cloud 中的最新数据来呈现视图。有关详细信息，请参见刷新数据或暂停自动更新。

提示：若要不断刷新视图，请在网页的 <head> 部分中添加 <meta http-equiv="refresh" content="#">，其中 # 是刷新的间隔秒数。

http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:refresh=yes
:rendertrue; false; number如果客户端呈现已启用（默认设置），将此项设置为 false 将会对该会话强制实现服务器端呈现。将此参数设置为 true为会话强制实施客户端渲染。

可以输入从 1 到 100 的数字来设置复杂性阈值，超过该阈值时，服务器将会呈现视图。有关详细信息，请参见 Tableau Server 帮助中的关于客户端呈现(链接在新窗口中打开)。

http://tabserver/views/Date-Time/DateCalcs?:render=false
:revertall; filters; sorts; axes; shelves使该项返回到其原始状态。http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:revert=all
:showAppBannerfalse在移动 Web 浏览器中隐藏“在 Tableau Mobile 中打开”横幅。http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:showAppBanner=false
:showAskDatafalse在嵌入视图中的工具栏中隐藏“数据问答”(Ask Data) 功能按钮。默认情况下，将显示“数据问答”(Ask Data) 功能按钮。http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:showAskData=false
:showShareOptionstrue；false控制是否在嵌入视图中显示“共享”选项。http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:showShareOptions=true
:showVizHome

（仅限 Tableau Public）

yes; no显示或隐藏 Tableau Public 的内容导航界面。在其他网页中嵌入可视化项时设置为 no。https://public.tableau.com/en-us/s/gallery/what-emoji-say-about-music?:showVizHome=no
:subscriptionsno隐藏嵌入视图中的“订阅”按钮。http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:subscriptions=no
:tabsyes; no显示或隐藏选项卡。http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:tabs=no
:toolbaryes; no; top如果未设置此参数，默认情况下显示工具栏。当选择 no 时，工具栏将从嵌入视图中排除。当选择 top 时，工具栏将置于视图之上。http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:toolbar=no
:tooltipyes; no如果未设置此参数，默认情况下视图中将显示工具提示。如果设置为 no，则会从嵌入视图中排除工具提示。http://tabserver/views/workbookQ4/SalesQ4?:embed=yes&:tooltip=no
回到顶部
感谢您的反馈!您的反馈已成功提交。谢谢!