Merged PR 21999: support configuration of locale

support configuration of  locale

Author: noanu

dist/powerbi-client.d.ts

@@ -1,4 +1,4 @@
-/*! powerbi-client v2.3.2 | (c) 2016 Microsoft Corporation MIT */
+/*! powerbi-client v2.3.3 | (c) 2016 Microsoft Corporation MIT */
 declare module "config" {
     const config: {
         version: string;
@@ -52,6 +52,16 @@ declare module "util" {
      * @returns {string}
      */
     export function createRandomString(): string;
+    /**
+     * Adds a parameter to the given url
+     *
+     * @export
+     * @param {string} url
+     * @param {string} paramName
+     * @param {string} value
+     * @returns {string}
+     */
+    export function addParamToUrl(url: string, paramName: string, value: string): string;
 }
 declare module "embed" {
     import * as service from "service";
@@ -78,7 +88,7 @@ declare module "embed" {
         uniqueId?: string;
         embedUrl?: string;
         accessToken?: string;
-        settings?: models.ISettings;
+        settings?: IEmbedSettings;
         pageName?: string;
         filters?: models.IFilter[];
         pageView?: models.PageView;
@@ -91,6 +101,13 @@ declare module "embed" {
         height?: number;
         width?: number;
     }
+    export interface ILocaleSettings {
+        language?: string;
+        formatLocale?: string;
+    }
+    export interface IEmbedSettings extends models.ISettings {
+        localeSettings?: ILocaleSettings;
+    }
     export interface IInternalEmbedConfiguration extends models.IReportLoadConfiguration {
         uniqueId: string;
         type: string;
@@ -291,6 +308,13 @@ declare module "embed" {
          * @returns {void}
          */
         private populateConfig(config);
+        /**
+         * Adds locale parameters to embedUrl
+         *
+         * @private
+         * @param {IEmbedConfiguration} config
+         */
+        private addLocaleToEmbedUrl(config);
         /**
          * Gets an embed url from the first available location: options, attribute.
          *

dist/powerbi.js

@@ -1,6 +1,6 @@
 {
   "name": "powerbi-client",
-  "version": "2.3.2",
+  "version": "2.3.3",
   "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",

dist/powerbi.js.map

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

dist/powerbi.min.js

@@ -35,7 +35,7 @@ export interface IEmbedConfiguration {
   uniqueId?: string;
   embedUrl?: string;
   accessToken?: string;
-  settings?: models.ISettings;
+  settings?: IEmbedSettings;
   pageName?: string;
   filters?: models.IFilter[];
   pageView?: models.PageView;
@@ -49,6 +49,15 @@ export interface IEmbedConfiguration {
   width?: number;
 }
 
+export interface ILocaleSettings {
+  language?: string;
+  formatLocale?: string;
+}
+
+export interface IEmbedSettings extends models.ISettings {
+  localeSettings?: ILocaleSettings;
+}
+
 export interface IInternalEmbedConfiguration extends models.IReportLoadConfiguration {
   uniqueId: string;
   type: string;
@@ -382,7 +391,7 @@ export abstract class Embed {
       this.config = utils.assign({ settings }, config);
       this.config.uniqueId = this.getUniqueId();
       this.config.embedUrl = this.getEmbedUrl();
-
+      this.addLocaleToEmbedUrl(config);
       if(this.embeType === 'create') {
           this.createConfig = {
               datasetId: config.datasetId || this.getId(),
@@ -401,6 +410,24 @@ export abstract class Embed {
       }  
   }
 
+  /**
+   * Adds locale parameters to embedUrl
+   * 
+   * @private
+   * @param {IEmbedConfiguration} config
+   */
+  private addLocaleToEmbedUrl(config: IEmbedConfiguration): void {
+      if (!config.settings) {
+        return;
+      }
+      let localeSettings = config.settings.localeSettings
+      if (localeSettings && localeSettings.language) {
+        this.config.embedUrl = utils.addParamToUrl(this.config.embedUrl, 'language', localeSettings.language);
+      }
+      if (localeSettings && localeSettings.formatLocale) {
+        this.config.embedUrl = utils.addParamToUrl(this.config.embedUrl, 'formatLocale', localeSettings.formatLocale);
+      }
+  }
 
   /**
    * Gets an embed url from the first available location: options, attribute.

package.json

@@ -15,11 +15,8 @@ export class Tile extends embed.Embed {
     static allowedEvents = ["tileClicked", "tileLoaded"];
 
     constructor(service: service.Service, element: HTMLElement, config: embed.IEmbedConfiguration) {
-        let url = config.embedUrl;
-        const urlParamMatch = url.indexOf("?") > 0;
-        let firstParamSign = urlParamMatch ? '&' : '?';
-        url = url + firstParamSign + 'dashboardId=' + config.dashboardId + '&tileId=' + config.id;
-        config.embedUrl = url;
+        config.embedUrl = utils.addParamToUrl(config.embedUrl, 'dashboardId', config.dashboardId);
+        config.embedUrl = utils.addParamToUrl(config.embedUrl, 'tileId', config.id);
 
         super(service, element, config);
         Array.prototype.push.apply(this.allowedEvents, Tile.allowedEvents);

src/config.ts

@@ -107,3 +107,18 @@ export function assign(...args) {
 export function createRandomString(): string {
   return (Math.random() + 1).toString(36).substring(7);
 }
+
+/**
+ * Adds a parameter to the given url
+ * 
+ * @export
+ * @param {string} url
+ * @param {string} paramName
+ * @param {string} value
+ * @returns {string}
+ */
+export function addParamToUrl(url: string, paramName: string, value: string): string {
+  let parameterPrefix = url.indexOf('?') > 0 ? '&' : '?';
+  url += parameterPrefix + paramName + '=' + value;
+  return url;
+}

src/embed.ts

@@ -228,6 +228,29 @@ describe('service', function () {
       expect(component2).toBe(component3);
     });
 
+    it('Create embed url with correct locale parameters', function () {
+      // Arrange
+      const $reportContainer = $('<div powerbi-embed-url="https://app.powerbi.com/reportEmbed?reportId=ABC123" powerbi-type="report"></div>')
+        .appendTo('#powerbi-fixture');
+
+      const testConfiguration: embed.IEmbedConfiguration = {
+        accessToken: "fakeAccessToken",
+        embedUrl: 'fakeUrl?reportId=1',
+        id: 'report2',
+        type: 'report',
+        settings: {
+          localeSettings: {
+            language: 'languageName',
+            formatLocale: 'formatName'
+          }
+        }
+      };
+
+      powerbi.embed($reportContainer[0], testConfiguration);
+      var iframe = $reportContainer.find('iframe');
+      expect(iframe.attr('src')).toEqual('fakeUrl?reportId=1&language=languageName&formatLocale=formatName');
+    });
+
     it('if attempting to embed without specifying an embed url, throw error', function () {
       // Arrange
       const component = $('<div></div>')