Merged PR 16640: add page size and page display options to page object

add page size and page display options to page object

Author: ali-hamud

dist/powerbi-client.d.ts

@@ -397,6 +397,10 @@ declare module "embed" {
          * Sets Iframe for embed
          */
         private setIframe(isLoad, phasedRender?);
+        /**
+         * Sets Iframe's title
+         */
+        setComponentTitle(title: string): void;
         /**
          * Adds the ability to get groupId from url.
          * By extracting the ID we can ensure that the ID is always explicitly provided as part of the load configuration.
@@ -625,6 +629,16 @@ declare module "page" {
          * @type {models.SectionVisibility}
          */
         visibility: models.SectionVisibility;
+        /**
+         * Page size as saved in the report.
+         * @type {models.ICustomPageSize}
+         */
+        defaultSize: models.ICustomPageSize;
+        /**
+         * Page display options as saved in the report.
+         * @type {models.ICustomPageSize}
+         */
+        defaultDisplayOption: models.DisplayOption;
         /**
          * Creates an instance of a Power BI report page.
          *
@@ -634,7 +648,7 @@ declare module "page" {
          * @param {boolean} [isActivePage]
          * @param {models.SectionVisibility} [visibility]
          */
-        constructor(report: IReportNode, name: string, displayName?: string, isActivePage?: boolean, visibility?: models.SectionVisibility);
+        constructor(report: IReportNode, name: string, displayName?: string, isActivePage?: boolean, visibility?: models.SectionVisibility, defaultSize?: models.ICustomPageSize, defaultDisplayOption?: models.DisplayOption);
         /**
          * Gets all page level filters within the report.
          *

dist/powerbi.js

@@ -5,7 +5,7 @@ import * as models from 'powerbi-models';
 
 /**
  * A Page node within a report hierarchy
- * 
+ *
  * @export
  * @interface IPageNode
  */
@@ -16,7 +16,7 @@ export interface IPageNode {
 
 /**
  * A Power BI report page
- * 
+ *
  * @export
  * @class Page
  * @implements {IPageNode}
@@ -25,65 +25,79 @@ export interface IPageNode {
 export class Page implements IPageNode, IFilterable {
   /**
    * The parent Power BI report that this page is a member of
-   * 
+   *
    * @type {IReportNode}
    */
   report: IReportNode;
   /**
    * The report page name
-   * 
+   *
    * @type {string}
    */
   name: string;
 
   /**
    * The user defined display name of the report page, which is undefined if the page is created manually
-   * 
+   *
    * @type {string}
    */
   displayName: string;
 
   /**
    * Is this page is the active page
-   * 
+   *
    * @type {boolean}
    */
-  isActive: boolean; 
+  isActive: boolean;
 
   /**
    * The visibility of the page.
    * 0 - Always Visible
    * 1 - Hidden in View Mode
-   * 
+   *
    * @type {models.SectionVisibility}
    */
    visibility: models.SectionVisibility;
 
+  /**
+   * Page size as saved in the report.
+   * @type {models.ICustomPageSize}
+   */
+  defaultSize: models.ICustomPageSize;
+
+  /**
+   * Page display options as saved in the report.
+   * @type {models.ICustomPageSize}
+   */
+  defaultDisplayOption: models.DisplayOption;
+
   /**
    * Creates an instance of a Power BI report page.
-   * 
+   *
    * @param {IReportNode} report
    * @param {string} name
    * @param {string} [displayName]
    * @param {boolean} [isActivePage]
    * @param {models.SectionVisibility} [visibility]
    */
-  constructor(report: IReportNode, name: string, displayName?: string, isActivePage?: boolean, visibility?: models.SectionVisibility) {
+  constructor(report: IReportNode, name: string, displayName?: string, isActivePage?: boolean, visibility?: models.SectionVisibility, defaultSize?: models.ICustomPageSize, defaultDisplayOption?: models.DisplayOption) {
     this.report = report;
     this.name = name;
     this.displayName = displayName;
     this.isActive = isActivePage;
     this.visibility = visibility;
+    this.defaultSize = defaultSize;
+    this.defaultDisplayOption = defaultDisplayOption;
   }
 
   /**
    * Gets all page level filters within the report.
-   * 
+   *
    * ```javascript
    * page.getFilters()
    *  .then(filters => { ... });
    * ```
-   * 
+   *
    * @returns {(Promise<models.IFilter[]>)}
    */
   getFilters(): Promise<models.IFilter[]> {
@@ -96,11 +110,11 @@ export class Page implements IPageNode, IFilterable {
 
   /**
    * Removes all filters from this page of the report.
-   * 
+   *
    * ```javascript
    * page.removeFilters();
    * ```
-   * 
+   *
    * @returns {Promise<void>}
    */
   removeFilters(): Promise<void> {
@@ -109,11 +123,11 @@ export class Page implements IPageNode, IFilterable {
 
   /**
    * Makes the current page the active page of the report.
-   * 
+   *
    * ```javascripot
    * page.setActive();
    * ```
-   * 
+   *
    * @returns {Promise<void>}
    */
   setActive(): Promise<void> {
@@ -131,12 +145,12 @@ export class Page implements IPageNode, IFilterable {
 
   /**
    * Sets all filters on the current page.
-   * 
+   *
    * ```javascript
    * page.setFilters(filters);
    *   .catch(errors => { ... });
    * ```
-   * 
+   *
    * @param {(models.IFilter[])} filters
    * @returns {Promise<void>}
    */
@@ -149,12 +163,12 @@ export class Page implements IPageNode, IFilterable {
 
   /**
    * Gets all the visuals on the page.
-   * 
+   *
    * ```javascript
    * page.getVisuals()
    *   .then(visuals => { ... });
    * ```
-   * 
+   *
    * @returns {Promise<VisualDescriptor[]>}
    */
   getVisuals(): Promise<VisualDescriptor[]> {
@@ -171,12 +185,12 @@ export class Page implements IPageNode, IFilterable {
 
   /**
    * Checks if page has layout.
-   * 
+   *
    * ```javascript
    * page.hasLayout(layoutType)
    *  .then(hasLayout: boolean => { ... });
    * ```
-   * 
+   *
    * @returns {(Promise<boolean>)}
    */
   hasLayout(layoutType): Promise<boolean> {

dist/powerbi.min.js

@@ -169,7 +169,7 @@ export class Report extends embed.Embed implements IReportNode, IFilterable {
       .then(response => {
         return response.body
           .map(page => {
-            return new Page(this, page.name, page.displayName, page.isActive, page.visibility);
+            return new Page(this, page.name, page.displayName, page.isActive, page.visibility, page.defaultSize, page.defaultDisplayOption);
           });
       }, response => {
         throw response.body;