---
schema_version: "1"
id: caae6247dbb81d34e6e7800e3d70e377a5de1be026e135a15b21ef954d31a6a7
title: 为视图嵌入代码参数
collection: tableau
version: next
locale: zh-cn
portal_url: https://docs.salesforce.com/tableau/next/zh-cn/pro/desktop/embed_list.md
canonical_url: https://help.tableau.com/v0.0/pro/desktop/zh-cn/embed_list.htm
source_site: help.tableau.com
content_type: documentation
content_hash: 10aa70762c300eb229da19e5c09f5497cf7b82c51ebd16b0e66e2ed0af1f0639
description: Tableau Server 2022
---
[跳转到主要内容](#main-content)

# 为视图嵌入代码参数

> [!TIP]
> 
> Tableau Server 2022.3 及更高版本以及 Tableau Cloud 的嵌入代码已更改为使用嵌入 API v3。有关嵌入 API v3 中的类和方法的最新列表，请参见[嵌入 API 帮助](https://help.tableau.com/current/api/embedding_api/zh-cn/index.html)中的[嵌入 API 参考](https://help.tableau.com/current/api/embedding_api/zh-cn/reference/index.html)。本主题中的信息适用于嵌入的早期版本（使用 Tableau JavaScript API v1 和 v2）。

嵌入的早期版本的参数

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

- [JavaScript 标记的对象参数](#Object_params)
- [iframe 标记的 URL 参数](#URL_params)

## JavaScript 标记的对象参数

<table class="table--plain"><thead><tr class="TableStyle-Basic-Border-Head-Header1"><th>对象参数</th><th>值</th><th>描述</th><th>示例</th></tr></thead><tbody><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>dataDetails</code></td><td><code>no</code></td><td>在工具栏中隐藏“数据详细信息”按钮，该按钮使用户可以查看有关该视图中使用的数据的详细信息。</td><td><code>&lt;param name='dataDetails' value='no' /&gt;</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>showDataDetails</code></td><td><code>yes</code></td><td>如果启用了 Tableau Catalog，则显示打开了“数据详细信息”窗格的视图。</td><td><code>&lt;param name='showDataDetails' value='yes' /&gt;</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>alerts</code></td><td><code>no</code></td><td>隐藏工具栏中的“通知”按钮，该按钮使用户能创建数据驱动型通知。</td><td><code>&lt;param name='alerts' value='no'/&gt;</code><br></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>customViews</code></td><td><code>no</code></td><td>隐藏工具栏中的“视图”按钮，该按钮使用户能保存自定义视图。</td><td><code>&lt;param name='customViews' value='no'/&gt;</code><br></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>device</code></td><td><code>desktop; tablet; phone</code></td><td>如果仪表板具有适用于移动设备的布局，则会显示一个特定布局，而不考虑屏幕大小。如果未设置此参数，则 Tableau Server 或 Tableau Cloud 会检测屏幕大小并加载对应的布局。有关示例，请参见<a href="https://help.tableau.com/v0.0/pro/desktop/zh-cn/embed_dashboard.htm" class="xref">嵌入仪表板</a>。</td><td><code>&lt;param name='device' value='phone'/&gt;</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>filter</code></td><td>字符串</td><td>筛选在视图打开时显示的数据。您也可以使用 URL 参数进行筛选。</td><td><code>&lt;param name='filter' value='Team=Blue'/&gt;</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>host_url</code></td><td>字符串</td><td>必需。显示在 URL 中的服务器名称。</td><td><code>&lt;param name='host_url' value='http://myserver.exampleco.com/'&gt;</code><p><code>&lt;param name="host_url" value="http://localhost/"&gt;</code></p></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>linktarget</code></td><td>字符串</td><td>外部超链接的目标窗口名称。</td><td><code>&lt;param name="linktarget" value="_blank"/&gt;</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>load-order</code></td><td>数字</td><td>当嵌入多个视图时，确定视图在页面上的加载顺序。允许使用负数。</td><td><code>&lt;param name="load-order" value="2"/&gt;</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>mobile</code></td><td><code>yes</code></td><td>显示针对移动设备的触摸优化快速筛选器。</td><td><code>&lt;param
						name='mobile' value='yes'/&gt;</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>name</code></td><td>字符串</td><td>所需的对象参数，具有此结构：[工作簿名称]/[工作表名称]/[可选自定义视图名称]<p> 按如下方式设置可选自定义视图名称的格式：username@domain/[custom view name]<br><br>如果参考 Tableau Server 或 Tableau Cloud URL 来确认 <code>name</code> 的值，请不要包括 URL 末尾的会话 ID (<code>:iid=<i>&lt;n&gt;</i></code>)。</p></td><td><code>&lt;param name='name' value='ExampleCoSales/Sales'/&gt;</code><p><code>&lt;param
name='name' value='ExampleCoSales/Sales/jsmith@example.com/EastRegionSales'/&gt;</code></p></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:original_view</code></td><td><code>yes</code></td><td>如果 <code>name</code> 参数引用工作簿或工作表 URL（并且未显式引用自定义视图），则包括此参数会将视图显示为原始视图。</td><td><code>&lt;param name='filter' value=':original_view=yes'/&gt;</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>path</code><p>（仅限 Tableau Server。不适用于 Tableau Cloud。）</p></td><td>字符串</td><td>仅适用于受信任的身份验证，不能与 <code>ticket</code> 参数一起使用。覆盖 <code>name</code> 参数的值并用作 URL。有关详细信息，请参见 Tableau Server 管理员帮助中的<a href="https://help.tableau.com/current/server/zh-cn/trusted_auth_webURL.htm" target="_blank">显示视图及票证</a>。</td><td><code>&lt;param name='path' value='trusted/Etdpsm_Ew6rJY-9kRrALjauU/views/workbookQ4/SalesQ4'/&gt;</code><p><code>http://tableauserver/trusted/Etdpsm_Ew6rJY-9kRrALjauU/views/workbookQ4/SalesQ4?:embed=yes&amp;:tabs=yes</code></p></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>showShareOptions</code></td><td><code>true</code>；<code>false</code></td><td>控制是否在嵌入视图中显示“共享”选项。</td><td><code>&lt;param name='showShareOptions' value='true' /&gt;</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>site_root</code></td><td>字符串</td><td>必需。站点名称。默认站点值为空 (<code>value=''</code>)。如果服务器为多站点服务器，并且您希望使用受信任的身份验证，请参见 Tableau Server 帮助中的<a href="https://help.tableau.com/current/server/zh-cn/trusted_auth_webURL.htm" target="_blank">显示视图及票证</a>。</td><td><code>&lt;param name='site_root' value='/#/Sales'/&gt;</code><p><code>&lt;param name='site_root' value=''/&gt;</code></p></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>subscriptions</code></td><td><code>no</code></td><td>隐藏工具栏中的“订阅”按钮，该按钮使用户能设置电子邮件订阅以定期接收视图的快照。</td><td><p><code>&lt;param name='subscriptions' value='no'/&gt;</code></p></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>tabs</code></td><td><code>yes; no</code></td><td>显示或隐藏选项卡。</td><td><code>&lt;param name='tabs' value='yes'/&gt;</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>ticket</code><p>（仅限 Tableau Server。不适用于 Tableau Cloud。）</p></td><td>字符串</td><td>仅适用于受信任的身份验证，不能与 <code>path</code> 对象参数一起使用。必须与 <code>name</code> 对象一起使用以构造受信任的票证兑现 URL。有关详细信息，请参见 Tableau Server 帮助中的<a href="https://help.tableau.com/current/server/zh-cn/trusted_auth_webURL.htm" target="_blank">显示视图及票证</a>。</td><td><code>&lt;param name='ticket' value='9D1ObyqDQmSIOyQpKdy4Sw==:dg62gCsSE0QRArXNTOp6mlJ5'/&gt;</code><p><code>http://tableauserver/trusted/9D1ObyqDQmSIOyQpKdy4Sw==:dg62gCsSE0QRArXNTOp6mlJ5/views/workbookQ4/SalesQ4?:embed=yes&amp;:tabs=yes</code></p></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>toolbar</code></td><td><code>yes; no; top</code></td><td>工具栏默认情况下显示在底部。当您将此参数设置为 <code>top</code> 时，工具栏放在视图上方，当您将其设置为 <code>no</code> 时，则会将工具栏从嵌入式视图中排除。</td><td><code>&lt;param name='toolbar' value='top'/&gt;</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>tooltip</code></td><td><code>yes; no</code></td><td>如果将此参数设置为 <code>no</code>，则默认情况下显示工具提示，但是，将从嵌入式视图中排除工具提示。</td><td><code>&lt;param name='tooltip' value='no'/&gt;</code></td></tr></tbody></table>

## iframe 标记的 URL 参数

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

<table class="table--plain"><colgroup><col><col style="width: 101px;"><col><col></colgroup><thead><tr class="TableStyle-Basic-Border-Head-Header1"><th>URL 参数</th><th>值</th><th>描述</th><th>示例</th></tr></thead><tbody><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:dataDetails</code></td><td><code>no</code></td><td>在工具栏中隐藏“数据详细信息”按钮，该按钮使用户可以查看有关该视图中使用的数据的详细信息。</td><td><code>http://tabserver/views/Date-Time/DateCalcs?:embed=yes&amp;:dataDetails=no</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:showDataDetails</code></td><td><code>yes</code></td><td>如果启用了 Tableau Catalog，则显示打开了“数据详细信息”窗格的视图。</td><td><code>http://tabserver/views/Date-Time/DateCalcs?:embed=yes&amp;:showDataDetails=yes</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:alerts</code></td><td><code>no</code></td><td>隐藏嵌入视图中的“通知”按钮。</td><td><code>http://tabserver/views/Date-Time/DateCalcs?:embed=yes&amp;:alerts=no</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:customViews</code></td><td><code>no</code></td><td><span class="uicontrol">“记住我的更改”</span>选项。</td><td><code>http://tabserver/views/Date-Time/DateCalcs?:embed=yes&amp;:customViews=no</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:device</code></td><td><code>desktop; tablet; phone</code></td><td>如果仪表板具有适用于移动设备的布局，则会显示一个特定布局，而不考虑屏幕大小。如果未设置此参数，则 Tableau Server 或 Tableau Cloud 会检测屏幕大小并加载对应的布局。有关示例，请参见<a href="https://help.tableau.com/v0.0/pro/desktop/zh-cn/embed_dashboard.htm" class="xref">嵌入仪表板</a>。</td><td><code>http://tabserver/views/sales/sales_dashboard?:device=tablet</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:display_count</code><p>（仅限 Tableau Public）</p></td><td><code>yes</code></td><td>单击左下方的 Tableau 徽标时显示总浏览量。</td><td><code>https://public.tableau.com/en-us/s/gallery/what-emoji-say-about-music?:display_count=yes</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:embed</code></td><td><code>yes</code></td><td>必需的 URL 参数。隐藏顶部导航区域，使视图更好地混合到网页中。</td><td><code>http://tabserver/views/Date-Time/DateCalcs?:embed=yes</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:format</code></td><td><code>pdf; png</code></td><td>以 PDF 或 .png 文件显示视图。</td><td><code>http://tabserver/views/Sales/Q2?:format=pdf</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:highdpi</code></td><td><code>false</code></td><td>在高分辨率显示屏和设备上使用标准 DPI（每英寸点数）呈现视图。</td><td><code>http://tableauserver/views/Sales/Q2?:highdpi=false</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:linktarget</code></td><td>字符串</td><td>外部超链接的目标窗口名称。</td><td><code>http://tabserver/views/Date-Time/DateCalcs?:embed=yes&amp;:linktarget=_blank</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:openid_hd</code></td><td>字符串</td><td>在使用 OpenID Connect 进行身份验证时使用。指定用户所属的托管域。举例来说，如果您不想呈现域选择窗格，则可以使用此选项。配合 <code>:openid_login_hint</code> 使用以指定完整的用户标识符。</td><td><code>http://tabserver/views/Sales/Q2?:openid_hd=example.com</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:openid_login_hint</code></td><td>字符串</td><td>在使用 OpenID Connect 进行身份验证时使用。指定完整的用户标识符（电子邮件地址）。配合 <code>:openid_hd</code> 使用以指定用户所属的托管域。</td><td><code>http://tabserver/views/Sales/Q2?:openid_login_hint=tara@example.com</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td>：<code>record_performance</code><p>（仅限 Tableau Server。不适用于 Tableau Cloud。）</p></td><td><code>yes</code></td><td>为视图启动性能记录。在紧靠会话 ID 之前的 URL 末尾添加此项 (<code>:iid=<i>&lt;n&gt;</i></code>)。有关详细信息，请参见 Tableau Server 帮助中的<a href="https://help.tableau.com/current/server/zh-cn/perf_record_create_server.htm" target="_blank">创建性能记录</a>。</td><td><code>http://tabserver/views/Sales2013/Regions?:recordperformance=yes</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><a name="refresh_param"></a><code>:refresh</code></td><td><code>yes</code></td><td>使用 Tableau Server 或 Tableau Cloud 中的最新数据来呈现视图。有关详细信息，请参见<a href="https://help.tableau.com/v0.0/pro/desktop/zh-cn/refresh.htm" class="xref">刷新数据或暂停自动更新</a>。<p class="note"><b>提示：</b>若要不断刷新视图，请在网页的 <code>&lt;head&gt;</code> 部分中添加 <code>&lt;meta http-equiv="refresh" content="#"&gt;</code>，其中 <code>#</code> 是刷新的间隔秒数。</p></td><td><code>http://tabserver/views/Date-Time/DateCalcs?:embed=yes&amp;:refresh=yes</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:render</code></td><td><code>true</code>; <code>false</code>; number</td><td>如果客户端呈现已启用（默认设置），将此项设置为 <code>false</code> 将会对该会话强制实现服务器端呈现。将此参数设置为 <code>true</code>为会话强制实施客户端渲染。<p>可以输入从 1 到 100 的数字来设置复杂性阈值，超过该阈值时，服务器将会呈现视图。有关详细信息，请参见 Tableau Server 帮助中的<a href="https://help.tableau.com/current/server/zh-cn/browser_rendering.htm" target="_blank">关于客户端呈现</a>。</p></td><td><code>http://tabserver/views/Date-Time/DateCalcs?:render=false</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:revert</code></td><td><code>all; filters; sorts; axes; shelves</code></td><td>使该项返回到其原始状态。</td><td><code>http://tabserver/views/Date-Time/DateCalcs?:embed=yes&amp;:revert=all</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:showAppBanner</code></td><td><code>false</code></td><td>在移动 Web 浏览器中隐藏“在 Tableau Mobile 中打开”横幅。</td><td><code>http://tabserver/views/Date-Time/DateCalcs?:embed=yes&amp;:showAppBanner=false</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:showAskData</code></td><td><code>false</code></td><td>在嵌入视图中的工具栏中隐藏“数据问答”(Ask Data) 功能按钮。默认情况下，将显示“数据问答”(Ask Data) 功能按钮。</td><td><code>http://tabserver/views/Date-Time/DateCalcs?:embed=yes&amp;:showAskData=false</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:showShareOptions</code></td><td><code>true</code>；<code>false</code></td><td>控制是否在嵌入视图中显示“共享”选项。</td><td><code>http://tabserver/views/Date-Time/DateCalcs?:embed=yes&amp;:showShareOptions=true</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:showVizHome</code><p>（仅限 Tableau Public）</p></td><td><code>yes; no</code></td><td>显示或隐藏 Tableau Public 的内容导航界面。在其他网页中嵌入可视化项时设置为 no。</td><td><code>https://public.tableau.com/en-us/s/gallery/what-emoji-say-about-music?:showVizHome=no</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:subscriptions</code></td><td><code>no</code></td><td>隐藏嵌入视图中的“订阅”按钮。</td><td><code>http://tabserver/views/Date-Time/DateCalcs?:embed=yes&amp;:subscriptions=no</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:tabs</code></td><td><code>yes; no</code></td><td>显示或隐藏选项卡。</td><td><code>http://tabserver/views/Date-Time/DateCalcs?:embed=yes&amp;:tabs=no</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:toolbar</code></td><td><code>yes; no; top</code></td><td>如果未设置此参数，默认情况下显示工具栏。当选择 <code>no</code> 时，工具栏将从嵌入视图中排除。当选择 <code>top</code> 时，工具栏将置于视图之上。</td><td><code>http://tabserver/views/Date-Time/DateCalcs?:embed=yes&amp;:toolbar=no</code></td></tr><tr class="TableStyle-Basic-Border-Body-Body1"><td><code>:tooltip</code></td><td><code>yes; no</code></td><td>如果未设置此参数，默认情况下视图中将显示工具提示。如果设置为 <code>no</code>，则会从嵌入视图中排除工具提示。</td><td><code>http://tabserver/views/workbookQ4/SalesQ4?:embed=yes&amp;:tooltip=no</code></td></tr></tbody></table>