Skip to content

Commit c8eed4a

Browse files
author
Shahak Yosef
committed
Merged PR 128710: Hide unnecessary function
Page is a weird function that creates a Page object with just the name, there is no guarantee that the Page actually exists. We don't want it to appear in the documentation as it can be confusing.
1 parent a4c8301 commit c8eed4a

File tree

3 files changed

+3
-15
lines changed

3 files changed

+3
-15
lines changed

dist/powerbi-client.d.ts

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1076,15 +1076,11 @@ declare module "report" {
10761076
*
10771077
* Note: Because you are creating the page manually there is no guarantee that the page actually exists in the report, and subsequent requests could fail.
10781078
*
1079-
* ```javascript
1080-
* const page = report.page('ReportSection1');
1081-
* page.setActive();
1082-
* ```
1083-
*
10841079
* @param {string} name
10851080
* @param {string} [displayName]
10861081
* @param {boolean} [isActive]
10871082
* @returns {Page}
1083+
* @hidden
10881084
*/
10891085
page(name: string, displayName?: string, isActive?: boolean, visibility?: models.SectionVisibility): Page;
10901086
/**

dist/powerbi.js

Lines changed: 1 addition & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/report.ts

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -258,15 +258,11 @@ export class Report extends embed.Embed implements IReportNode, IFilterable {
258258
*
259259
* Note: Because you are creating the page manually there is no guarantee that the page actually exists in the report, and subsequent requests could fail.
260260
*
261-
* ```javascript
262-
* const page = report.page('ReportSection1');
263-
* page.setActive();
264-
* ```
265-
*
266261
* @param {string} name
267262
* @param {string} [displayName]
268263
* @param {boolean} [isActive]
269264
* @returns {Page}
265+
* @hidden
270266
*/
271267
page(name: string, displayName?: string, isActive?: boolean, visibility?: models.SectionVisibility): Page {
272268
return new Page(this, name, displayName, isActive, visibility);

0 commit comments

Comments
 (0)