forked from microsoft/PowerBI-JavaScript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathreport.ts
More file actions
1243 lines (1135 loc) · 36.4 KB
/
report.ts
File metadata and controls
1243 lines (1135 loc) · 36.4 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
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
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
import {
IReportLoadConfiguration,
IReportEmbedConfiguration,
IPage,
FiltersOperations,
IError,
IFilter,
IReportTheme,
ISettings,
IUpdateFiltersRequest,
LayoutType,
SectionVisibility,
validateReportLoad,
validatePaginatedReportLoad,
ViewMode,
IEmbedConfiguration,
IEmbedConfigurationBase,
CommonErrorCodes,
ReportLevelFilters,
MenuLocation,
ICommandExtension,
IExtensions,
IFlatMenuExtension,
IGroupedMenuExtension,
IExtension,
IVisualLayout,
ICustomPageSize,
PageSizeType,
VisualContainerDisplayMode
} from 'powerbi-models';
import { IHttpPostMessageResponse } from 'http-post-message';
import { IService, Service } from './service';
import { Embed, IEmbedSettings } from './embed';
import { addParamToUrl, assign, isRDLEmbed, isSavedInternal } from './util';
import { APINotSupportedForRDLError } from './errors';
import { IFilterable } from './ifilterable';
import { Page } from './page';
import { BookmarksManager } from './bookmarksManager';
import { VisualDescriptor } from './visualDescriptor';
/**
* A Report node within a report hierarchy
*
* @export
* @interface IReportNode
*/
export interface IReportNode {
iframe: HTMLIFrameElement;
service: IService;
config: IEmbedConfiguration | IReportEmbedConfiguration;
}
/**
* The Power BI Report embed component
*
* @export
* @class Report
* @extends {Embed}
* @implements {IReportNode}
* @implements {IFilterable}
*/
export class Report extends Embed implements IReportNode, IFilterable {
/** @hidden */
static allowedEvents = ["filtersApplied", "pageChanged", "commandTriggered", "swipeStart", "swipeEnd", "bookmarkApplied", "dataHyperlinkClicked", "visualRendered", "visualClicked", "selectionChanged", "renderingStarted", "blur"];
/** @hidden */
static reportIdAttribute = 'powerbi-report-id';
/** @hidden */
static filterPaneEnabledAttribute = 'powerbi-settings-filter-pane-enabled';
/** @hidden */
static navContentPaneEnabledAttribute = 'powerbi-settings-nav-content-pane-enabled';
/** @hidden */
static typeAttribute = 'powerbi-type';
/** @hidden */
static type = "Report";
public bookmarksManager: BookmarksManager;
/**
* Creates an instance of a Power BI Report.
*
* @param {Service} service
* @param {HTMLElement} element
* @param {IEmbedConfiguration} config
* @hidden
*/
constructor(service: Service, element: HTMLElement, baseConfig: IEmbedConfigurationBase, phasedRender?: boolean, isBootstrap?: boolean, iframe?: HTMLIFrameElement) {
const config = baseConfig as IReportEmbedConfiguration;
super(service, element, config, iframe, phasedRender, isBootstrap);
this.loadPath = "/report/load";
this.phasedLoadPath = "/report/prepare";
Array.prototype.push.apply(this.allowedEvents, Report.allowedEvents);
this.bookmarksManager = new BookmarksManager(service, config, this.iframe);
service.router.post(`/reports/${this.config.uniqueId}/eventHooks/:eventName`, async (req, _res) => {
switch (req.params.eventName) {
case "preQuery":
req.body = req.body || {};
req.body.report = this;
await service.invokeSDKHook(this.eventHooks?.applicationContextProvider, req, _res);
break;
case "newAccessToken":
req.body = req.body || {};
req.body.report = this;
await service.invokeSDKHook(this.eventHooks?.accessTokenProvider, req, _res);
break;
default:
break;
}
});
}
/**
* Adds backwards compatibility for the previous load configuration, which used the reportId query parameter to specify the report ID
* (e.g. http://embedded.powerbi.com/appTokenReportEmbed?reportId=854846ed-2106-4dc2-bc58-eb77533bf2f1).
*
* By extracting the ID we can ensure that the ID is always explicitly provided as part of the load configuration.
*
* @hidden
* @static
* @param {string} url
* @returns {string}
*/
static findIdFromEmbedUrl(url: string): string {
const reportIdRegEx = /reportId="?([^&]+)"?/;
const reportIdMatch = url.match(reportIdRegEx);
let reportId: string;
if (reportIdMatch) {
reportId = reportIdMatch[1];
}
return reportId;
}
/**
* Render a preloaded report, using phased embedding API
*
* ```javascript
* // Load report
* var report = powerbi.load(element, config);
*
* ...
*
* // Render report
* report.render()
* ```
*
* @returns {Promise<void>}
*/
async render(config?: IReportLoadConfiguration | IReportEmbedConfiguration): Promise<void> {
try {
const response = await this.service.hpm.post<void>(`/report/render`, config, { uid: this.config.uniqueId }, this.iframe.contentWindow);
return response.body;
} catch (response) {
throw response.body;
}
}
/**
* Add an empty page to the report
*
* ```javascript
* // Add a page to the report with "Sales" as the page display name
* report.addPage("Sales");
* ```
*
* @returns {Promise<Page>}
*/
async addPage(displayName?: string): Promise<Page> {
const request = {
displayName: displayName
};
try {
const response = await this.service.hpm.post<IPage>(`/report/addPage`, request, { uid: this.config.uniqueId }, this.iframe.contentWindow);
const page = response.body;
return new Page(this, page.name, page.displayName, page.isActive, page.visibility, page.defaultSize, page.defaultDisplayOption);
} catch (response) {
throw response.body;
}
}
/**
* Delete a page from a report
*
* ```javascript
* // Delete a page from a report by pageName (PageName is different than the display name and can be acquired from the getPages API)
* report.deletePage("ReportSection145");
* ```
*
* @returns {Promise<void>}
*/
async deletePage(pageName: string): Promise<void> {
try {
const response = await this.service.hpm.delete<void>(`/report/pages/${pageName}`, {}, { uid: this.config.uniqueId }, this.iframe.contentWindow);
return response.body;
} catch (response) {
throw response.body;
}
}
/**
* Rename a page from a report
*
* ```javascript
* // Rename a page from a report by changing displayName (pageName is different from the display name and can be acquired from the getPages API)
* report.renamePage("ReportSection145", "Sales");
* ```
*
* @returns {Promise<void>}
*/
async renamePage(pageName: string, displayName: string): Promise<void> {
const page: IPage = {
name: pageName,
displayName: displayName,
};
try {
const response = await this.service.hpm.put<void>(`/report/pages/${pageName}/name`, page, { uid: this.config.uniqueId }, this.iframe.contentWindow);
return response.body;
} catch (response) {
throw response.body;
}
}
/**
* Gets filters that are applied at the report level.
*
* ```javascript
* // Get filters applied at report level
* report.getFilters()
* .then(filters => {
* ...
* });
* ```
*
* @returns {Promise<IFilter[]>}
*/
async getFilters(): Promise<IFilter[]> {
if (isRDLEmbed(this.config.embedUrl)) {
return Promise.reject(APINotSupportedForRDLError);
}
try {
const response = await this.service.hpm.get<IFilter[]>(`/report/filters`, { uid: this.config.uniqueId }, this.iframe.contentWindow);
return response.body;
} catch (response) {
throw response.body;
}
}
/**
* Update the filters at the report level according to the operation: Add, replace all, replace by target or remove.
*
* ```javascript
* report.updateFilters(FiltersOperations.Add, filters)
* .catch(errors => { ... });
* ```
*
* @param {(IFilter[])} filters
* @returns {Promise<IHttpPostMessageResponse<void>>}
*/
async updateFilters(operation: FiltersOperations, filters?: IFilter[]): Promise<IHttpPostMessageResponse<void>> {
const updateFiltersRequest: IUpdateFiltersRequest = {
filtersOperation: operation,
filters: filters as ReportLevelFilters[]
};
try {
return await this.service.hpm.post<void>(`/report/filters`, updateFiltersRequest, { uid: this.config.uniqueId }, this.iframe.contentWindow);
} catch (response) {
throw response.body;
}
}
/**
* Removes all filters at the report level.
*
* ```javascript
* report.removeFilters();
* ```
*
* @returns {Promise<IHttpPostMessageResponse<void>>}
*/
async removeFilters(): Promise<IHttpPostMessageResponse<void>> {
if (isRDLEmbed(this.config.embedUrl)) {
return Promise.reject(APINotSupportedForRDLError);
}
return this.updateFilters(FiltersOperations.RemoveAll);
}
/**
* Sets filters at the report level.
*
* ```javascript
* const filters: [
* ...
* ];
*
* report.setFilters(filters)
* .catch(errors => {
* ...
* });
* ```
*
* @param {(IFilter[])} filters
* @returns {Promise<IHttpPostMessageResponse<void>>}
*/
async setFilters(filters: IFilter[]): Promise<IHttpPostMessageResponse<void>> {
if (isRDLEmbed(this.config.embedUrl)) {
return Promise.reject(APINotSupportedForRDLError);
}
try {
return await this.service.hpm.put<void>(`/report/filters`, filters, { uid: this.config.uniqueId }, this.iframe.contentWindow);
} catch (response) {
throw response.body;
}
}
/**
* Gets the report ID from the first available location: options, attribute, embed url.
*
* @returns {string}
*/
getId(): string {
const config = this.config as IReportEmbedConfiguration;
const reportId = config.id || this.element.getAttribute(Report.reportIdAttribute) || Report.findIdFromEmbedUrl(config.embedUrl);
if (typeof reportId !== 'string' || reportId.length === 0) {
throw new Error(`Report id is required, but it was not found. You must provide an id either as part of embed configuration or as attribute '${Report.reportIdAttribute}'.`);
}
return reportId;
}
/**
* Gets the list of pages within the report.
*
* ```javascript
* report.getPages()
* .then(pages => {
* ...
* });
* ```
*
* @returns {Promise<Page[]>}
*/
async getPages(): Promise<Page[]> {
if (isRDLEmbed(this.config.embedUrl)) {
return Promise.reject(APINotSupportedForRDLError);
}
try {
const response = await this.service.hpm.get<IPage[]>('/report/pages', { uid: this.config.uniqueId }, this.iframe.contentWindow);
return response.body
.map((page) => new Page(this, page.name, page.displayName, page.isActive, page.visibility, page.defaultSize, page.defaultDisplayOption, page.mobileSize, page.background, page.wallpaper));
} catch (response) {
throw response.body;
}
}
/**
* Gets a report page by its name.
*
* ```javascript
* report.getPageByName(pageName)
* .then(page => {
* ...
* });
* ```
*
* @param {string} pageName
* @returns {Promise<Page>}
*/
async getPageByName(pageName: string): Promise<Page> {
if (isRDLEmbed(this.config.embedUrl)) {
return Promise.reject(APINotSupportedForRDLError);
}
try {
const response = await this.service.hpm.get<IPage[]>(`/report/pages`, { uid: this.config.uniqueId }, this.iframe.contentWindow);
const page = response.body.find((p: IPage) => p.name === pageName);
if (!page) {
return Promise.reject(CommonErrorCodes.NotFound);
}
return new Page(
this,
page.name,
page.displayName,
page.isActive,
page.visibility,
page.defaultSize,
page.defaultDisplayOption,
page.mobileSize,
page.background,
page.wallpaper,
);
} catch (response) {
throw response.body;
}
}
/**
* Gets the active report page.
*
* ```javascript
* report.getActivePage()
* .then(activePage => {
* ...
* });
* ```
*
* @returns {Promise<Page>}
*/
async getActivePage(): Promise<Page> {
if (isRDLEmbed(this.config.embedUrl)) {
return Promise.reject(APINotSupportedForRDLError);
}
try {
const response = await this.service.hpm.get<IPage[]>('/report/pages', { uid: this.config.uniqueId }, this.iframe.contentWindow);
const activePage = response.body.find((page: IPage) => page.isActive);
return new Page(
this,
activePage.name,
activePage.displayName,
activePage.isActive,
activePage.visibility,
activePage.defaultSize,
activePage.defaultDisplayOption,
activePage.mobileSize,
activePage.background,
activePage.wallpaper,
);
} catch (response) {
throw response.body;
}
}
/**
* Creates an instance of a Page.
*
* Normally you would get Page objects by calling `report.getPages()`, but in the case
* that the page name is known and you want to perform an action on a page without having to retrieve it
* you can create it directly.
*
* Note: Because you are creating the page manually there is no guarantee that the page actually exists in the report, and subsequent requests could fail.
*
* @param {string} name
* @param {string} [displayName]
* @param {boolean} [isActive]
* @returns {Page}
* @hidden
*/
page(name: string, displayName?: string, isActive?: boolean, visibility?: SectionVisibility): Page {
return new Page(this, name, displayName, isActive, visibility);
}
/**
* Prints the active page of the report by invoking `window.print()` on the embed iframe component.
*/
async print(): Promise<void> {
if (isRDLEmbed(this.config.embedUrl)) {
return Promise.reject(APINotSupportedForRDLError);
}
try {
const response = await this.service.hpm.post<void>('/report/print', null, { uid: this.config.uniqueId }, this.iframe.contentWindow);
return response.body;
} catch (response) {
throw response.body;
}
}
/**
* Sets the active page of the report.
*
* ```javascript
* report.setPage("page2")
* .catch(error => { ... });
* ```
*
* @param {string} pageName
* @returns {Promise<IHttpPostMessageResponse<void>>}
*/
async setPage(pageName: string): Promise<IHttpPostMessageResponse<void>> {
if (isRDLEmbed(this.config.embedUrl)) {
return Promise.reject(APINotSupportedForRDLError);
}
const page: IPage = {
name: pageName,
displayName: null,
isActive: true
};
try {
return await this.service.hpm.put<void>('/report/pages/active', page, { uid: this.config.uniqueId }, this.iframe.contentWindow);
} catch (response) {
throw response.body;
}
}
/**
* Updates visibility settings for the filter pane and the page navigation pane.
*
* ```javascript
* const newSettings = {
* panes: {
* filters: {
* visible: false
* }
* }
* };
*
* report.updateSettings(newSettings)
* .catch(error => { ... });
* ```
*
* @param {ISettings} settings
* @returns {Promise<IHttpPostMessageResponse<void>>}
*/
async updateSettings(settings: ISettings): Promise<IHttpPostMessageResponse<void>> {
if (isRDLEmbed(this.config.embedUrl) && settings.customLayout != null) {
return Promise.reject(APINotSupportedForRDLError);
}
try {
const response = await this.service.hpm.patch<void>('/report/settings', settings, { uid: this.config.uniqueId }, this.iframe.contentWindow);
// Update commands if provided
const extension = settings?.extensions as IExtensions;
this.commands = extension?.commands ?? this.commands;
this.groups = extension?.groups ?? this.groups;
// Adding commands in extensions array to this.commands
const extensionsArray = settings?.extensions as IExtension[];
if (Array.isArray(extensionsArray)) {
this.commands = [];
extensionsArray.map((extensionElement: IExtension) => { if (extensionElement?.command) { this.commands.push(extensionElement.command); } });
}
return response;
} catch (response) {
throw response.body;
}
}
/**
* Validate load configuration.
*
* @hidden
*/
validate(config: IEmbedConfigurationBase): IError[] {
if (isRDLEmbed(this.config.embedUrl)) {
return validatePaginatedReportLoad(config);
}
return validateReportLoad(config);
}
/**
* Handle config changes.
*
* @returns {void}
*/
configChanged(isBootstrap: boolean): void {
const config = this.config as IReportEmbedConfiguration;
if (this.isMobileSettings(config.settings)) {
config.embedUrl = addParamToUrl(config.embedUrl, "isMobile", "true");
}
// Calculate settings from HTML element attributes if available.
const filterPaneEnabledAttribute = this.element.getAttribute(Report.filterPaneEnabledAttribute);
const navContentPaneEnabledAttribute = this.element.getAttribute(Report.navContentPaneEnabledAttribute);
const elementAttrSettings: IEmbedSettings = {
filterPaneEnabled: (filterPaneEnabledAttribute == null) ? undefined : (filterPaneEnabledAttribute !== "false"),
navContentPaneEnabled: (navContentPaneEnabledAttribute == null) ? undefined : (navContentPaneEnabledAttribute !== "false")
};
// Set the settings back into the config.
this.config.settings = assign({}, elementAttrSettings, config.settings) as ISettings;
if (isBootstrap) {
return;
}
config.id = this.getId();
}
/**
* @hidden
* @returns {string}
*/
getDefaultEmbedUrlEndpoint(): string {
return "reportEmbed";
}
/**
* Switch Report view mode.
*
* @returns {Promise<void>}
*/
async switchMode(viewMode: ViewMode | string): Promise<void> {
let newMode: string;
if (typeof viewMode === "string") {
newMode = viewMode;
}
else {
newMode = this.viewModeToString(viewMode);
}
const url = '/report/switchMode/' + newMode;
try {
const response = await this.service.hpm.post<void>(url, null, { uid: this.config.uniqueId }, this.iframe.contentWindow);
return response.body;
} catch (response) {
throw response.body;
}
}
/**
* Refreshes data sources for the report.
*
* ```javascript
* report.refresh();
* ```
*/
async refresh(): Promise<void> {
if (isRDLEmbed(this.config.embedUrl)) {
return Promise.reject(APINotSupportedForRDLError);
}
try {
const response = await this.service.hpm.post<void>('/report/refresh', null, { uid: this.config.uniqueId }, this.iframe.contentWindow);
return response.body;
} catch (response) {
throw response.body;
}
}
/**
* checks if the report is saved.
*
* ```javascript
* report.isSaved()
* ```
*
* @returns {Promise<boolean>}
*/
async isSaved(): Promise<boolean> {
if (isRDLEmbed(this.config.embedUrl)) {
return Promise.reject(APINotSupportedForRDLError);
}
return await isSavedInternal(this.service.hpm, this.config.uniqueId, this.iframe.contentWindow);
}
/**
* Apply a theme to the report
*
* ```javascript
* report.applyTheme(theme);
* ```
*/
async applyTheme(theme: IReportTheme): Promise<void> {
if (isRDLEmbed(this.config.embedUrl)) {
return Promise.reject(APINotSupportedForRDLError);
}
return await this.applyThemeInternal(theme);
}
/**
* Reset and apply the default theme of the report
*
* ```javascript
* report.resetTheme();
* ```
*/
async resetTheme(): Promise<void> {
if (isRDLEmbed(this.config.embedUrl)) {
return Promise.reject(APINotSupportedForRDLError);
}
return await this.applyThemeInternal(<IReportTheme>{});
}
/**
* get the theme of the report
*
* ```javascript
* report.getTheme();
* ```
*/
async getTheme(): Promise<IReportTheme> {
if (isRDLEmbed(this.config.embedUrl)) {
return Promise.reject(APINotSupportedForRDLError);
}
try {
const response = await this.service.hpm.get<IReportTheme>(`/report/theme`, { uid: this.config.uniqueId }, this.iframe.contentWindow);
return response.body;
} catch (response) {
throw response.body;
}
}
/**
* Reset user's filters, slicers, and other data view changes to the default state of the report
*
* ```javascript
* report.resetPersistentFilters();
* ```
*/
async resetPersistentFilters(): Promise<IHttpPostMessageResponse<void>> {
try {
return await this.service.hpm.delete<void>(`/report/userState`, null, { uid: this.config.uniqueId }, this.iframe.contentWindow);
} catch (response) {
throw response.body;
}
}
/**
* Save user's filters, slicers, and other data view changes of the report
*
* ```javascript
* report.savePersistentFilters();
* ```
*/
async savePersistentFilters(): Promise<IHttpPostMessageResponse<void>> {
try {
return await this.service.hpm.post<void>(`/report/userState`, null, { uid: this.config.uniqueId }, this.iframe.contentWindow);
} catch (response) {
throw response.body;
}
}
/**
* Returns if there are user's filters, slicers, or other data view changes applied on the report.
* If persistent filters is disable, returns false.
*
* ```javascript
* report.arePersistentFiltersApplied();
* ```
*
* @returns {Promise<boolean>}
*/
async arePersistentFiltersApplied(): Promise<boolean> {
try {
const response = await this.service.hpm.get<boolean>(`/report/isUserStateApplied`, { uid: this.config.uniqueId }, this.iframe.contentWindow);
return response.body;
} catch (response) {
throw response.body;
}
}
/**
* Remove context menu extension command.
*
* ```javascript
* report.removeContextMenuCommand(commandName, contextMenuTitle)
* .catch(error => {
* ...
* });
* ```
*
* @param {string} commandName
* @param {string} contextMenuTitle
* @returns {Promise<IHttpPostMessageResponse<void>>}
*/
async removeContextMenuCommand(commandName: string, contextMenuTitle: string): Promise<IHttpPostMessageResponse<void>> {
if (isRDLEmbed(this.config.embedUrl)) {
return Promise.reject(APINotSupportedForRDLError);
}
const commandCopy = JSON.parse(JSON.stringify(this.commands)) as ICommandExtension[];
const indexOfCommand: number = this.findCommandMenuIndex("visualContextMenu", commandCopy, commandName, contextMenuTitle);
if (indexOfCommand === -1) {
throw CommonErrorCodes.NotFound;
}
// Delete the context menu and not the entire command, since command can have option menu as well.
delete commandCopy[indexOfCommand].extend.visualContextMenu;
const newSetting: ISettings = {
extensions: {
commands: commandCopy,
groups: this.groups
}
};
return await this.updateSettings(newSetting);
}
/**
* Add context menu extension command.
*
* ```javascript
* report.addContextMenuCommand(commandName, commandTitle, contextMenuTitle, menuLocation, visualName, visualType, groupName)
* .catch(error => {
* ...
* });
* ```
*
* @param {string} commandName
* @param {string} commandTitle
* @param {string} contextMenuTitle
* @param {MenuLocation} menuLocation
* @param {string} visualName
* @param {string} visualType
* @param {string} groupName
* @returns {Promise<IHttpPostMessageResponse<void>>}
*/
async addContextMenuCommand(commandName: string, commandTitle: string, contextMenuTitle: string = commandTitle, menuLocation: MenuLocation = MenuLocation.Bottom, visualName: string = undefined, visualType: string, groupName: string = undefined): Promise<IHttpPostMessageResponse<void>> {
if (isRDLEmbed(this.config.embedUrl)) {
return Promise.reject(APINotSupportedForRDLError);
}
const newCommands: ICommandExtension[] = this.createMenuCommand("visualContextMenu", commandName, commandTitle, contextMenuTitle, menuLocation, visualName, visualType, groupName);
const newSetting: ISettings = {
extensions: {
commands: newCommands,
groups: this.groups
}
};
return await this.updateSettings(newSetting);
}
/**
* Remove options menu extension command.
*
* ```javascript
* report.removeOptionsMenuCommand(commandName, optionsMenuTitle)
* .then({
* ...
* });
* ```
*
* @param {string} commandName
* @param {string} optionsMenuTitle
* @returns {Promise<IHttpPostMessageResponse<void>>}
*/
async removeOptionsMenuCommand(commandName: string, optionsMenuTitle: string): Promise<IHttpPostMessageResponse<void>> {
if (isRDLEmbed(this.config.embedUrl)) {
return Promise.reject(APINotSupportedForRDLError);
}
const commandCopy = JSON.parse(JSON.stringify(this.commands)) as ICommandExtension[];
const indexOfCommand: number = this.findCommandMenuIndex("visualOptionsMenu", commandCopy, commandName, optionsMenuTitle);
if (indexOfCommand === -1) {
throw CommonErrorCodes.NotFound;
}
// Delete the context options and not the entire command, since command can have context menu as well.
delete commandCopy[indexOfCommand].extend.visualOptionsMenu;
delete commandCopy[indexOfCommand].icon;
const newSetting: ISettings = {
extensions: {
commands: commandCopy,
groups: this.groups
}
};
return await this.updateSettings(newSetting);
}
/**
* Add options menu extension command.
*
* ```javascript
* report.addOptionsMenuCommand(commandName, commandTitle, optionsMenuTitle, menuLocation, visualName, visualType, groupName, commandIcon)
* .catch(error => {
* ...
* });
* ```
*
* @param {string} commandName
* @param {string} commandTitle
* @param {string} optionMenuTitle
* @param {MenuLocation} menuLocation
* @param {string} visualName
* @param {string} visualType
* @param {string} groupName
* @param {string} commandIcon
* @returns {Promise<IHttpPostMessageResponse<void>>}
*/
async addOptionsMenuCommand(commandName: string, commandTitle: string, optionsMenuTitle: string = commandTitle, menuLocation: MenuLocation = MenuLocation.Bottom, visualName: string = undefined, visualType: string = undefined, groupName: string = undefined, commandIcon: string = undefined): Promise<IHttpPostMessageResponse<void>> {
if (isRDLEmbed(this.config.embedUrl)) {
return Promise.reject(APINotSupportedForRDLError);
}
const newCommands: ICommandExtension[] = this.createMenuCommand("visualOptionsMenu", commandName, commandTitle, optionsMenuTitle, menuLocation, visualName, visualType, groupName, commandIcon);
const newSetting: ISettings = {
extensions: {
commands: newCommands,
groups: this.groups
}
};
return await this.updateSettings(newSetting);
}
/**
* Updates the display state of a visual in a page.
*
* ```javascript
* report.setVisualDisplayState(pageName, visualName, displayState)
* .catch(error => { ... });
* ```
*
* @param {string} pageName
* @param {string} visualName
* @param {VisualContainerDisplayMode} displayState
* @returns {Promise<IHttpPostMessageResponse<void>>}
*/
async setVisualDisplayState(pageName: string, visualName: string, displayState: VisualContainerDisplayMode): Promise<IHttpPostMessageResponse<void>> {
// Check if page name and visual name are valid
await this.validateVisual(pageName, visualName);
const visualLayout: IVisualLayout = {
displayState: {
mode: displayState
}
};
// Get new Settings object with updated visual layout
const newSettings = this.buildLayoutSettingsObject(pageName, visualName, visualLayout);
return this.updateSettings(newSettings);
}
/**
* Resize a visual in a page.
*
* ```javascript
* report.resizeVisual(pageName, visualName, width, height)
* .catch(error => { ... });
* ```
*
* @param {string} pageName
* @param {string} visualName
* @param {number} width
* @param {number} height
* @returns {Promise<IHttpPostMessageResponse<void>>}
*/
async resizeVisual(pageName: string, visualName: string, width: number, height: number): Promise<IHttpPostMessageResponse<void>> {
// Check if page name and visual name are valid
await this.validateVisual(pageName, visualName);
const visualLayout: IVisualLayout = {
width: width,
height: height,
};
// Get new Settings object with updated visual layout
const newSettings = this.buildLayoutSettingsObject(pageName, visualName, visualLayout);
return this.updateSettings(newSettings);
}
/**
* Updates the size of active page in report.
*
* ```javascript
* report.resizeActivePage(pageSizeType, width, height)
* .catch(error => { ... });
* ```
*
* @param {PageSizeType} pageSizeType
* @param {number} width
* @param {number} height
* @returns {Promise<IHttpPostMessageResponse<void>>}
*/
async resizeActivePage(pageSizeType: PageSizeType, width?: number, height?: number): Promise<IHttpPostMessageResponse<void>> {
const pageSize: ICustomPageSize = {
type: pageSizeType,
width: width,
height: height
};
// Create new settings object with custom layout type
const newSettings: ISettings = {
layoutType: LayoutType.Custom,
customLayout: {
pageSize: pageSize
}
};
return this.updateSettings(newSettings);
}
/**
* Updates the position of a visual in a page.
*
* ```javascript
* report.moveVisual(pageName, visualName, x, y, z)
* .catch(error => { ... });