為檢視內嵌程式碼參數
Tableau Server 2022.3 及更高版本和 Tableau Cloud 的內嵌程式碼已變更為使用內嵌 API v3。有關內嵌 API v3 中的類別和方法的目前清單,請參閱內嵌 API 說明中的內嵌 API 參考。本主題中的資訊適用於先前版本的內嵌(使用 Tableau JavaScript API v1 和 v2)。
您可以使用以下任一方法設定內嵌式檢視:
JavaScript 標記的物件參數
物件參數 | 值 | 說明 | 範例 |
---|---|---|---|
dataDetails | no | 隱藏工具列中的 [資料詳情] 按鈕,讓使用者看到檢視中使用的資料相關詳情。 | <param name='dataDetails' value='no' /> |
showDataDetails | yes | 若已啟用 Tableau Catalog,則會顯示已開啟「資料詳細資訊」窗格的檢視。 | <param name='showDataDetails' value='yes' /> |
alerts | no | 隱藏工具列中的 [通知] 按鈕,該按鈕使使用者能建立資料驅動型通知。 | <param name='alerts' value='no'/> |
customViews | no | 隱藏工具列中的 [檢視] 按鈕,該按鈕使使用者能儲存自訂檢視。 | <param name='customViews' value='no'/> |
device | desktop; 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/'>
|
linktarget | 字串 | 外部超連結的目標視窗名稱。 | <param name="linktarget" value="_blank"/> |
load-order | 數字 | 當內嵌多個檢視時,確定檢視在頁面上的載入順序。允許使用負數。 | <param name="load-order" value="2"/> |
mobile | yes | 顯示針對行動裝置的觸控優化快速篩選器。 | <param
name='mobile' value='yes'/> |
name | 字串 | 所需的物件參數,具有此結構:[工作簿名稱]/[工作表名稱]/[可選自訂檢視名稱] 按如下方式設定可選自訂檢視名稱的格式:username@domain/[custom view name] | <param name='name' value='ExampleCoSales/Sales'/>
|
:original_view | yes | 如果 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'/>
|
showShareOptions | true ;false | 控制是否在內嵌檢視中顯示 [共用] 選項。 | <param name='showShareOptions' value='true' /> |
site_root | 字串 | 必需。網站名稱。預設網站值為空 (value='' )。如果伺服器為多網站伺服器,並且您希望使用受信任的驗證,請參閱 Tableau Server 說明中的顯示檢視及票證(連結在新視窗開啟)。 | <param name='site_root' value='/#/Sales'/>
|
subscriptions | no | 隱藏工具列中的 [訂閱] 按鈕,該按鈕使使用者能設定電子郵件訂閱以定期接收檢視的快照集。 |
|
tabs | yes; no | 顯示或隱藏索引標籤。 | <param name='tabs' value='yes'/> |
ticket (僅限 Tableau Server。不適用於 Tableau Cloud。) | 字串 | 僅適用于受信任的驗證,不能與 path 物件參數一起使用。必須與 name 物件一起使用以構造受信任的票證兌現 URL。有關詳情,請參閱 Tableau Server 說明中的顯示檢視及票證(連結在新視窗開啟)。 | <param name='ticket' value='9D1ObyqDQmSIOyQpKdy4Sw==:dg62gCsSE0QRArXNTOp6mlJ5'/>
|
toolbar | yes; no; top | 工具列預設情況下顯示在底部。當您將此參數設定為 top 時,工具列放在檢視上方,當您將其設定為 no 時,則會將工具列從內嵌式檢視中排除。 | <param name='toolbar' value='top'/> |
tooltip | yes; no | 如果將此參數設定為 no ,則預設情況下顯示工具提示,但是,將從內嵌式檢視中排除工具提示。 | <param name='tooltip' value='no'/> |
iframe 標記的 URL 參數
附註:在新增 URL 參數之前,請移除 URL 末尾的 :iid=[#]
。這是目前瀏覽器會話的臨時檢視計數器。
URL 參數 | 值 | 說明 | 範例 |
---|---|---|---|
:dataDetails | no | 隱藏工具列中的 [資料詳情] 按鈕,讓使用者看到檢視中使用的資料相關詳情。 | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:dataDetails=no |
:showDataDetails | yes | 若已啟用 Tableau Catalog,則會顯示已開啟「資料詳細資訊」窗格的檢視。 | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:showDataDetails=yes |
:alerts | no | 隱藏內嵌檢視中的 [通知] 按鈕。 | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:alerts=no |
:customViews | no | [記住我的變更] 選項。 | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:customViews=no |
:device | desktop; 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 |
:embed | yes | 必需的 URL 參數。隱藏頂端巡覽區域,使檢視更好地混合到網頁中。 | http://tabserver/views/Date-Time/DateCalcs?:embed=yes |
:format | pdf; png | 以 PDF 或 .png 檔案顯示檢視。 | http://tabserver/views/Sales/Q2?:format=pdf |
:highdpi | false | 在高解析度顯示幕和裝置上使用標準 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 |
:refresh | yes | 使用 Tableau Server 或 Tableau Cloud 中的最新資料來呈現檢視。 提示:若要不斷重新整理檢視,請在網頁的 | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:refresh=yes |
:render | true ; false ; number | 如果用戶端呈現已啟用(預設設定),將此項設定為 false 將會對該會話強制實現伺服器端呈現。將此項設定為 true 會對該會話強制實現用戶端呈現。可以輸入從 1 到 100 的數字來設定複雜性閾值,超過該閾值時,伺服器將會呈現檢視。有關詳情,請參閱 Tableau Server 說明中的關於用戶端呈現(連結在新視窗開啟)。 | http://tabserver/views/Date-Time/DateCalcs?:render=false |
:revert | all; filters; sorts; axes; shelves | 使該項返回到其原始狀態。 | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:revert=all |
:showAppBanner | false | 隱藏行動 Web 瀏覽器中的「在 Tableau Mobile 中開啟」橫幅。 | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:showAppBanner=false |
:showAskData | false | 在內嵌檢視中隱藏工具列中的「資料問答」(Ask Data) 按鈕。預設情況下,顯示「資料問答」(Ask Data) 按鈕。 | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:showAskData=false |
:showShareOptions | true ;false | 控制是否在內嵌檢視中顯示 [共用] 選項。 | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:showShareOptions=true |
:showVizHome (僅限 Tableau Public) | yes; no | 顯示或隱藏 Tableau Public 的內容導覽介面。當在其他網頁中內嵌視覺效果時,設定為否。 | https://public.tableau.com/en-us/s/gallery/what-emoji-say-about-music?:showVizHome=no |
:subscriptions | no | 隱藏內嵌檢視中的 [訂閱] 按鈕。 | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:subscriptions=no |
:tabs | yes; no | 顯示或隱藏索引標籤。 | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:tabs=no |
:toolbar | yes; no; top | 如果未設定此參數,預設情況下顯示工具列。當選取 no 時,工具列將從內嵌檢視中排除。當選取 top 時,工具列將置於檢視之上。 | http://tabserver/views/Date-Time/DateCalcs?:embed=yes&:toolbar=no |
:tooltip | yes; no | 如果未設定此參數,預設情況下檢視中將顯示工具提示。如果設定為 no ,則會從內嵌檢視中排除工具提示。 | http://tabserver/views/workbookQ4/SalesQ4?:embed=yes&:tooltip=no |