Merged PR 220053: Add background and wallpaper styles to report page - Release version 2.18.7

Related PRs:
https://dev.azure.com/powerbi/PowerBIClients/_git/PowerBIClients/pullrequest/199032
https://dev.azure.com/powerbi/PowerBIClients/_git/PowerBIClients/pullrequest/212871

Author: aliabufoul

dist/powerbi-client.d.ts

@@ -1,4 +1,4 @@
-// powerbi-client v2.18.6
+// powerbi-client v2.18.7
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 declare module "config" {
@@ -780,7 +780,7 @@ declare module "visualDescriptor" {
 }
 declare module "page" {
     import { IHttpPostMessageResponse } from 'http-post-message';
-    import { DisplayOption, FiltersOperations, ICustomPageSize, IFilter, IVisual, LayoutType, PageSizeType, SectionVisibility, VisualContainerDisplayMode } from 'powerbi-models';
+    import { DisplayOption, FiltersOperations, ICustomPageSize, IFilter, IVisual, LayoutType, PageSizeType, SectionVisibility, VisualContainerDisplayMode, IPageBackground, IPageWallpaper } from 'powerbi-models';
     import { IFilterable } from "ifilterable";
     import { IReportNode } from "report";
     import { VisualDescriptor } from "visualDescriptor";
@@ -853,6 +853,18 @@ declare module "page" {
          * @type {ICustomPageSize}
          */
         defaultDisplayOption: DisplayOption;
+        /**
+         * Page background color.
+         *
+         * @type {IPageBackground}
+         */
+        background: IPageBackground;
+        /**
+         * Page wallpaper color.
+         *
+         * @type {IPageWallpaper}
+         */
+        wallpaper: IPageWallpaper;
         /**
          * Creates an instance of a Power BI report page.
          *
@@ -863,7 +875,7 @@ declare module "page" {
          * @param {SectionVisibility} [visibility]
          * @hidden
          */
-        constructor(report: IReportNode, name: string, displayName?: string, isActivePage?: boolean, visibility?: SectionVisibility, defaultSize?: ICustomPageSize, defaultDisplayOption?: DisplayOption, mobileSize?: ICustomPageSize);
+        constructor(report: IReportNode, name: string, displayName?: string, isActivePage?: boolean, visibility?: SectionVisibility, defaultSize?: ICustomPageSize, defaultDisplayOption?: DisplayOption, mobileSize?: ICustomPageSize, background?: IPageBackground, wallpaper?: IPageWallpaper);
         /**
          * Gets all page level filters within the report.
          *

dist/powerbi.js

@@ -1,6 +1,6 @@
 {
   "name": "powerbi-client",
-  "version": "2.18.6",
+  "version": "2.18.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",
   "types": "dist/powerbi-client.d.ts",
@@ -81,7 +81,7 @@
   },
   "dependencies": {
     "http-post-message": "^0.2",
-    "powerbi-models": "^1.9.5",
+    "powerbi-models": "^1.9.7",
     "powerbi-router": "^0.1",
     "window-post-message-proxy": "^0.2"
   },

dist/powerbi.min.js

@@ -3,7 +3,7 @@
 
 /** @ignore *//** */
 const config = {
-  version: '2.18.6',
+  version: '2.18.7',
   type: 'js'
 };
 

package.json

@@ -15,7 +15,9 @@ import {
   PageLevelFilters,
   PageSizeType,
   SectionVisibility,
-  VisualContainerDisplayMode
+  VisualContainerDisplayMode,
+  IPageBackground,
+  IPageWallpaper,
 } from 'powerbi-models';
 import { IFilterable } from './ifilterable';
 import { IReportNode, Report } from './report';
@@ -100,6 +102,20 @@ export class Page implements IPageNode, IFilterable {
    */
   defaultDisplayOption: DisplayOption;
 
+  /**
+   * Page background color.
+   *
+   * @type {IPageBackground}
+   */
+  background: IPageBackground;
+
+  /**
+   * Page wallpaper color.
+   *
+   * @type {IPageWallpaper}
+   */
+  wallpaper: IPageWallpaper;
+
   /**
    * Creates an instance of a Power BI report page.
    *
@@ -110,7 +126,7 @@ export class Page implements IPageNode, IFilterable {
    * @param {SectionVisibility} [visibility]
    * @hidden
    */
-  constructor(report: IReportNode, name: string, displayName?: string, isActivePage?: boolean, visibility?: SectionVisibility, defaultSize?: ICustomPageSize, defaultDisplayOption?: DisplayOption, mobileSize?: ICustomPageSize) {
+  constructor(report: IReportNode, name: string, displayName?: string, isActivePage?: boolean, visibility?: SectionVisibility, defaultSize?: ICustomPageSize, defaultDisplayOption?: DisplayOption, mobileSize?: ICustomPageSize, background?: IPageBackground, wallpaper?: IPageWallpaper) {
     this.report = report;
     this.name = name;
     this.displayName = displayName;
@@ -119,6 +135,8 @@ export class Page implements IPageNode, IFilterable {
     this.defaultSize = defaultSize;
     this.mobileSize = mobileSize;
     this.defaultDisplayOption = defaultDisplayOption;
+    this.background = background;
+    this.wallpaper = wallpaper;
   }
 
   /**

src/config.ts

@@ -342,7 +342,7 @@ export class Report extends Embed implements IReportNode, IFilterable {
     try {
       const response = await this.service.hpm.get<IPage[]>('/report/pages', { uid: this.config.uniqueId }, this.iframe.contentWindow);
       return response.body
-        .map((page) => new Page(this, page.name, page.displayName, page.isActive, page.visibility, page.defaultSize, page.defaultDisplayOption, page.mobileSize));
+        .map((page) => new Page(this, page.name, page.displayName, page.isActive, page.visibility, page.defaultSize, page.defaultDisplayOption, page.mobileSize, page.background, page.wallpaper));
     } catch (response) {
       throw response.body;
     }
@@ -382,7 +382,9 @@ export class Report extends Embed implements IReportNode, IFilterable {
         page.visibility,
         page.defaultSize,
         page.defaultDisplayOption,
-        page.mobileSize
+        page.mobileSize,
+        page.background,
+        page.wallpaper,
       );
     } catch (response) {
       throw response.body;
@@ -417,7 +419,9 @@ export class Report extends Embed implements IReportNode, IFilterable {
         activePage.visibility,
         activePage.defaultSize,
         activePage.defaultDisplayOption,
-        activePage.mobileSize
+        activePage.mobileSize,
+        activePage.background,
+        activePage.wallpaper,
       );
     } catch (response) {
       throw response.body;