Merged PR 3813: adding swipe events

adding swipe events & has layout to support report mobile layout

Author: somriar

demo/v2-demo/scripts/codesamples.js

@@ -1135,6 +1135,24 @@ function _Page_RemoveFilters() {
         });
 }
 
+function _Page_HasLayout() {
+    // Get models. models contains enums that can be used.
+    var models = window['powerbi-client'].models;
+
+    // Get a reference to the embedded report HTML element
+    var embedContainer = $('#embedContainer')[0];
+
+    // Get a reference to the embedded report.
+    report = powerbi.get(embedContainer);
+    
+    // Retrieve the page collection and check if the first page has a MobilePortrait layout.
+    report.getPages().then(function (pages) {
+        pages[0].hasLayout(models.LayoutType.MobilePortrait).then(function(hasLayout) {
+            Log.log(hasLayout);
+        })
+    });
+}
+
 // ---- Event Listener ----------------------------------------------------
 
 function _Events_PageChanged() {

demo/v2-demo/scripts/step_embed.js

@@ -81,6 +81,9 @@ function Page_RemoveFilters() {
     SetCode(_Page_RemoveFilters);
 }
 
+function Page_HasLayout() {
+    SetCode(_Page_HasLayout);
+}
 // ---- Event Listener ----------------------------------------------------
 
 function Events_PageChanged() {

demo/v2-demo/settings_interact.html

@@ -45,6 +45,7 @@
                         <li onclick="Page_SetFilters()">Set Filters</li>
                         <li onclick="Page_GetFilters()">Get Filters</li>
                         <li onclick="Page_RemoveFilters()">Remove Filters</li>
+                        <li onclick="Page_HasLayout()">Check Layout</li>
                         <li class="newOperation"  onclick="Page_GetVisuals()">Get Visuals</li>
                     </ul>
                 </div>

dist/powerbi-client.d.ts

@@ -1,4 +1,4 @@
-/*! powerbi-client v2.4.6 | (c) 2016 Microsoft Corporation MIT */
+/*! powerbi-client v2.4.7 | (c) 2016 Microsoft Corporation MIT */
 declare module "config" {
     const config: {
         version: string;
@@ -619,6 +619,17 @@ declare module "page" {
          * @returns {Promise<VisualDescriptor[]>}
          */
         getVisuals(): Promise<VisualDescriptor[]>;
+        /**
+         * Checks if page has layout.
+         *
+         * ```javascript
+         * page.hasLayout(layoutType)
+         *  .then(hasLayout: boolean => { ... });
+         * ```
+         *
+         * @returns {(Promise<boolean>)}
+         */
+        hasLayout(layoutType: any): Promise<boolean>;
     }
 }
 declare module "defaults" {

dist/powerbi.js

@@ -1,6 +1,6 @@
 {
   "name": "powerbi-client",
-  "version": "2.4.6",
+  "version": "2.4.7",
   "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",
@@ -75,7 +75,7 @@
   },
   "dependencies": {
     "http-post-message": "^0.2",
-    "powerbi-models": "^1.0.1",
+    "powerbi-models": "^1.0.2",
     "powerbi-router": "^0.1",
     "window-post-message-proxy": "^0.2"
   },

dist/powerbi.min.js

@@ -1,5 +1,5 @@
 const config = {
-  version: '2.4.6',
+  version: '2.4.7',
   type: 'js'
 };
 

package.json

@@ -157,4 +157,23 @@ export class Page implements IPageNode, IFilterable {
         throw response.body;
       });
   }
+
+  /**
+   * Checks if page has layout.
+   * 
+   * ```javascript
+   * page.hasLayout(layoutType)
+   *  .then(hasLayout: boolean => { ... });
+   * ```
+   * 
+   * @returns {(Promise<boolean>)}
+   */
+  hasLayout(layoutType): Promise<boolean> {
+    let layoutTypeEnum = models.LayoutType[layoutType];
+    return this.report.service.hpm.get<boolean>(`/report/pages/${this.name}/layoutTypes/${layoutTypeEnum}`, { uid: this.report.config.uniqueId }, this.report.iframe.contentWindow)
+      .then(response => response.body,
+      response => {
+        throw response.body;
+      });
+  }
 }

src/config.ts

@@ -31,7 +31,7 @@ export interface IReportNode {
  * @implements {IFilterable}
  */
 export class Report extends embed.Embed implements IReportNode, IFilterable {
-  static allowedEvents = ["filtersApplied", "pageChanged", "commandTriggered"];
+  static allowedEvents = ["filtersApplied", "pageChanged", "commandTriggered", "swipeStart", "swipeEnd"];
   static reportIdAttribute = 'powerbi-report-id';
   static filterPaneEnabledAttribute = 'powerbi-settings-filter-pane-enabled';
   static navContentPaneEnabledAttribute = 'powerbi-settings-nav-content-pane-enabled';
@@ -306,6 +306,8 @@ export class Report extends embed.Embed implements IReportNode, IFilterable {
    */
   populateConfig(baseConfig: embed.IEmbedConfigurationBase): void {
     let config = <embed.IEmbedConfiguration>baseConfig;
+    if (config.settings && (config.settings.layoutType === models.LayoutType.MobileLandscape || config.settings.layoutType === models.LayoutType.MobilePortrait))
+        config.embedUrl = utils.addParamToUrl(config.embedUrl, "isMobile", "true")
 
     super.populateConfig(config);