Merged PR 65731: [JS SDK - Prepare for documentation]: Marking components as hidden

Related work items: #278352, #284574, #284892, #299795, #316020

Author: Prachi Mishra (Maq LLC)

src/bookmarksManager.ts

@@ -1,3 +1,6 @@
+/**
+ * @hidden
+ */
 import * as service from './service';
 import * as embed from './embed';
 import * as models from 'powerbi-models';
@@ -32,7 +35,9 @@ export interface IBookmarksManager {
  * @implements {IBookmarksManager}
  */
 export class BookmarksManager implements IBookmarksManager {
-
+    /**
+     * @hidden
+     */
     constructor(private service: service.Service, private config: embed.IEmbedConfigurationBase, private iframe?: HTMLIFrameElement) {
     }
 
@@ -62,7 +67,7 @@ export class BookmarksManager implements IBookmarksManager {
     }
 
     /**
-     * Apply bookmark By name.
+     * Apply bookmark by name.
      *
      * ```javascript
      * bookmarksManager.apply(bookmarkName)
@@ -135,7 +140,7 @@ export class BookmarksManager implements IBookmarksManager {
      * Apply bookmark state.
      *
      * ```javascript
-     * bookmarksManager.applyState(bookmarkName)
+     * bookmarksManager.applyState(bookmarkState)
      * ```
      *
      * @returns {Promise<void>}

src/config.ts

@@ -1,3 +1,6 @@
+/**
+ * @hidden
+ */
 const config = {
   version: '2.10.4',
   type: 'js'

src/create.ts

@@ -1,11 +1,23 @@
+/**
+ * @hidden
+ */
 import * as service from './service';
 import * as models from 'powerbi-models';
 import * as embed from './embed';
 import * as utils from './util';
 import { Defaults } from './defaults';
 
+/**
+ * A Power BI Report creator component
+ *
+ * @export
+ * @class Create
+ * @extends {embed.Embed}
+ */
 export class Create extends embed.Embed {
-
+  /*
+   * @hidden
+   */
   constructor(service: service.Service, element: HTMLElement, config: embed.IEmbedConfiguration, phasedRender?: boolean, isBootstrap?: boolean) {
     super(service, element, config, /* iframe */ undefined, phasedRender, isBootstrap);
   }
@@ -54,6 +66,10 @@ export class Create extends embed.Embed {
     }
   }
 
+  /**
+   * @hidden
+   * @returns {string}
+   */
   getDefaultEmbedUrlEndpoint(): string {
     return "reportEmbed";
   }

src/dashboard.ts

@@ -1,3 +1,6 @@
+/**
+ * @hidden
+ */
 import * as service from './service';
 import * as embed from './embed';
 import * as models from 'powerbi-models';
@@ -28,15 +31,20 @@ export interface IDashboardNode {
  * @implements {IFilterable}
  */
 export class Dashboard extends embed.Embed implements IDashboardNode {
+    /** @hidden */  
     static allowedEvents = ["tileClicked", "error"];
+    /** @hidden */  
     static dashboardIdAttribute = 'powerbi-dashboard-id';
+    /** @hidden */  
     static typeAttribute = 'powerbi-type';
+    /** @hidden */  
     static type = "Dashboard";
 
     /**
      * Creates an instance of a Power BI Dashboard.
      *
      * @param {service.Service} service
+     * @hidden
      * @param {HTMLElement} element
      */
     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 {
 
     /**
      * Handle config changes.
-     *
+     * @hidden
      * @returns {void}
      */
     configChanged(isBootstrap: boolean): void {
@@ -108,12 +116,17 @@ export class Dashboard extends embed.Embed implements IDashboardNode {
       (<embed.IEmbedConfiguration>this.config).id = this.getId();
     }
 
+    /**
+     * @hidden
+     * @returns {string}
+     */
     getDefaultEmbedUrlEndpoint(): string {
       return "dashboardEmbed";
     }
 
     /**
      * Validate that pageView has a legal value: if page view is defined it must have one of the values defined in models.PageView
+     * @hidden
      */
     private ValidatePageView(pageView: models.PageView): models.IError[] {
       if (pageView && pageView !== "fitToWidth" && pageView !== "oneColumn" && pageView !== "actualSize") {

src/defaults.ts

@@ -1,5 +1,7 @@
+/** @hidden */  
 import * as models from 'powerbi-models';
 
+/** @hidden */  
 export abstract class Defaults {
   public static defaultSettings: models.ISettings = {
     filterPaneEnabled: true