Skip to content
Navigation Menu
{{ message }}
forked from microsoft/PowerBI-JavaScript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathembed.ts
More file actions
530 lines (473 loc) · 14.7 KB
/
Copy pathembed.ts
File metadata and controls
530 lines (473 loc) · 14.7 KB
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
import * as utils from './util';
import * as service from './service';
import * as models from 'powerbi-models';
import * as hpm from 'http-post-message';
declare global {
interface Document {
// Mozilla Fullscreen
mozCancelFullScreen: Function;
// Ms Fullscreen
msExitFullscreen: Function;
}
interface HTMLIFrameElement {
// Mozilla Fullscreen
mozRequestFullScreen: Function;
// Ms Fullscreen
msRequestFullscreen: Function;
}
}
/**
* Base Configuration settings for Power BI embed components
*
* @export
* @interface IEmbedConfigurationBase
*/
export interface IEmbedConfigurationBase {
settings?: ISettings;
embedUrl?: string;
uniqueId?: string;
type?: string;
accessToken?: string;
tokenType?: models.TokenType;
}
// TODO: Re-use ILoadConfiguration interface to prevent duplicating properties.
// Current issue is that they are optional when embedding since they can be specificed as attributes but they are required when loading.
/**
* Configuration settings for Power BI embed components
*
* @export
* @interface IEmbedConfiguration
*/
export interface IEmbedConfiguration extends IEmbedConfigurationBase {
id?: string;
settings?: IEmbedSettings;
pageName?: string;
filters?: models.IFilter[];
pageView?: models.PageView;
datasetId?: string;
permissions?: models.Permissions;
viewMode?: models.ViewMode;
action?: string;
dashboardId?: string;
height?: number;
width?: number;
}
/**
* Configuration settings for Power BI QNA embed component
*
* @export
* @interface IEmbedConfiguration
*/
export interface IQnaEmbedConfiguration extends IEmbedConfigurationBase {
datasetIds: string[];
question?: string;
viewMode?: models.QnaMode;
}
export interface ILocaleSettings {
language?: string;
formatLocale?: string;
}
export interface ISettings {
localeSettings?: ILocaleSettings;
}
export interface IEmbedSettings extends models.ISettings, ISettings {
}
export interface IQnaSettings extends models.IQnaSettings, ISettings {
}
export interface IInternalEventHandler<T> {
test(event: service.IEvent<T>): boolean;
handle(event: service.ICustomEvent<T>): void;
}
/**
* Base class for all Power BI embed components
*
* @export
* @abstract
* @class Embed
*/
export abstract class Embed {
static allowedEvents = ["loaded", "saved", "rendered", "saveAsTriggered", "error", "dataSelected"];
static accessTokenAttribute = 'powerbi-access-token';
static embedUrlAttribute = 'powerbi-embed-url';
static nameAttribute = 'powerbi-name';
static typeAttribute = 'powerbi-type';
static type: string;
allowedEvents = [];
/**
* Gets or sets the event handler registered for this embed component.
*
* @type {IInternalEventHandler<any>[]}
*/
eventHandlers: IInternalEventHandler<any>[];
/**
* Gets or sets the Power BI embed service.
*
* @type {service.Service}
*/
service: service.Service;
/**
* Gets or sets the HTML element that contains the Power BI embed component.
*
* @type {HTMLElement}
*/
element: HTMLElement;
/**
* Gets or sets the HTML iframe element that renders the Power BI embed component.
*
* @type {HTMLIFrameElement}
*/
iframe: HTMLIFrameElement;
/**
* Gets or sets the configuration settings for the Power BI embed component.
*
* @type {IEmbedConfigurationBase}
*/
config: IEmbedConfigurationBase;
/**
* Gets or sets the configuration settings for creating report.
*
* @type {models.IReportCreateConfiguration}
*/
createConfig: models.IReportCreateConfiguration;
/**
* Url used in the load request.
*/
loadPath: string;
/**
* Type of embed
*/
embeType: string;
/**
* 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
*/
constructor(service: service.Service, element: HTMLElement, config: IEmbedConfigurationBase, iframe?: HTMLIFrameElement) {
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);
if(this.embeType === 'create'){
this.setIframe(false/*set EventListener to call create() on 'load' event*/);
} else {
this.setIframe(true/*set EventListener to call load() on 'load' event*/);
}
}
/**
* Sends createReport configuration data.
*
* ```javascript
* createReport({
* datasetId: '5dac7a4a-4452-46b3-99f6-a25915e0fe55',
* accessToken: 'eyJ0eXA ... TaE2rTSbmg',
* ```
*
* @param {models.IReportCreateConfiguration} config
* @returns {Promise<void>}
*/
createReport(config: models.IReportCreateConfiguration): Promise<void> {
const errors = models.validateCreateReport(config);
if (errors) {
throw errors;
}
return this.service.hpm.post<void>("/report/create", config, { uid: this.config.uniqueId }, this.iframe.contentWindow)
.then(response => {
return response.body;
},
response => {
throw response.body;
});
}
/**
* Saves Report.
*
* @returns {Promise<void>}
*/
save(): Promise<void> {
return this.service.hpm.post<models.IError[]>('/report/save', null, { uid: this.config.uniqueId }, this.iframe.contentWindow)
.then(response => {
return response.body;
})
.catch(response => {
throw response.body;
});
}
/**
* SaveAs Report.
*
* @returns {Promise<void>}
*/
saveAs(saveAsParameters: models.ISaveAsParameters): Promise<void> {
return this.service.hpm.post<models.IError[]>('/report/saveAs', saveAsParameters, { uid: this.config.uniqueId }, this.iframe.contentWindow)
.then(response => {
return response.body;
})
.catch(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
* @returns {Promise<void>}
*/
load(config: IEmbedConfigurationBase): Promise<void> {
const errors = this.validate(config);
if (errors) {
throw errors;
}
return this.service.hpm.post<void>(this.loadPath, config, { uid: this.config.uniqueId }, this.iframe.contentWindow)
.then(response => {
utils.assign(this.config, config);
return response.body;
},
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]
*/
off<T>(eventName: string, handler?: service.IEventHandler<T>): void {
const fakeEvent: service.IEvent<any> = { name: eventName, type: null, id: null, value: null };
if (handler) {
utils.remove(eventHandler => eventHandler.test(fakeEvent) && (eventHandler.handle === handler), this.eventHandlers);
this.element.removeEventListener(eventName, <any>handler);
}
else {
const eventHandlersToRemove = this.eventHandlers
.filter(eventHandler => eventHandler.test(fakeEvent));
eventHandlersToRemove
.forEach(eventHandlerToRemove => {
utils.remove(eventHandler => eventHandler === eventHandlerToRemove, this.eventHandlers);
this.element.removeEventListener(eventName, <any>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
*/
on<T>(eventName: string, handler: service.IEventHandler<T>): void {
if (this.allowedEvents.indexOf(eventName) === -1) {
throw new Error(`eventName is must be one of ${this.allowedEvents}. You passed: ${eventName}`);
}
this.eventHandlers.push({
test: (event: service.IEvent<T>) => event.name === eventName,
handle: handler
});
this.element.addEventListener(eventName, <any>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();
* ```
*/
reload(): Promise<void> {
return this.load(this.config);
}
/**
* Set accessToken.
*
* @returns {Promise<void>}
*/
setAccessToken(accessToken: string): Promise<void> {
return this.service.hpm.post<models.IError[]>('/report/token', accessToken, { uid: this.config.uniqueId }, this.iframe.contentWindow)
.then(response => {
return response.body;
})
.catch(response => {
throw response.body;
});
}
/**
* Gets an access token from the first available location: config, attribute, global.
*
* @private
* @param {string} globalAccessToken
* @returns {string}
*/
private getAccessToken(globalAccessToken: string): string {
const 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}
*/
populateConfig(config: IEmbedConfigurationBase): void {
this.config = config;
// TODO: Change when Object.assign is available.
this.config.uniqueId = this.getUniqueId();
this.config.embedUrl = this.getEmbedUrl();
this.config.accessToken = this.getAccessToken(this.service.accessToken);
this.addLocaleToEmbedUrl(config);
}
/**
* 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.
*
* @private
* @returns {string}
*/
private getEmbedUrl(): string {
const embedUrl = this.config.embedUrl || this.element.getAttribute(Embed.embedUrlAttribute);
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;
}
/**
* Gets a unique ID from the first available location: options, attribute.
* If neither is provided generate a unique string.
*
* @private
* @returns {string}
*/
private getUniqueId(): string {
return this.config.uniqueId || this.element.getAttribute(Embed.nameAttribute) || utils.createRandomString();
}
/**
* Gets the report ID from the first available location: options, attribute.
*
* @abstract
* @returns {string}
*/
abstract getId(): string;
/**
* Requests the browser to render the component's iframe in fullscreen mode.
*/
fullscreen(): void {
const requestFullScreen = this.iframe.requestFullscreen || this.iframe.msRequestFullscreen || this.iframe.mozRequestFullScreen || this.iframe.webkitRequestFullscreen;
requestFullScreen.call(this.iframe);
}
/**
* Requests the browser to exit fullscreen mode.
*/
exitFullscreen(): void {
if (!this.isFullscreen(this.iframe)) {
return;
}
const 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}
*/
private isFullscreen(iframe: HTMLIFrameElement): boolean {
const options = ['fullscreenElement', 'webkitFullscreenElement', 'mozFullscreenScreenElement', 'msFullscreenElement'];
return options.some(option => document[option] === iframe);
}
/**
* Validate load and create configuration.
*/
abstract validate(config: IEmbedConfigurationBase): models.IError[];
/**
* Sets Iframe for embed
*/
private setIframe(isLoad: boolean): void {
if(!this.iframe) {
var iframeContent = document.createElement("iframe");
var embedUrl = this.config.embedUrl;
iframeContent.setAttribute("style", "width:100%;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 = <HTMLIFrameElement>node.firstChild;
}
if(isLoad){
this.iframe.addEventListener('load', () => this.load(this.config), false);
} else {
this.iframe.addEventListener('load', () => this.createReport(this.createConfig), false);
}
}
}
You can’t perform that action at this time.