Merged PR 24012: preload api for embedding

breueran · breueran · commit 7f3c5ab81974 · 2017-11-16T09:01:03.000Z
preload api for embedding.
user can give his embedUrl to "warm-start" the scripts, or uses a default reportEmbed url.
This can run angular bootstrap &amp; script downloading\parsing and utilize browser cache.
This helps background loading as well as multi iframe scenario
diff --git a/demo/bower.json b/demo/bower.json
@@ -20,7 +20,7 @@
     "es6-promise": "^3.2.2",
     "bootstrap": "^3.3.6",
     "jquery": "^3.1.0",
-    "powerbi-client": "^2.2.1"
+    "powerbi-client": "2.4.3"
   },
   "devDependencies": {}
 }
diff --git a/demo/package.json b/demo/package.json
@@ -35,7 +35,7 @@
     "fetch": "^1.0.0",
     "http-server": "^0.9.0",
     "jquery": "^3.1.0",
-    "powerbi-client": "^2.4.1",
+    "powerbi-client": "2.4.3",
     "syntaxhighlighter": "4.0.1"
   },
   "devDependencies": {}
diff --git a/demo/v2-demo/scripts/index.js b/demo/v2-demo/scripts/index.js
@@ -4,6 +4,7 @@ var anyReportSectionLoaded = false;
 
 $(function() {
     OpenSampleSection();
+    WarmStartSampleReportEmbed();
 });
 
 function OpenSampleSection() {
diff --git a/demo/v2-demo/scripts/step_authorize.js b/demo/v2-demo/scripts/step_authorize.js
@@ -184,6 +184,23 @@ function OpenEmbedStepFromUserSettings() {
     OpenEmbedStep(EmbedViewMode, EntityType.Report);
 }
 
+function WarmStartSampleReportEmbed() {
+  FetchUrlIntoSession(reportUrl, false /* updateCurrentToken */).then((response) => {
+    var embedUrl = GetParameterByName(SessionKeys.EmbedUrl);
+    if (!embedUrl)
+    {
+        embedUrl = GetSession(SessionKeys.EmbedUrl);
+    }
+    const config= {
+      type: 'report',
+      embedUrl: embedUrl
+    };
+  
+    // Preload sample report
+    powerbi.preload(config);
+  });
+}
+
 function setSession(accessToken, embedUrl, embedId, dashboardId)
 {
     SetSession(SessionKeys.AccessToken, accessToken);
diff --git a/dist/powerbi-client.d.ts b/dist/powerbi-client.d.ts
@@ -943,6 +943,7 @@ declare module "service" {
         /** TODO: Look for way to make wpmp private.  This is only public to allow stopping the wpmp in tests */
         wpmp: wpmp.WindowPostMessageProxy;
         private router;
+        private static DefaultInitEmbedUrl;
         /**
          * Creates an instance of a Power BI Service.
          *
@@ -1039,6 +1040,15 @@ declare module "service" {
          * @param {IEvent<any>} event
          */
         private handleEvent(event);
+        /**
+         * API for warm starting powerbi embedded endpoints.
+         * Use this API to preload Power BI Embedded in the background.
+         *
+         * @public
+         * @param {embed.IEmbedConfigurationBase} [config={}]
+         * @param {HTMLElement} [element=undefined]
+         */
+        preload(config: embed.IEmbedConfigurationBase, element?: HTMLElement): HTMLIFrameElement;
     }
 }
 declare module "create" {
diff --git a/dist/powerbi.js b/dist/powerbi.js
diff --git a/dist/powerbi.js.map b/dist/powerbi.js.map
diff --git a/dist/powerbi.min.js b/dist/powerbi.min.js
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "powerbi-client",
-  "version": "2.4.2",
+  "version": "2.4.3",
   "description": "JavaScript library for embedding Power BI into your apps. Provides service which makes it easy to embed different types of components and an object model which allows easy interaction with these components such as changing pages, applying filters, and responding to data selection.",
   "main": "dist/powerbi.js",
   "typings": "dist/powerbi-client.d.ts",
diff --git a/src/service.ts b/src/service.ts
@@ -103,6 +103,8 @@ export class Service implements IService {
   wpmp: wpmp.WindowPostMessageProxy;
   private router: router.Router;
 
+  private static DefaultInitEmbedUrl: string = "http://app.powerbi.com/reportEmbed";
+
   /**
    * Creates an instance of a Power BI Service.
    * 
@@ -422,4 +424,32 @@ export class Service implements IService {
       utils.raiseCustomEvent(embed.element, event.name, value);
     }
   }
+
+  /**
+   * API for warm starting powerbi embedded endpoints.
+   * Use this API to preload Power BI Embedded in the background.
+   * 
+   * @public
+   * @param {embed.IEmbedConfigurationBase} [config={}]
+   * @param {HTMLElement} [element=undefined]
+   */
+  preload(config: embed.IEmbedConfigurationBase, element?: HTMLElement) {
+    var iframeContent = document.createElement("iframe");
+    iframeContent.setAttribute("style", "display:none;");
+    iframeContent.setAttribute("src", config.embedUrl);
+    iframeContent.setAttribute("scrolling", "no");
+    iframeContent.setAttribute("allowfullscreen", "false");
+
+    var node = element;
+    if (!node) {
+      node = document.getElementsByTagName("body")[0];
+    }
+
+    node.appendChild(iframeContent);
+    iframeContent.onload = () => {
+      utils.raiseCustomEvent(iframeContent, "preloaded", {});
+    };
+
+    return iframeContent;
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`"es6-promise": "^3.2.2",`
`21`	`21`	`"bootstrap": "^3.3.6",`
`22`	`22`	`"jquery": "^3.1.0",`
`23`		`- "powerbi-client": "^2.2.1"`
	`23`	`+ "powerbi-client": "2.4.3"`
`24`	`24`	`},`
`25`	`25`	`"devDependencies": {}`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "powerbi-client",`
`3`		`- "version": "2.4.2",`
	`3`	`+ "version": "2.4.3",`
`4`	`4`	`"description": "JavaScript library for embedding Power BI into your apps. Provides service which makes it easy to embed different types of components and an object model which allows easy interaction with these components such as changing pages, applying filters, and responding to data selection.",`
`5`	`5`	`"main": "dist/powerbi.js",`
`6`	`6`	`"typings": "dist/powerbi-client.d.ts",`