Merged PR 52310: Merge adding rdl sample to master

Merge adding rdl sample to master

Author: mshmordo

CONTRIBUTING.md

@@ -84,4 +84,12 @@ npm run gulp -- build:docs
 If the docs are correct then you may publish them to gh-pages using this command
 ```
 npm run gulp -- ghpages
-```
+```
+
+## Known issues
+Running demo fails with an error ERR_INVALID_REDIRECT
+This happens due to version 10 of http-server. To solve the problem, please install [email protected] globally using:
+
+```
+npm install -g [email protected]
+```

demo/package.json

@@ -31,9 +31,10 @@
   ],
   "dependencies": {
     "bootstrap": "^4.1.2",
+    "ecstatic": "^3.3.1",
     "es6-promise": "^3.2.2",
     "fetch": "^1.0.0",
-    "http-server": "^0.10.0",
+    "http-server": "^0.9.0",
     "jquery": "^3.1.0",
     "powerbi-client": "file:..",
     "powerbi-report-authoring": "^1.0.0",

demo/v2-demo/images/samplerdlreport.png

@@ -42,6 +42,7 @@
                 <div class="visualContainer iframeContainer"></div>
                 <div class="tileContainer iframeContainer"></div>
                 <div class="qnaContainer iframeContainer"></div>
+                <div class="paginatedReportContainer iframeContainer"></div>
             </div>
             <div class="mobile-view">
                 <div class="phone-frame">
@@ -54,6 +55,7 @@
                         <div class="visualMobileContainer iframeContainer"></div>
                         <div class="tileMobileContainer iframeContainer"></div>
                         <div class="qnaMobileContainer iframeContainer"></div>
+                        <div class="paginatedReportMobileContainer iframeContainer"></div>
                     </div>
                     <div class="phone-bottom">
                         <div class="phone-button"></div>

demo/v2-demo/report.html

@@ -152,6 +152,48 @@ function _Embed_BasicEmbed_Mobile() {
     });
 }
 
+// ---- Paginated Embed Code ----------------------------------------------------
+function _Embed_PaginatedReportBasicEmbed() {
+    // Read embed application token from textbox
+    var txtAccessToken = $('#txtAccessToken').val();
+
+    // Read embed URL from textbox
+    var txtEmbedUrl = $('#txtReportEmbed').val();
+
+    // Read paginated report Id from textbox
+    var txtEmbedReportId = $('#txtEmbedReportId').val();
+
+    // Read embed type from radio
+    var tokenType = $('input:radio[name=tokenType]:checked').val();
+
+    // Get models. models contains enums that can be used.
+    var models = window['powerbi-client'].models;
+
+    // Se view permissions.
+    var permissions = models.Permissions.View;  
+
+    // Embed configuration used to describe the what and how to embed.
+    // This object is used when calling powerbi.embed.
+    // This also includes settings and options such as filters.
+    // You can find more information at https://github.com/Microsoft/PowerBI-JavaScript/wiki/Embed-Configuration-Details.
+    var config = {
+      type: 'report',
+      tokenType: tokenType == '0' ? models.TokenType.Aad : models.TokenType.Embed,
+      accessToken: txtAccessToken,
+      embedUrl: txtEmbedUrl,
+      id: txtEmbedReportId,
+      permissions: permissions,
+    };
+
+    // Get a reference to the paginated embedded report HTML element
+    var paginatedReportContainer = $('#paginatedReportContainer')[0];
+
+    // Embed the paginated report and display it within the div container.
+    var report = powerbi.embed(paginatedReportContainer, config);
+
+    Log.logText("Loading Paginated Report.");
+}
+
 function _Embed_VisualEmbed() {
     // Read embed application token from textbox
     var txtAccessToken = $('#txtAccessToken').val();
@@ -1163,6 +1205,19 @@ function _Report_Reload() {
         });
 }
 
+function _PaginatedReport_Reload() {
+    // Get a reference to the paginated report HTML element
+    var paginatedReportContainer = $('#paginatedReportContainer')[0];
+
+    // Get a reference to the embedded paginated report.
+    paginatedReport = powerbi.get(paginatedReportContainer);
+
+    // Reload the displayed paginated report
+    paginatedReport.reload();
+    
+    Log.logText("Reload Paginated Report");
+}
+
 function _Report_Refresh() {
     // Get a reference to the embedded report HTML element
     var embedContainer = $('#embedContainer')[0];
@@ -1380,6 +1435,43 @@ function _Report_ExitFullScreen() {
     report.exitFullscreen();
 }
 
+// ---- PaginatedReport Operations ----------------------------------------------------
+
+function _PaginatedReport_GetId() {
+    // Get a reference to the embedded report HTML element
+    var paginatedReportContainer = $('#paginatedReportContainer')[0];
+
+    // Get a reference to the embedded report.
+    paginatedReport = powerbi.get(paginatedReportContainer);
+
+    // Retrieve the report id.
+    var reportId = paginatedReport.getId();
+
+    Log.logText(reportId);
+}
+
+function _PaginatedReport_FullScreen() {
+    // Get a reference to the paginated embedded report HTML element
+    var paginatedReportContainer = $('#paginatedReportContainer')[0];
+
+    // Get a reference to the paginated embedded report.
+    paginatedReport = powerbi.get(paginatedReportContainer);
+
+    // Displays the paginated report in full screen mode.
+    paginatedReport.fullscreen();
+}
+
+function _PaginatedReport_ExitFullScreen() {
+    // Get a reference to the paginated embedded report HTML element
+    var paginatedReportContainer = $('#paginatedReportContainer')[0];
+
+    // Get a reference to the paginated embedded report.
+    paginatedReport = powerbi.get(paginatedReportContainer);
+
+    // Exits full screen mode.
+    paginatedReport.exitFullscreen();
+}
+
 function _Report_switchModeEdit() {
     // Get a reference to the embedded report HTML element
     var embedContainer = $('#embedContainer')[0];

demo/v2-demo/scripts/codesamples.js

@@ -48,7 +48,7 @@ function IsNotSupported(funcName) {
         return false
     }
 
-    const notReportMatch = funcName.match(/Dashboard|Tile|Qna|Visual|Mobile/);
+    const notReportMatch = funcName.match(/Dashboard|Tile|Qna|Visual|Mobile|PaginatedReport/);
     if (notReportMatch) {
       return false;
     }

demo/v2-demo/scripts/function_mapping.js

@@ -145,6 +145,12 @@ function LoadEmbedSettings(mode, entityType, tokenType) {
             OpenEmbedMode(mode, entityType,tokenType);
         });
     }
+    else if (entityType == EntityType.PaginatedReport)
+    {
+        $("#settings").load("settings_embed_paginatedreport.html", function() {
+            OpenEmbedMode(mode, entityType,tokenType);
+        });
+    }
 }
 
 function OpenEmbedTab() {
@@ -219,6 +225,13 @@ function OpenInteractTab() {
             LoadCodeArea("#embedCodeDiv", "");
         });
     }
+    else if (entityType == EntityType.PaginatedReport)
+    {
+        $("#settings").load("settings_interact_paginatedreport.html", function() {
+            SetToggleHandler("operation-categories");
+            LoadCodeArea("#embedCodeDiv", "");
+        });
+    }
     else
     {
         $("#settings").load("settings_interact_report.html", function() {
@@ -269,6 +282,10 @@ function getEmbedCode(mode, entityType)
     {
         code = GetParameterByName(SessionKeys.TokenType) === '0' /* AAD Token */ ? _Embed_QnaEmbed_Aad : _Embed_QnaEmbed;
     }
+    else if (entityType == EntityType.PaginatedReport)
+    {
+       code = _Embed_PaginatedReportBasicEmbed
+    }
     return code;
 }
 
@@ -420,6 +437,18 @@ function OpenEmbedMode(mode, entityType, tokenType)
             LoadSettings();
         }
     }
+    else if (entityType == EntityType.PaginatedReport) {
+        if (IsEmbeddingSamplePaginatedReport()) {
+            LoadSamplePaginatedReportIntoSession().then(function (response) {
+                SetTextBoxesFromSessionOrUrlParam("#txtAccessToken", "#txtReportEmbed", "#txtEmbedReportId");
+                setCodeAndShowEmbedSettings(mode, entityType, tokenType);
+            });
+        }
+        else {
+            SetTextBoxesFromSessionOrUrlParam("#txtAccessToken", "#txtReportEmbed", "#txtEmbedReportId");
+            setCodeAndShowEmbedSettings(mode, entityType, tokenType);
+        }
+    }
 }
 
 function setCodeAndShowEmbedSettings(mode, entityType, tokenType) {
@@ -459,6 +488,10 @@ function IsEmbeddingSampleQna() {
     return GetSession(SessionKeys.IsSampleQna) == true;
 }
 
+function IsEmbeddingSamplePaginatedReport() {
+    return GetSession(SessionKeys.IsSamplePaginatedReport) == true;
+}
+
 function ToggleQuestionBox(enabled) {
     UpdateSession("input[name='qnaMode']:checked", SessionKeys.QnaMode);
     let txtQuestion = $("#txtQuestion");
@@ -540,6 +573,12 @@ function ReloadSample(entityType) {
             SetTextBoxesFromSessionOrUrlParam("#txtAccessToken", "#txtQnaEmbed", "#txtDatasetId");
         });
     }
+    else if (entityType == EntityType.PaginatedReport)
+    {
+        LoadSamplePaginatedReportIntoSession().then(function (response) {
+            SetTextBoxesFromSessionOrUrlParam("#txtAccessToken", "#txtReportEmbed", "#txtEmbedReportId");
+        });
+    }
 }
 
 function EmbedAreaDesktopView() {

demo/v2-demo/scripts/report.js

@@ -3,6 +3,7 @@ const datasetUrl = 'https://powerbiplaygroundbe.azurewebsites.net/api/Reports/Sa
 const dashboardUrl = 'https://powerbiplaygroundbe.azurewebsites.net/api/Dashboards/SampleDashboard';
 const tileUrl = 'https://powerbiplaygroundbe.azurewebsites.net/api/Tiles/SampleTile';
 const qnaUrl = 'https://powerbiplaygroundbe.azurewebsites.net/api/Datasets/SampleQna';
+const paginatedReportUrl = 'https://powerbiplaygroundbe.azurewebsites.net/api/Reports/SampleRdlReport';
 const layoutShowcaseReportUrl = 'https://powerbiplaygroundbe.azurewebsites.net/api/Reports/LayoutDemoReport';
 const insightToActionShowcaseReportUrl = 'https://powerbiplaygroundbe.azurewebsites.net/api/Reports/InsightToActionReport';
 const themesShowcaseReportUrl = 'https://powerbiplaygroundbe.azurewebsites.net/api/Reports/ThemesReport';
@@ -19,7 +20,8 @@ const EntityType = {
     Visual : "Visual",
     Dashboard : "Dashboard",
     Tile : "Tile",
-    Qna: "Qna"
+    Qna: "Qna",
+    PaginatedReport: "PaginatedReport"
 };
 
 const SessionKeys = {
@@ -34,6 +36,7 @@ const SessionKeys = {
     IsSampleDashboard: "IsSampleDashboard",
     IsSampleTile: "IsSampleTile",
     IsSampleQna: "IsSampleQna",
+    IsSamplePaginatedReport: "IsSamplePaginatedReport",
     IsTelemetryEnabled: "isTelemetryEnabled",
     PageName: "PageName",
     QnaQuestion: "QnaQuestion",
@@ -110,6 +113,10 @@ function SetIsSample(value) {
     {
         SetSession(SessionKeys.IsSampleQna, value);
     }
+    else if (entityType == EntityType.PaginatedReport)
+    {
+        SetSession(SessionKeys.IsSamplePaginatedReport, value);
+    }
 }
 
 function SetTextboxFromSessionOrUrlParam(sessionKey, textboxSelector) {
@@ -278,6 +285,11 @@ function LoadSampleQnaIntoSession() {
     return FetchUrlIntoSession(qnaUrl, false /* updateCurrentToken */);
 }
 
+function LoadSamplePaginatedReportIntoSession() {
+    SetSession(SessionKeys.EntityType, EntityType.PaginatedReport);
+    return FetchUrlIntoSession(paginatedReportUrl, false /* updateCurrentToken */);
+}
+
 function LoadLayoutShowcaseReportIntoSession() {
     SetSession(SessionKeys.EntityType, EntityType.Report);
     return FetchUrlIntoSession(layoutShowcaseReportUrl, false /* updateCurrentToken */);

demo/v2-demo/scripts/session_utils.js

@@ -35,6 +35,22 @@ function Report_Reload() {
     SetCode(_Report_Reload);
 }
 
+function PaginatedReport_Reload() {
+    SetCode(_PaginatedReport_Reload);
+}
+
+function PaginatedReport_GetId() {
+    SetCode(_PaginatedReport_GetId);
+}
+
+function PaginatedReport_FullScreen() {
+    SetCode(_PaginatedReport_FullScreen);
+}
+
+function PaginatedReport_ExitFullScreen() {
+    SetCode(_PaginatedReport_ExitFullScreen);
+}
+
 function Report_Refresh() {
     SetCode(_Report_Refresh);
 }

demo/v2-demo/scripts/step_embed.js

@@ -32,6 +32,11 @@ function OpenCodeStepWithSample(entityType) {
       SetSession(SessionKeys.IsSampleQna, true);
       OpenCodeStep(EmbedViewMode, EntityType.Qna)
     }
+    else if (entityType == EntityType.PaginatedReport)
+    {
+      SetSession(SessionKeys.IsSamplePaginatedReport, true);
+      OpenCodeStep(EmbedViewMode, EntityType.PaginatedReport)
+    }
     else {
       assert(false);
       trackEvent(TelemetryEventName.CodeStepError, {});