Skip to content

Commit 7bb83ed

Browse files
author
Hyunmo Kang
committed
Merged PR 126990: Add a page renaming api to both report and page
- add renamePage api in report - add setName api to page.ts; update renamePage to PUT REST api call; - update tests for page.setName and report.renamePage Related work items: #442373
1 parent d391253 commit 7bb83ed

6 files changed

Lines changed: 6965 additions & 6817 deletions

File tree

dist/powerbi-client.d.ts

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -889,6 +889,16 @@ declare module "page" {
889889
* @returns {Promise<void>}
890890
*/
891891
setFilters(filters: models.IFilter[]): Promise<void>;
892+
/**
893+
* Set displayName to the current page.
894+
*
895+
* ```javascript
896+
* page.setName(displayName);
897+
* ```
898+
*
899+
* @returns {Promise<void>}
900+
*/
901+
setDisplayName(displayName: string): Promise<void>;
892902
/**
893903
* Gets all the visuals on the page.
894904
*
@@ -1007,12 +1017,23 @@ declare module "report" {
10071017
*
10081018
* ```javascript
10091019
* // Delete a page from a report by pageName (PageName is different than the display name and can be acquired from the getPages API)
1010-
* report.deletePage("Sales145");
1020+
* report.deletePage("ReportSection145");
1021+
* ```
1022+
*
1023+
* @returns {Promise<void>}
1024+
*/
1025+
deletePage(pageName: string): Promise<void>;
1026+
/**
1027+
* Rename a page from a report
1028+
*
1029+
* ```javascript
1030+
* // Rename a page from a report by changing displayName (pageName is different from the display name and can be acquired from the getPages API)
1031+
* report.renamePage("ReportSection145", "Sales");
10111032
* ```
10121033
*
10131034
* @returns {Promise<void>}
10141035
*/
1015-
deletePage(pageName?: string): Promise<void>;
1036+
renamePage(pageName: string, displayName: string): Promise<void>;
10161037
/**
10171038
* Gets filters that are applied at the report level.
10181039
*

0 commit comments

Comments
 (0)