forked from microsoft/PowerBI-JavaScript
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpowerbi.js
7317 lines (7038 loc) · 295 KB
/
powerbi.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*! powerbi-client v2.10.3 | (c) 2016 Microsoft Corporation MIT */
(function webpackUniversalModuleDefinition(root, factory) {
if(typeof exports === 'object' && typeof module === 'object')
module.exports = factory();
else if(typeof define === 'function' && define.amd)
define([], factory);
else if(typeof exports === 'object')
exports["powerbi-client"] = factory();
else
root["powerbi-client"] = factory();
})(this, function() {
return /******/ (function(modules) { // webpackBootstrap
/******/ // The module cache
/******/ var installedModules = {};
/******/
/******/ // The require function
/******/ function __webpack_require__(moduleId) {
/******/
/******/ // Check if module is in cache
/******/ if(installedModules[moduleId])
/******/ return installedModules[moduleId].exports;
/******/
/******/ // Create a new module (and put it into the cache)
/******/ var module = installedModules[moduleId] = {
/******/ exports: {},
/******/ id: moduleId,
/******/ loaded: false
/******/ };
/******/
/******/ // Execute the module function
/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__);
/******/
/******/ // Flag the module as loaded
/******/ module.loaded = true;
/******/
/******/ // Return the exports of the module
/******/ return module.exports;
/******/ }
/******/
/******/
/******/ // expose the modules object (__webpack_modules__)
/******/ __webpack_require__.m = modules;
/******/
/******/ // expose the module cache
/******/ __webpack_require__.c = installedModules;
/******/
/******/ // __webpack_public_path__
/******/ __webpack_require__.p = "";
/******/
/******/ // Load entry module and return exports
/******/ return __webpack_require__(0);
/******/ })
/************************************************************************/
/******/ ([
/* 0 */
/***/ (function(module, exports, __webpack_require__) {
var service = __webpack_require__(1);
exports.service = service;
var factories = __webpack_require__(17);
exports.factories = factories;
var models = __webpack_require__(5);
exports.models = models;
var report_1 = __webpack_require__(6);
exports.Report = report_1.Report;
var dashboard_1 = __webpack_require__(13);
exports.Dashboard = dashboard_1.Dashboard;
var tile_1 = __webpack_require__(14);
exports.Tile = tile_1.Tile;
var embed_1 = __webpack_require__(2);
exports.Embed = embed_1.Embed;
var page_1 = __webpack_require__(8);
exports.Page = page_1.Page;
var qna_1 = __webpack_require__(15);
exports.Qna = qna_1.Qna;
var visual_1 = __webpack_require__(16);
exports.Visual = visual_1.Visual;
var visualDescriptor_1 = __webpack_require__(9);
exports.VisualDescriptor = visualDescriptor_1.VisualDescriptor;
/**
* Makes Power BI available to the global object for use in applications that don't have module loading support.
*
* Note: create an instance of the class with the default configuration for normal usage, or save the class so that you can create an instance of the service.
*/
var powerbi = new service.Service(factories.hpmFactory, factories.wpmpFactory, factories.routerFactory);
window.powerbi = powerbi;
/***/ }),
/* 1 */
/***/ (function(module, exports, __webpack_require__) {
var embed = __webpack_require__(2);
var report_1 = __webpack_require__(6);
var create_1 = __webpack_require__(12);
var dashboard_1 = __webpack_require__(13);
var tile_1 = __webpack_require__(14);
var page_1 = __webpack_require__(8);
var qna_1 = __webpack_require__(15);
var visual_1 = __webpack_require__(16);
var utils = __webpack_require__(3);
/**
* The Power BI Service embed component, which is the entry point to embed all other Power BI components into your application
*
* @export
* @class Service
* @implements {IService}
*/
var Service = (function () {
/**
* Creates an instance of a Power BI Service.
*
* @param {IHpmFactory} hpmFactory The http post message factory used in the postMessage communication layer
* @param {IWpmpFactory} wpmpFactory The window post message factory used in the postMessage communication layer
* @param {IRouterFactory} routerFactory The router factory used in the postMessage communication layer
* @param {IServiceConfiguration} [config={}]
*/
function Service(hpmFactory, wpmpFactory, routerFactory, config) {
var _this = this;
if (config === void 0) { config = {}; }
this.wpmp = wpmpFactory(config.wpmpName, config.logMessages);
this.hpm = hpmFactory(this.wpmp, null, config.version, config.type);
this.router = routerFactory(this.wpmp);
this.uniqueSessionId = utils.generateUUID();
/**
* Adds handler for report events.
*/
this.router.post("/reports/:uniqueId/events/:eventName", function (req, res) {
var event = {
type: 'report',
id: req.params.uniqueId,
name: req.params.eventName,
value: req.body
};
_this.handleEvent(event);
});
this.router.post("/reports/:uniqueId/pages/:pageName/events/:eventName", function (req, res) {
var event = {
type: 'report',
id: req.params.uniqueId,
name: req.params.eventName,
value: req.body
};
_this.handleEvent(event);
});
this.router.post("/reports/:uniqueId/pages/:pageName/visuals/:visualName/events/:eventName", function (req, res) {
var event = {
type: 'report',
id: req.params.uniqueId,
name: req.params.eventName,
value: req.body
};
_this.handleEvent(event);
});
this.router.post("/dashboards/:uniqueId/events/:eventName", function (req, res) {
var event = {
type: 'dashboard',
id: req.params.uniqueId,
name: req.params.eventName,
value: req.body
};
_this.handleEvent(event);
});
this.router.post("/tile/:uniqueId/events/:eventName", function (req, res) {
var event = {
type: 'tile',
id: req.params.uniqueId,
name: req.params.eventName,
value: req.body
};
_this.handleEvent(event);
});
/**
* Adds handler for Q&A events.
*/
this.router.post("/qna/:uniqueId/events/:eventName", function (req, res) {
var event = {
type: 'qna',
id: req.params.uniqueId,
name: req.params.eventName,
value: req.body
};
_this.handleEvent(event);
});
/**
* Adds handler for front load 'ready' message.
*/
this.router.post("/ready/:uniqueId", function (req, res) {
var event = {
type: 'report',
id: req.params.uniqueId,
name: 'ready',
value: req.body
};
_this.handleEvent(event);
});
this.embeds = [];
// TODO: Change when Object.assign is available.
this.config = utils.assign({}, Service.defaultConfig, config);
if (this.config.autoEmbedOnContentLoaded) {
this.enableAutoEmbed();
}
}
/**
* Creates new report
* @param {HTMLElement} element
* @param {embed.IEmbedConfiguration} [config={}]
* @returns {embed.Embed}
*/
Service.prototype.createReport = function (element, config) {
config.type = 'create';
var powerBiElement = element;
var component = new create_1.Create(this, powerBiElement, config);
powerBiElement.powerBiEmbed = component;
this.addOrOverwriteEmbed(component, element);
return component;
};
/**
* TODO: Add a description here
*
* @param {HTMLElement} [container]
* @param {embed.IEmbedConfiguration} [config=undefined]
* @returns {embed.Embed[]}
*/
Service.prototype.init = function (container, config) {
var _this = this;
if (config === void 0) { config = undefined; }
container = (container && container instanceof HTMLElement) ? container : document.body;
var elements = Array.prototype.slice.call(container.querySelectorAll("[" + embed.Embed.embedUrlAttribute + "]"));
return elements.map(function (element) { return _this.embed(element, config); });
};
/**
* Given a configuration based on an HTML element,
* if the component has already been created and attached to the element, reuses the component instance and existing iframe,
* otherwise creates a new component instance.
*
* @param {HTMLElement} element
* @param {embed.IEmbedConfigurationBase} [config={}]
* @returns {embed.Embed}
*/
Service.prototype.embed = function (element, config) {
if (config === void 0) { config = {}; }
return this.embedInternal(element, config);
};
/**
* Given a configuration based on an HTML element,
* if the component has already been created and attached to the element, reuses the component instance and existing iframe,
* otherwise creates a new component instance.
* This is used for the phased embedding API, once element is loaded successfully, one can call 'render' on it.
*
* @param {HTMLElement} element
* @param {embed.IEmbedConfigurationBase} [config={}]
* @returns {embed.Embed}
*/
Service.prototype.load = function (element, config) {
if (config === void 0) { config = {}; }
return this.embedInternal(element, config, /* phasedRender */ true, /* isBootstrap */ false);
};
/**
* Given an HTML element and entityType, creates a new component instance, and bootstrap the iframe for embedding.
*
* @param {HTMLElement} element
* @param {embed.IBootstrapEmbedConfiguration} config: a bootstrap config which is an embed config without access token.
*/
Service.prototype.bootstrap = function (element, config) {
return this.embedInternal(element, config, /* phasedRender */ false, /* isBootstrap */ true);
};
Service.prototype.embedInternal = function (element, config, phasedRender, isBootstrap) {
if (config === void 0) { config = {}; }
var component;
var powerBiElement = element;
if (powerBiElement.powerBiEmbed) {
if (isBootstrap) {
throw new Error("Attempted to bootstrap element " + element.outerHTML + ", but the element is already a powerbi element.");
}
component = this.embedExisting(powerBiElement, config, phasedRender);
}
else {
component = this.embedNew(powerBiElement, config, phasedRender, isBootstrap);
}
return component;
};
Service.prototype.getNumberOfComponents = function () {
if (!this.embeds) {
return 0;
}
return this.embeds.length;
};
Service.prototype.getSdkSessionId = function () {
return this.uniqueSessionId;
};
/**
* Given a configuration based on a Power BI element, saves the component instance that reference the element for later lookup.
*
* @private
* @param {IPowerBiElement} element
* @param {embed.IEmbedConfigurationBase} config
* @returns {embed.Embed}
*/
Service.prototype.embedNew = function (element, config, phasedRender, isBootstrap) {
var componentType = config.type || element.getAttribute(embed.Embed.typeAttribute);
if (!componentType) {
throw new Error("Attempted to embed using config " + JSON.stringify(config) + " on element " + element.outerHTML + ", but could not determine what type of component to embed. You must specify a type in the configuration or as an attribute such as '" + embed.Embed.typeAttribute + "=\"" + report_1.Report.type.toLowerCase() + "\"'.");
}
// Saves the type as part of the configuration so that it can be referenced later at a known location.
config.type = componentType;
var Component = utils.find(function (component) { return componentType === component.type.toLowerCase(); }, Service.components);
if (!Component) {
throw new Error("Attempted to embed component of type: " + componentType + " but did not find any matching component. Please verify the type you specified is intended.");
}
var component = new Component(this, element, config, phasedRender, isBootstrap);
element.powerBiEmbed = component;
this.addOrOverwriteEmbed(component, element);
return component;
};
/**
* Given an element that already contains an embed component, load with a new configuration.
*
* @private
* @param {IPowerBiElement} element
* @param {embed.IEmbedConfigurationBase} config
* @returns {embed.Embed}
*/
Service.prototype.embedExisting = function (element, config, phasedRender) {
var component = utils.find(function (x) { return x.element === element; }, this.embeds);
if (!component) {
throw new Error("Attempted to embed using config " + JSON.stringify(config) + " on element " + element.outerHTML + " which already has embedded comopnent associated, but could not find the existing comopnent in the list of active components. This could indicate the embeds list is out of sync with the DOM, or the component is referencing the incorrect HTML element.");
}
// TODO: Multiple embedding to the same iframe is not supported in QnA
if (config.type && config.type.toLowerCase() === "qna") {
return this.embedNew(element, config);
}
/**
* TODO: Dynamic embed type switching could be supported but there is work needed to prepare the service state and DOM cleanup.
* remove all event handlers from the DOM, then reset the element to initial state which removes iframe, and removes from list of embeds
* then we can call the embedNew function which would allow setting the proper embedUrl and construction of object based on the new type.
*/
if (typeof config.type === "string" && config.type !== component.config.type) {
/**
* When loading report after create we want to use existing Iframe to optimize load period
*/
if (config.type === "report" && component.config.type === "create") {
var report = new report_1.Report(this, element, config, /* phasedRender */ false, /* isBootstrap */ false, element.powerBiEmbed.iframe);
report.load(config);
element.powerBiEmbed = report;
this.addOrOverwriteEmbed(component, element);
return report;
}
throw new Error("Embedding on an existing element with a different type than the previous embed object is not supported. Attempted to embed using config " + JSON.stringify(config) + " on element " + element.outerHTML + ", but the existing element contains an embed of type: " + this.config.type + " which does not match the new type: " + config.type);
}
component.populateConfig(config, /* isBootstrap */ false);
component.load(component.config, phasedRender);
return component;
};
/**
* Adds an event handler for DOMContentLoaded, which searches the DOM for elements that have the 'powerbi-embed-url' attribute,
* and automatically attempts to embed a powerbi component based on information from other powerbi-* attributes.
*
* Note: Only runs if `config.autoEmbedOnContentLoaded` is true when the service is created.
* This handler is typically useful only for applications that are rendered on the server so that all required data is available when the handler is called.
*/
Service.prototype.enableAutoEmbed = function () {
var _this = this;
window.addEventListener('DOMContentLoaded', function (event) { return _this.init(document.body); }, false);
};
/**
* Returns an instance of the component associated with the element.
*
* @param {HTMLElement} element
* @returns {(Report | Tile)}
*/
Service.prototype.get = function (element) {
var powerBiElement = element;
if (!powerBiElement.powerBiEmbed) {
throw new Error("You attempted to get an instance of powerbi component associated with element: " + element.outerHTML + " but there was no associated instance.");
}
return powerBiElement.powerBiEmbed;
};
/**
* Finds an embed instance by the name or unique ID that is provided.
*
* @param {string} uniqueId
* @returns {(Report | Tile)}
*/
Service.prototype.find = function (uniqueId) {
return utils.find(function (x) { return x.config.uniqueId === uniqueId; }, this.embeds);
};
Service.prototype.addOrOverwriteEmbed = function (component, element) {
// remove embeds over the same div element.
this.embeds = this.embeds.filter(function (embed) {
return embed.element.id !== element.id;
});
this.embeds.push(component);
};
/**
* Given an HTML element that has a component embedded within it, removes the component from the list of embedded components, removes the association between the element and the component, and removes the iframe.
*
* @param {HTMLElement} element
* @returns {void}
*/
Service.prototype.reset = function (element) {
var powerBiElement = element;
if (!powerBiElement.powerBiEmbed) {
return;
}
/** Removes the element frontLoad listener if exists. */
var embedElement = powerBiElement.powerBiEmbed;
if (embedElement.frontLoadHandler) {
embedElement.element.removeEventListener('ready', embedElement.frontLoadHandler, false);
}
/** Removes the component from an internal list of components. */
utils.remove(function (x) { return x === powerBiElement.powerBiEmbed; }, this.embeds);
/** Deletes a property from the HTML element. */
delete powerBiElement.powerBiEmbed;
/** Removes the iframe from the element. */
var iframe = element.querySelector('iframe');
if (iframe) {
if (iframe.remove !== undefined) {
iframe.remove();
}
else {
/** Workaround for IE: unhandled rejection TypeError: object doesn't support propert or method 'remove' */
iframe.parentElement.removeChild(iframe);
}
}
};
/**
* handles tile events
*
* @param {IEvent<any>} event
*/
Service.prototype.handleTileEvents = function (event) {
if (event.type === 'tile') {
this.handleEvent(event);
}
};
/**
* Given an event object, finds the embed component with the matching type and ID, and invokes its handleEvent method with the event object.
*
* @private
* @param {IEvent<any>} event
*/
Service.prototype.handleEvent = function (event) {
var embed = utils.find(function (embed) {
return (embed.config.uniqueId === event.id);
}, this.embeds);
if (embed) {
var value = event.value;
if (event.name === 'pageChanged') {
var pageKey = 'newPage';
var page = value[pageKey];
if (!page) {
throw new Error("Page model not found at 'event.value." + pageKey + "'.");
}
value[pageKey] = new page_1.Page(embed, page.name, page.displayName, true /* isActive */);
}
utils.raiseCustomEvent(embed.element, event.name, value);
}
};
/**
* API for warm starting powerbi embedded endpoints.
* Use this API to preload Power BI Embedded in the background.
*
* @public
* @param {embed.IEmbedConfigurationBase} [config={}]
* @param {HTMLElement} [element=undefined]
*/
Service.prototype.preload = function (config, element) {
var iframeContent = document.createElement("iframe");
iframeContent.setAttribute("style", "display:none;");
iframeContent.setAttribute("src", config.embedUrl);
iframeContent.setAttribute("scrolling", "no");
iframeContent.setAttribute("allowfullscreen", "false");
var node = element;
if (!node) {
node = document.getElementsByTagName("body")[0];
}
node.appendChild(iframeContent);
iframeContent.onload = function () {
utils.raiseCustomEvent(iframeContent, "preloaded", {});
};
return iframeContent;
};
/**
* A list of components that this service can embed
*/
Service.components = [
tile_1.Tile,
report_1.Report,
dashboard_1.Dashboard,
qna_1.Qna,
visual_1.Visual
];
/**
* The default configuration for the service
*/
Service.defaultConfig = {
autoEmbedOnContentLoaded: false,
onError: function () {
var args = [];
for (var _i = 0; _i < arguments.length; _i++) {
args[_i - 0] = arguments[_i];
}
return console.log(args[0], args.slice(1));
}
};
return Service;
}());
exports.Service = Service;
/***/ }),
/* 2 */
/***/ (function(module, exports, __webpack_require__) {
var utils = __webpack_require__(3);
var sdkConfig = __webpack_require__(4);
var models = __webpack_require__(5);
/**
* Base class for all Power BI embed components
*
* @export
* @abstract
* @class Embed
*/
var Embed = (function () {
/**
* Creates an instance of Embed.
*
* Note: there is circular reference between embeds and the service, because
* the service has a list of all embeds on the host page, and each embed has a reference to the service that created it.
*
* @param {service.Service} service
* @param {HTMLElement} element
* @param {IEmbedConfigurationBase} config
*/
function Embed(service, element, config, iframe, phasedRender, isBootstrap) {
this.allowedEvents = [];
Array.prototype.push.apply(this.allowedEvents, Embed.allowedEvents);
this.eventHandlers = [];
this.service = service;
this.element = element;
this.iframe = iframe;
this.embeType = config.type.toLowerCase();
this.populateConfig(config, isBootstrap);
if (this.embeType === 'create') {
this.setIframe(false /*set EventListener to call create() on 'load' event*/, phasedRender, isBootstrap);
}
else {
this.setIframe(true /*set EventListener to call load() on 'load' event*/, phasedRender, isBootstrap);
}
}
/**
* Sends createReport configuration data.
*
* ```javascript
* createReport({
* datasetId: '5dac7a4a-4452-46b3-99f6-a25915e0fe55',
* accessToken: 'eyJ0eXA ... TaE2rTSbmg',
* ```
*
* @param {models.IReportCreateConfiguration} config
* @returns {Promise<void>}
*/
Embed.prototype.createReport = function (config) {
var errors = models.validateCreateReport(config);
if (errors) {
throw errors;
}
return this.service.hpm.post("/report/create", config, { uid: this.config.uniqueId, sdkSessionId: this.service.getSdkSessionId() }, this.iframe.contentWindow)
.then(function (response) {
return response.body;
}, function (response) {
throw response.body;
});
};
/**
* Saves Report.
*
* @returns {Promise<void>}
*/
Embed.prototype.save = function () {
return this.service.hpm.post('/report/save', null, { uid: this.config.uniqueId }, this.iframe.contentWindow)
.then(function (response) {
return response.body;
})
.catch(function (response) {
throw response.body;
});
};
/**
* SaveAs Report.
*
* @returns {Promise<void>}
*/
Embed.prototype.saveAs = function (saveAsParameters) {
return this.service.hpm.post('/report/saveAs', saveAsParameters, { uid: this.config.uniqueId }, this.iframe.contentWindow)
.then(function (response) {
return response.body;
})
.catch(function (response) {
throw response.body;
});
};
/**
* Sends load configuration data.
*
* ```javascript
* report.load({
* type: 'report',
* id: '5dac7a4a-4452-46b3-99f6-a25915e0fe55',
* accessToken: 'eyJ0eXA ... TaE2rTSbmg',
* settings: {
* navContentPaneEnabled: false
* },
* pageName: "DefaultPage",
* filters: [
* {
* ... DefaultReportFilter ...
* }
* ]
* })
* .catch(error => { ... });
* ```
*
* @param {models.ILoadConfiguration} config
* @param {boolean} phasedRender
* @returns {Promise<void>}
*/
Embed.prototype.load = function (config, phasedRender) {
var _this = this;
if (!config.accessToken) {
return;
}
var path = phasedRender && config.type === 'report' ? this.phasedLoadPath : this.loadPath;
var headers = {
uid: this.config.uniqueId,
sdkSessionId: this.service.getSdkSessionId(),
bootstrapped: this.config.bootstrapped,
sdkVersion: sdkConfig.default.version
};
return this.service.hpm.post(path, config, headers, this.iframe.contentWindow)
.then(function (response) {
utils.assign(_this.config, config);
return response.body;
}, function (response) {
throw response.body;
});
};
/**
* Removes one or more event handlers from the list of handlers.
* If a reference to the existing handle function is specified, remove the specific handler.
* If the handler is not specified, remove all handlers for the event name specified.
*
* ```javascript
* report.off('pageChanged')
*
* or
*
* const logHandler = function (event) {
* console.log(event);
* };
*
* report.off('pageChanged', logHandler);
* ```
*
* @template T
* @param {string} eventName
* @param {service.IEventHandler<T>} [handler]
*/
Embed.prototype.off = function (eventName, handler) {
var _this = this;
var fakeEvent = { name: eventName, type: null, id: null, value: null };
if (handler) {
utils.remove(function (eventHandler) { return eventHandler.test(fakeEvent) && (eventHandler.handle === handler); }, this.eventHandlers);
this.element.removeEventListener(eventName, handler);
}
else {
var eventHandlersToRemove = this.eventHandlers
.filter(function (eventHandler) { return eventHandler.test(fakeEvent); });
eventHandlersToRemove
.forEach(function (eventHandlerToRemove) {
utils.remove(function (eventHandler) { return eventHandler === eventHandlerToRemove; }, _this.eventHandlers);
_this.element.removeEventListener(eventName, eventHandlerToRemove.handle);
});
}
};
/**
* Adds an event handler for a specific event.
*
* ```javascript
* report.on('pageChanged', (event) => {
* console.log('PageChanged: ', event.page.name);
* });
* ```
*
* @template T
* @param {string} eventName
* @param {service.IEventHandler<T>} handler
*/
Embed.prototype.on = function (eventName, handler) {
if (this.allowedEvents.indexOf(eventName) === -1) {
throw new Error("eventName is must be one of " + this.allowedEvents + ". You passed: " + eventName);
}
this.eventHandlers.push({
test: function (event) { return event.name === eventName; },
handle: handler
});
this.element.addEventListener(eventName, handler);
};
/**
* Reloads embed using existing configuration.
* E.g. For reports this effectively clears all filters and makes the first page active which simulates resetting a report back to loaded state.
*
* ```javascript
* report.reload();
* ```
*/
Embed.prototype.reload = function () {
return this.load(this.config);
};
/**
* Set accessToken.
*
* @returns {Promise<void>}
*/
Embed.prototype.setAccessToken = function (accessToken) {
var _this = this;
var embedType = this.config.type;
embedType = (embedType === 'create' || embedType === 'visual' || embedType === 'qna') ? 'report' : embedType;
return this.service.hpm.post('/' + embedType + '/token', accessToken, { uid: this.config.uniqueId }, this.iframe.contentWindow)
.then(function (response) {
_this.config.accessToken = accessToken;
_this.element.setAttribute(Embed.accessTokenAttribute, accessToken);
_this.service.accessToken = accessToken;
return response.body;
})
.catch(function (response) {
throw response.body;
});
};
/**
* Gets an access token from the first available location: config, attribute, global.
*
* @private
* @param {string} globalAccessToken
* @returns {string}
*/
Embed.prototype.getAccessToken = function (globalAccessToken) {
var accessToken = this.config.accessToken || this.element.getAttribute(Embed.accessTokenAttribute) || globalAccessToken;
if (!accessToken) {
throw new Error("No access token was found for element. You must specify an access token directly on the element using attribute '" + Embed.accessTokenAttribute + "' or specify a global token at: powerbi.accessToken.");
}
return accessToken;
};
/**
* Populate config for create and load
*
* @param {IEmbedConfiguration}
* @returns {void}
*/
Embed.prototype.populateConfig = function (config, isBootstrap) {
if (this.bootstrapConfig) {
this.config = utils.assign({}, this.bootstrapConfig, config);
// reset bootstrapConfig because we do not want to merge it in re-embed scenario.
this.bootstrapConfig = null;
}
else {
// Copy config - important for multiple iframe scenario.
// Otherwise, if a user uses the same config twice, same unique Id which will be used in different iframes.
this.config = utils.assign({}, config);
}
this.config.embedUrl = this.getEmbedUrl(isBootstrap);
this.config.groupId = this.getGroupId();
this.addLocaleToEmbedUrl(config);
this.config.uniqueId = this.getUniqueId();
if (isBootstrap) {
// save current config in bootstrapConfig to be able to merge it on next call to powerbi.embed
this.bootstrapConfig = this.config;
this.bootstrapConfig.bootstrapped = true;
}
else {
this.config.accessToken = this.getAccessToken(this.service.accessToken);
}
this.configChanged(isBootstrap);
};
/**
* Adds locale parameters to embedUrl
*
* @private
* @param {IEmbedConfiguration} config
*/
Embed.prototype.addLocaleToEmbedUrl = function (config) {
if (!config.settings) {
return;
}
var 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.
*
* @private
* @returns {string}
*/
Embed.prototype.getEmbedUrl = function (isBootstrap) {
var embedUrl = this.config.embedUrl || this.element.getAttribute(Embed.embedUrlAttribute);
if (isBootstrap && !embedUrl) {
// Prepare flow, embed url was not provided, use hostname to build embed url.
embedUrl = this.getDefaultEmbedUrl(this.config.hostname);
}
if (typeof embedUrl !== 'string' || embedUrl.length === 0) {
throw new Error("Embed Url is required, but it was not found. You must provide an embed url either as part of embed configuration or as attribute '" + Embed.embedUrlAttribute + "'.");
}
return embedUrl;
};
Embed.prototype.getDefaultEmbedUrl = function (hostname) {
if (!hostname) {
hostname = Embed.defaultEmbedHostName;
}
var endpoint = this.getDefaultEmbedUrlEndpoint();
// Trim spaces to fix user mistakes.
hostname = hostname.toLowerCase().trim();
if (hostname.indexOf("http://") === 0) {
throw new Error("HTTP is not allowed. HTTPS is required");
}
if (hostname.indexOf("https://") === 0) {
return hostname + "/" + endpoint;
}
return "https://" + hostname + "/" + endpoint;
};
/**
* Gets a unique ID from the first available location: options, attribute.
* If neither is provided generate a unique string.
*
* @private
* @returns {string}
*/
Embed.prototype.getUniqueId = function () {
return this.config.uniqueId || this.element.getAttribute(Embed.nameAttribute) || utils.createRandomString();
};
/**
* Gets the group ID from the first available location: options, embeddedUrl.
*
* @private
* @returns {string}
*/
Embed.prototype.getGroupId = function () {
return this.config.groupId || Embed.findGroupIdFromEmbedUrl(this.config.embedUrl);
};
/**
* Requests the browser to render the component's iframe in fullscreen mode.
*/
Embed.prototype.fullscreen = function () {
var requestFullScreen = this.iframe.requestFullscreen || this.iframe.msRequestFullscreen || this.iframe.mozRequestFullScreen || this.iframe.webkitRequestFullscreen;
requestFullScreen.call(this.iframe);
};
/**
* Requests the browser to exit fullscreen mode.
*/
Embed.prototype.exitFullscreen = function () {
if (!this.isFullscreen(this.iframe)) {
return;
}
var exitFullscreen = document.exitFullscreen || document.mozCancelFullScreen || document.webkitExitFullscreen || document.msExitFullscreen;
exitFullscreen.call(document);
};
/**
* Returns true if the iframe is rendered in fullscreen mode,
* otherwise returns false.
*
* @private
* @param {HTMLIFrameElement} iframe
* @returns {boolean}
*/
Embed.prototype.isFullscreen = function (iframe) {
var options = ['fullscreenElement', 'webkitFullscreenElement', 'mozFullscreenScreenElement', 'msFullscreenElement'];
return options.some(function (option) { return document[option] === iframe; });
};
/**
* Sets Iframe for embed
*/
Embed.prototype.setIframe = function (isLoad, phasedRender, isBootstrap) {
var _this = this;
if (!this.iframe) {
var iframeContent = document.createElement("iframe");
var embedUrl = this.config.uniqueId ? utils.addParamToUrl(this.config.embedUrl, 'uid', this.config.uniqueId) : this.config.embedUrl;
iframeContent.style.width = '100%';
iframeContent.style.height = '100%';
iframeContent.setAttribute("src", embedUrl);
iframeContent.setAttribute("scrolling", "no");
iframeContent.setAttribute("allowfullscreen", "true");
var node = this.element;
while (node.firstChild) {
node.removeChild(node.firstChild);
}
node.appendChild(iframeContent);
this.iframe = node.firstChild;
}
if (isLoad) {
if (!isBootstrap) {
// Validate config if it's not a bootstrap case.
var errors = this.validate(this.config);
if (errors) {
throw errors;
}
}
this.iframe.addEventListener('load', function () { return _this.load(_this.config, phasedRender); }, false);
if (this.service.getNumberOfComponents() <= Embed.maxFrontLoadTimes) {
this.frontLoadHandler = function () { return _this.frontLoadSendConfig(_this.config); };
// 'ready' event is fired by the embedded element (not by the iframe)
this.element.addEventListener('ready', this.frontLoadHandler, false);
}
}
else {
this.iframe.addEventListener('load', function () { return _this.createReport(_this.createConfig); }, false);
}
};
/**
* Sets Iframe's title
*/
Embed.prototype.setComponentTitle = function (title) {
if (!this.iframe) {
return;
}
if (title == null) {
this.iframe.removeAttribute("title");
}
else {
this.iframe.setAttribute("title", title);
}
};
/**
* Sets element's tabindex attribute
*/
Embed.prototype.setComponentTabIndex = function (tabIndex) {
if (!this.element) {
return;
}
this.element.setAttribute("tabindex", (tabIndex == null) ? "0" : tabIndex.toString());
};
/**
* Removes element's tabindex attribute
*/
Embed.prototype.removeComponentTabIndex = function (tabIndex) {
if (!this.element) {
return;
}
this.element.removeAttribute("tabindex");
};
/**
* 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.
*
* @static
* @param {string} url
* @returns {string}
*/
Embed.findGroupIdFromEmbedUrl = function (url) {
var groupIdRegEx = /groupId="?([^&]+)"?/;
var groupIdMatch = url.match(groupIdRegEx);
var groupId;
if (groupIdMatch) {
groupId = groupIdMatch[1];
}
return groupId;
};
/**
* Sends the config for front load calls, after 'ready' message is received from the iframe
*/
Embed.prototype.frontLoadSendConfig = function (config) {
if (!config.accessToken) {
return;
}
var errors = this.validate(config);
if (errors) {
throw errors;
}
// contentWindow must be initialized
if (this.iframe.contentWindow == null)
return;
return this.service.hpm.post("/frontload/config", config, { uid: this.config.uniqueId }, this.iframe.contentWindow).then(function (response) {
return response.body;
}, function (response) {
throw response.body;
});
};
Embed.allowedEvents = ["loaded", "saved", "rendered", "saveAsTriggered", "error", "dataSelected", "buttonClicked"];
Embed.accessTokenAttribute = 'powerbi-access-token';
Embed.embedUrlAttribute = 'powerbi-embed-url';
Embed.nameAttribute = 'powerbi-name';
Embed.typeAttribute = 'powerbi-type';
Embed.defaultEmbedHostName = "https://app.powerbi.com";
Embed.maxFrontLoadTimes = 2;
return Embed;