Skip to content

Commit 766ab54

Browse files
Prachi Mishra (Maq LLC)Amit Shuster
Prachi Mishra (Maq LLC)
authored and
Amit Shuster
committed
Merged PR 65731: [JS SDK - Prepare for documentation]: Marking components as hidden
Related work items: #278352, #284574, #284892, #299795, #316020
1 parent fab62f3 commit 766ab54

16 files changed

Lines changed: 195 additions & 16 deletions

‎src/bookmarksManager.ts‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
/**
2+
* @hidden
3+
*/
14
import * as service from './service';
25
import * as embed from './embed';
36
import * as models from 'powerbi-models';
@@ -32,7 +35,9 @@ export interface IBookmarksManager {
3235
* @implements {IBookmarksManager}
3336
*/
3437
export class BookmarksManager implements IBookmarksManager {
35-
38+
/**
39+
* @hidden
40+
*/
3641
constructor(private service: service.Service, private config: embed.IEmbedConfigurationBase, private iframe?: HTMLIFrameElement) {
3742
}
3843

@@ -62,7 +67,7 @@ export class BookmarksManager implements IBookmarksManager {
6267
}
6368

6469
/**
65-
* Apply bookmark By name.
70+
* Apply bookmark by name.
6671
*
6772
* ```javascript
6873
* bookmarksManager.apply(bookmarkName)
@@ -135,7 +140,7 @@ export class BookmarksManager implements IBookmarksManager {
135140
* Apply bookmark state.
136141
*
137142
* ```javascript
138-
* bookmarksManager.applyState(bookmarkName)
143+
* bookmarksManager.applyState(bookmarkState)
139144
* ```
140145
*
141146
* @returns {Promise<void>}

‎src/config.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
/**
2+
* @hidden
3+
*/
14
const config = {
25
version: '2.10.4',
36
type: 'js'

‎src/create.ts‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
1+
/**
2+
* @hidden
3+
*/
14
import * as service from './service';
25
import * as models from 'powerbi-models';
36
import * as embed from './embed';
47
import * as utils from './util';
58
import { Defaults } from './defaults';
69

10+
/**
11+
* A Power BI Report creator component
12+
*
13+
* @export
14+
* @class Create
15+
* @extends {embed.Embed}
16+
*/
717
export class Create extends embed.Embed {
8-
18+
/*
19+
* @hidden
20+
*/
921
constructor(service: service.Service, element: HTMLElement, config: embed.IEmbedConfiguration, phasedRender?: boolean, isBootstrap?: boolean) {
1022
super(service, element, config, /* iframe */ undefined, phasedRender, isBootstrap);
1123
}
@@ -54,6 +66,10 @@ export class Create extends embed.Embed {
5466
}
5567
}
5668

69+
/**
70+
* @hidden
71+
* @returns {string}
72+
*/
5773
getDefaultEmbedUrlEndpoint(): string {
5874
return "reportEmbed";
5975
}

‎src/dashboard.ts‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
/**
2+
* @hidden
3+
*/
14
import * as service from './service';
25
import * as embed from './embed';
36
import * as models from 'powerbi-models';
@@ -28,15 +31,20 @@ export interface IDashboardNode {
2831
* @implements {IFilterable}
2932
*/
3033
export class Dashboard extends embed.Embed implements IDashboardNode {
34+
/** @hidden */
3135
static allowedEvents = ["tileClicked", "error"];
36+
/** @hidden */
3237
static dashboardIdAttribute = 'powerbi-dashboard-id';
38+
/** @hidden */
3339
static typeAttribute = 'powerbi-type';
40+
/** @hidden */
3441
static type = "Dashboard";
3542

3643
/**
3744
* Creates an instance of a Power BI Dashboard.
3845
*
3946
* @param {service.Service} service
47+
* @hidden
4048
* @param {HTMLElement} element
4149
*/
4250
constructor(service: service.Service, element: HTMLElement, config: embed.IEmbedConfigurationBase, phasedRender?: boolean, isBootstrap?: boolean) {
@@ -96,7 +104,7 @@ export class Dashboard extends embed.Embed implements IDashboardNode {
96104

97105
/**
98106
* Handle config changes.
99-
*
107+
* @hidden
100108
* @returns {void}
101109
*/
102110
configChanged(isBootstrap: boolean): void {
@@ -108,12 +116,17 @@ export class Dashboard extends embed.Embed implements IDashboardNode {
108116
(<embed.IEmbedConfiguration>this.config).id = this.getId();
109117
}
110118

119+
/**
120+
* @hidden
121+
* @returns {string}
122+
*/
111123
getDefaultEmbedUrlEndpoint(): string {
112124
return "dashboardEmbed";
113125
}
114126

115127
/**
116128
* Validate that pageView has a legal value: if page view is defined it must have one of the values defined in models.PageView
129+
* @hidden
117130
*/
118131
private ValidatePageView(pageView: models.PageView): models.IError[] {
119132
if (pageView && pageView !== "fitToWidth" && pageView !== "oneColumn" && pageView !== "actualSize") {

‎src/defaults.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1+
/** @hidden */
12
import * as models from 'powerbi-models';
23

4+
/** @hidden */
35
export abstract class Defaults {
46
public static defaultSettings: models.ISettings = {
57
filterPaneEnabled: true

0 commit comments

Comments
 (0)