Добавление, удаление или переименование страницы отчета

Api операции страницы можно использовать для добавления или удаления страницы из отчета во время сеанса встроенной аналитики Power BI.

Добавление страницы

Чтобы добавить новую страницу в текущий отчет, используйте метод класса отчета клиента Power BI:

addPage(displayName?: string): Promise<Page>
  • displayName задает отображаемое имя новой страницы. Если не указано, отображаемое имя имеет значение Page#<NUM>.
  • Функция возвращает экземпляр Page новой страницы.

Например, добавьте страницу с отображаемым именем sales в текущий отчет:

let newPage = await report.addPage("Sales");

Удаление страницы

Чтобы удалить страницу из отчета, можно использовать метод deletePage класса Report или метод delete класса Page в зависимости от контекста. Возвращаемое значение разрешается после удаления страницы.

Удаление страницы с помощью экземпляра отчета

Чтобы удалить страницу из отчета с помощью экземпляра Report:

deletePage(pageName: string): Promise<void>

pageName — это уникальный идентификатор, который отличается от displayName. Api report.getPages можно использовать для получения pageName.

Например, удалите страницу с именем ReportSection123:

await report.deletePage("ReportSection123");

ReportSection123 — это pageName API getPages, возвращенный на страницу продаж

Удаление страницы с помощью экземпляра страницы

Чтобы удалить страницу из отчета с помощью экземпляра Page:

delete(): Promise<void>

Например:

newPage.delete();

Переименование страницы

Чтобы переименовать страницу в отчете, можно использовать метод renamePage класса Report или метод setDisplayName класса Page в зависимости от контекста. Возвращаемое значение разрешается после переименования страницы.

Переименование страницы с помощью экземпляра отчета

Чтобы переименовать страницу из отчета с помощью экземпляра Report:

renamePage(pageName: string, displayName: string): Promise<void>

pageName — это уникальный идентификатор, который отличается от displayName. Api report.getPages можно использовать для получения pageName.

Например, переименуйте страницу с именем ReportSection123 в New Sales:

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

— это API , возвращенный для страницы продаж .

Переименование страницы с помощью экземпляра страницы

Чтобы переименовать страницу из отчета с помощью экземпляра Page:

setDisplayName(displayName: string): Promise<void>

Например, переименуйте страницу на new Sales:

newPage.setDisplayName("New Sales");

Рекомендации и ограничения

Операции страницы работают только после загрузки отчета.