新增、刪除或重新命名報表頁面
您可以使用頁面作業 API 在 Power BI 內嵌分析工作階段期間,從報表新增或刪除頁面。
新增頁面
若要將新頁面新增至目前報表,請使用Power BI用戶端 報表 類別的 addPage
方法:
addPage(displayName?: string): Promise<Page>
-
displayName
設定新頁面的顯示名稱。 如果未指定,顯示名稱會設定為Page#<NUM>
。 - 函式會傳回新頁面的
Page
實例。
例如,將顯示名稱 Sales 的頁面新增至目前的報表:
let newPage = await report.addPage("Sales");
刪除頁面
若要從報表中刪除頁面,您可以使用 Report 類別的 deletePage
方法,或 Page 類別的 delete
方法,視內容而定。 傳回值會在刪除頁面之後解析。
使用報表實例刪除頁面
若要使用 Report
實體從報表中刪除頁面:
deletePage(pageName: string): Promise<void>
pageName
是與 displayName
不同的唯一標識符。 您可以使用 report.getPages
API 來取得 pageName
。
例如,刪除名稱為 ReportSection123
的頁面:
await report.deletePage("ReportSection123");
ReportSection123
是針對 Sales 頁面傳回的 getPages
API pageName
使用 Page 實例刪除頁面
若要使用 Page
實體從報表中刪除頁面:
delete(): Promise<void>
例如:
newPage.delete();
重新命名頁面
若要重新命名報表上的頁面,您可以使用 Report 類別的 renamePage
方法,或根據內容而定,Page 類別的 setDisplayName
方法。 傳回值會在重新命名頁面之後解析。
使用報表實例重新命名頁面
若要使用 Report
實例從報表重新命名頁面:
renamePage(pageName: string, displayName: string): Promise<void>
pageName
是與 displayName
不同的唯一標識符。 您可以使用 report.getPages
API 來取得 pageName
。
例如,將名稱為 ReportSection123
的頁面重新命名為 New Sales:
report.renamePage("ReportSection123", "New Sales");
ReportSection123
是針對 Sales 頁面傳回 getPages
API 的 pageName
。
使用 Page 實例重新命名頁面
若要使用 Page
實例從報表重新命名頁面:
setDisplayName(displayName: string): Promise<void>
例如,將頁面重新命名為 New Sales:
newPage.setDisplayName("New Sales");
考慮和限制
頁面作業只有在載入報表之後才能運作。