This repository was archived by the owner on Jul 13, 2022. It is now read-only.
forked from microsoft/PowerBI-JavaScript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathvisual.ts
More file actions
299 lines (271 loc) · 8.55 KB
/
visual.ts
File metadata and controls
299 lines (271 loc) · 8.55 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
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
import {
DisplayOption,
FiltersLevel,
FiltersOperations,
ICustomPageSize,
IEmbedConfigurationBase,
IError,
IFilter,
IReportEmbedConfiguration,
IReportLoadConfiguration,
IUpdateFiltersRequest,
IVisual,
IVisualEmbedConfiguration,
LayoutType,
PageLevelFilters,
PageSizeType,
PagesLayout,
ReportLevelFilters,
VisualContainerDisplayMode,
VisualLevelFilters
} from 'powerbi-models';
import { IHttpPostMessageResponse } from 'http-post-message';
import { Service } from './service';
import { Report } from './report';
import { Page } from './page';
import { VisualDescriptor } from './visualDescriptor';
/**
* The Power BI Visual embed component
*
* @export
* @class Visual
*/
export class Visual extends Report {
/** @hidden */
static type = "visual";
/** @hidden */
static GetPagesNotSupportedError = "Get pages is not supported while embedding a visual.";
/** @hidden */
static SetPageNotSupportedError = "Set page is not supported while embedding a visual.";
/** @hidden */
static RenderNotSupportedError = "render is not supported while embedding a visual.";
/**
* Creates an instance of a Power BI Single Visual.
*
* @param {Service} service
* @param {HTMLElement} element
* @param {IEmbedConfiguration} config
* @hidden
*/
constructor(service: Service, element: HTMLElement, baseConfig: IEmbedConfigurationBase, phasedRender?: boolean, isBootstrap?: boolean, iframe?: HTMLIFrameElement) {
super(service, element, baseConfig, phasedRender, isBootstrap, iframe);
}
/**
* @hidden
*/
load(phasedRender?: boolean): Promise<void> {
const config = this.config as IVisualEmbedConfiguration;
if (!config.accessToken) {
// bootstrap flow.
return;
}
if (typeof config.pageName !== 'string' || config.pageName.length === 0) {
throw new Error(`Page name is required when embedding a visual.`);
}
if (typeof config.visualName !== 'string' || config.visualName.length === 0) {
throw new Error(`Visual name is required, but it was not found. You must provide a visual name as part of embed configuration.`);
}
// calculate custom layout settings and override config.
const width = config.width ? config.width : this.iframe.offsetWidth;
const height = config.height ? config.height : this.iframe.offsetHeight;
const pageSize: ICustomPageSize = {
type: PageSizeType.Custom,
width: width,
height: height,
};
const pagesLayout: PagesLayout = {};
pagesLayout[config.pageName] = {
defaultLayout: {
displayState: {
mode: VisualContainerDisplayMode.Hidden
}
},
visualsLayout: {}
};
pagesLayout[config.pageName].visualsLayout[config.visualName] = {
displayState: {
mode: VisualContainerDisplayMode.Visible
},
x: 1,
y: 1,
z: 1,
width: pageSize.width,
height: pageSize.height
};
config.settings = config.settings || {};
config.settings.filterPaneEnabled = false;
config.settings.navContentPaneEnabled = false;
config.settings.layoutType = LayoutType.Custom;
config.settings.customLayout = {
displayOption: DisplayOption.FitToPage,
pageSize: pageSize,
pagesLayout: pagesLayout
};
this.config = config;
return super.load(phasedRender);
}
/**
* Gets the list of pages within the report - not supported in visual
*
* @returns {Promise<Page[]>}
*/
getPages(): Promise<Page[]> {
throw Visual.GetPagesNotSupportedError;
}
/**
* Sets the active page of the report - not supported in visual
*
* @param {string} pageName
* @returns {Promise<IHttpPostMessageResponse<void>>}
*/
setPage(_pageName: string): Promise<IHttpPostMessageResponse<void>> {
throw Visual.SetPageNotSupportedError;
}
/**
* Render a preloaded report, using phased embedding API
*
* @hidden
* @returns {Promise<void>}
*/
async render(_config?: IReportLoadConfiguration | IReportEmbedConfiguration): Promise<void> {
throw Visual.RenderNotSupportedError;
}
/**
* Gets the embedded visual descriptor object that contains the visual name, type, etc.
*
* ```javascript
* visual.getVisualDescriptor()
* .then(visualDetails => { ... });
* ```
*
* @returns {Promise<VisualDescriptor>}
*/
async getVisualDescriptor(): Promise<VisualDescriptor> {
const config = this.config as IVisualEmbedConfiguration;
try {
const response = await this.service.hpm.get<IVisual[]>(`/report/pages/${config.pageName}/visuals`, { uid: this.config.uniqueId }, this.iframe.contentWindow);
// Find the embedded visual from visuals of this page
// TODO: Use the Array.find method when ES6 is available
const embeddedVisuals = response.body.filter((pageVisual) => pageVisual.name === config.visualName);
if (embeddedVisuals.length === 0) {
const visualNotFoundError: IError = {
message: "visualNotFound",
detailedMessage: "Visual not found"
};
throw visualNotFoundError;
}
const embeddedVisual = embeddedVisuals[0];
const currentPage = this.page(config.pageName);
return new VisualDescriptor(currentPage, embeddedVisual.name, embeddedVisual.title, embeddedVisual.type, embeddedVisual.layout);
} catch (response) {
throw response.body;
}
}
/**
* Gets filters that are applied to the filter level.
* Default filter level is visual level.
*
* ```javascript
* visual.getFilters(filtersLevel)
* .then(filters => {
* ...
* });
* ```
*
* @returns {Promise<IFilter[]>}
*/
async getFilters(filtersLevel?: FiltersLevel): Promise<IFilter[]> {
const url: string = this.getFiltersLevelUrl(filtersLevel);
try {
const response = await this.service.hpm.get<IFilter[]>(url, { uid: this.config.uniqueId }, this.iframe.contentWindow);
return response.body;
} catch (response) {
throw response.body;
}
}
/**
* Updates filters at the filter level.
* Default filter level is visual level.
*
* ```javascript
* const filters: [
* ...
* ];
*
* visual.updateFilters(FiltersOperations.Add, filters, filtersLevel)
* .catch(errors => {
* ...
* });
* ```
*
* @param {(IFilter[])} filters
* @returns {Promise<IHttpPostMessageResponse<void>>}
*/
async updateFilters(operation: FiltersOperations, filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>> {
const updateFiltersRequest: IUpdateFiltersRequest = {
filtersOperation: operation,
filters: filters as VisualLevelFilters[] | PageLevelFilters[] | ReportLevelFilters[]
};
const url: string = this.getFiltersLevelUrl(filtersLevel);
try {
return await this.service.hpm.post<void>(url, updateFiltersRequest, { uid: this.config.uniqueId }, this.iframe.contentWindow);
} catch (response) {
throw response.body;
}
}
/**
* Sets filters at the filter level.
* Default filter level is visual level.
*
* ```javascript
* const filters: [
* ...
* ];
*
* visual.setFilters(filters, filtersLevel)
* .catch(errors => {
* ...
* });
* ```
*
* @param {(IFilter[])} filters
* @returns {Promise<IHttpPostMessageResponse<void>>}
*/
async setFilters(filters: IFilter[], filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>> {
const url: string = this.getFiltersLevelUrl(filtersLevel);
try {
return await this.service.hpm.put<void>(url, filters, { uid: this.config.uniqueId }, this.iframe.contentWindow);
} catch (response) {
throw response.body;
}
}
/**
* Removes all filters from the current filter level.
* Default filter level is visual level.
*
* ```javascript
* visual.removeFilters(filtersLevel);
* ```
*
* @returns {Promise<IHttpPostMessageResponse<void>>}
*/
async removeFilters(filtersLevel?: FiltersLevel): Promise<IHttpPostMessageResponse<void>> {
return await this.updateFilters(FiltersOperations.RemoveAll, undefined, filtersLevel);
}
/**
* @hidden
*/
private getFiltersLevelUrl(filtersLevel: FiltersLevel): string {
const config = this.config as IVisualEmbedConfiguration;
switch (filtersLevel) {
case FiltersLevel.Report:
return `/report/filters`;
case FiltersLevel.Page:
return `/report/pages/${config.pageName}/filters`;
default:
return `/report/pages/${config.pageName}/visuals/${config.visualName}/filters`;
}
}
}