Add pageView to loadDashboardConfiguration

noanu · noanu · commit dc1b7156f2a2 · 2016-11-13T09:08:55.000-08:00
diff --git a/dist/dashboard.d.ts b/dist/dashboard.d.ts
@@ -55,4 +55,8 @@ export declare class Dashboard extends embed.Embed implements IDashboardNode {
      * Validate load configuration.
      */
     validate(config: models.IDashboardLoadConfiguration): models.IError[];
+    /**
+     * Validate that pageView has a legal value: if page view is defined it must have one of the values defined in models.PageView
+     */
+    private ValidatePageView(pageView);
 }
diff --git a/dist/embed.d.ts b/dist/embed.d.ts
@@ -26,6 +26,7 @@ export interface IEmbedConfiguration {
     settings?: models.ISettings;
     pageName?: string;
     filters?: models.IFilter[];
+    pageView?: models.PageView;
 }
 export interface IInternalEmbedConfiguration extends models.IReportLoadConfiguration {
     uniqueId: string;
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
@@ -74,7 +74,7 @@
   },
   "dependencies": {
     "http-post-message": "^0.2.3",
-    "powerbi-models": "^0.10.0",
+    "powerbi-models": "^0.10.1",
     "powerbi-router": "^0.1.4",
     "window-post-message-proxy": "^0.2.4"
   },
diff --git a/src/dashboard.ts b/src/dashboard.ts
@@ -85,6 +85,16 @@ export class Dashboard extends embed.Embed implements IDashboardNode {
      * Validate load configuration.
      */
     validate(config: models.IDashboardLoadConfiguration): models.IError[] {
-      return models.validateDashboardLoad(config);
+      let error = models.validateDashboardLoad(config);
+      return error ? error : this.ValidatePageView(config.pageView);
+    }
+   
+    /**
+     * Validate that pageView has a legal value: if page view is defined it must have one of the values defined in models.PageView
+     */
+    private ValidatePageView(pageView: models.PageView): models.IError[] {
+      if (pageView && pageView !== "fitToWidth" && pageView !== "oneColumn" && pageView !== "actualSize") {
+        return [{message: "pageView must be one of the followings: fitToWidth, oneColumn, actualSize"}];
+      }
     }
 }
diff --git a/src/embed.ts b/src/embed.ts
@@ -38,6 +38,7 @@ export interface IEmbedConfiguration {
   settings?: models.ISettings;
   pageName?: string;
   filters?: models.IFilter[];
+  pageView?: models.PageView;
 }
 
 export interface IInternalEmbedConfiguration extends models.IReportLoadConfiguration {
diff --git a/test/test.spec.ts b/test/test.spec.ts
@@ -20,6 +20,34 @@ declare global {
   }
 }
 
+function ValidateDashboardConfigurationWorksAsExpected(pageView: string, exceptionExpected: boolean, powerbi: service.Service) {
+  const embedUrl = `https://app.powerbi.com/dashboardEmbed`;
+  const component = $(`<div powerbi-embed-url="${embedUrl}" powerbi-type="report"></div>`)
+    .appendTo('#powerbi-fixture');
+
+  const dashboardEmbedConfig = {
+    type: "dashboard",
+    id: "fakeReportId",
+    accessToken: "fakeAccessToken",
+    embedUrl: "fakeEmbedUrl",
+    pageView: pageView
+  };
+
+  powerbi.embed(component[0], <any>dashboardEmbedConfig);
+
+  var exceptionThrown = false;
+  // Act
+  try {
+    powerbi.embed(component[0], <any>dashboardEmbedConfig);
+  }
+  catch(e) {
+    exceptionThrown = true;
+  }
+
+  // Assert
+  expect(exceptionThrown).toBe(exceptionExpected);
+}
+
 let logMessages = (window.__karma__.config.args[0] === 'logMessages');
 
 describe('service', function () {
@@ -218,6 +246,26 @@ describe('service', function () {
       expect(attemptToEmbed).toThrowError();
     });
 
+    it('if attempting to embed a dashboard with an invalid pageView, throw error', function () {
+      ValidateDashboardConfigurationWorksAsExpected("notValid", true, powerbi);
+    });
+
+    it('if attempting to embed a dashboard with a pageView equals fitToWidth, don\'t throw error', function () {
+        ValidateDashboardConfigurationWorksAsExpected("fitToWidth", false, powerbi);
+    });
+
+    it('if attempting to embed a dashboard with a pageView equals oneColumn, don\'t throw error', function () {
+        ValidateDashboardConfigurationWorksAsExpected("oneColumn", false, powerbi);
+    });
+
+    it('if attempting to embed a dashboard with a pageView equals actualSize, don\'t throw error', function () {
+        ValidateDashboardConfigurationWorksAsExpected("actualSize", false, powerbi);
+    });
+
+    it('if attempting to embed a dashboard with an undefined pageView, don\'t throw error', function () {
+        ValidateDashboardConfigurationWorksAsExpected(undefined, false, powerbi);
+    });
+
     it('should get uqiqueId from config first', function () {
       // Arrange
       const testUniqueId = 'fakeUniqueId';

Original file line number	Diff line number	Diff line change
`@@ -55,4 +55,8 @@ export declare class Dashboard extends embed.Embed implements IDashboardNode {`
`55`	`55`	`* Validate load configuration.`
`56`	`56`	`*/`
`57`	`57`	`validate(config: models.IDashboardLoadConfiguration): models.IError[];`
	`58`	`+ /**`
	`59`	`+ * Validate that pageView has a legal value: if page view is defined it must have one of the values defined in models.PageView`
	`60`	`+ */`
	`61`	`+ private ValidatePageView(pageView);`
`58`	`62`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ export interface IEmbedConfiguration {`
`26`	`26`	`settings?: models.ISettings;`
`27`	`27`	`pageName?: string;`
`28`	`28`	`filters?: models.IFilter[];`
	`29`	`+ pageView?: models.PageView;`
`29`	`30`	`}`
`30`	`31`	`export interface IInternalEmbedConfiguration extends models.IReportLoadConfiguration {`
`31`	`32`	`uniqueId: string;`
Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,7 @@ export interface IEmbedConfiguration {`
`38`	`38`	`settings?: models.ISettings;`
`39`	`39`	`pageName?: string;`
`40`	`40`	`filters?: models.IFilter[];`
	`41`	`+ pageView?: models.PageView;`
`41`	`42`	`}`
`42`	`43`
`43`	`44`	`export interface IInternalEmbedConfiguration extends models.IReportLoadConfiguration {`