添加、删除或重命名报表页

可以使用页面操作 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 是为 “销售”页返回的 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 的页面重命名为“新建销售”

report.renamePage("ReportSection123", "New Sales");

ReportSection123 是为“销售”页返回的 getPages API 的 pageName

使用 Page 实例重命名页面

若要使用 Page 实例从报表重命名页面,请执行以下操作:

setDisplayName(displayName: string): Promise<void>

例如,将页面重命名为 新销售

newPage.setDisplayName("New Sales");

注意事项和限制

页面操作仅在加载报表后工作。