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 pathvisualDescriptor.ts
More file actions
341 lines (316 loc) · 9.42 KB
/
Copy pathvisualDescriptor.ts
File metadata and controls
341 lines (316 loc) · 9.42 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
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
import {
ExportDataType,
FiltersOperations,
ICloneVisualRequest,
ICloneVisualResponse,
IExportDataRequest,
IExportDataResult,
IFilter,
ISlicerState,
ISmartNarratives,
ISortByVisualRequest,
IUpdateFiltersRequest,
IVisualLayout,
VisualContainerDisplayMode,
VisualLevelFilters,
} from 'powerbi-models';
import { IHttpPostMessageResponse } from 'http-post-message';
import { IFilterable } from './ifilterable';
import { IPageNode } from './page';
import { Report } from './report';
/**
* A Visual node within a report hierarchy
*
* @export
* @interface IVisualNode
*/
export interface IVisualNode {
name: string;
title: string;
type: string;
layout: IVisualLayout;
page: IPageNode;
}
/**
* A Power BI visual within a page
*
* @export
* @class VisualDescriptor
* @implements {IVisualNode}
*/
export class VisualDescriptor implements IVisualNode, IFilterable {
/**
* The visual name
*
* @type {string}
*/
name: string;
/**
* The visual title
*
* @type {string}
*/
title: string;
/**
* The visual type
*
* @type {string}
*/
type: string;
/**
* The visual layout: position, size and visibility.
*
* @type {string}
*/
layout: IVisualLayout;
/**
* The parent Power BI page that contains this visual
*
* @type {IPageNode}
*/
page: IPageNode;
/**
* @hidden
*/
constructor(page: IPageNode, name: string, title: string, type: string, layout: IVisualLayout) {
this.name = name;
this.title = title;
this.type = type;
this.layout = layout;
this.page = page;
}
/**
* Gets all visual level filters of the current visual.
*
* ```javascript
* visual.getFilters()
* .then(filters => { ... });
* ```
*
* @returns {(Promise<IFilter[]>)}
*/
async getFilters(): Promise<IFilter[]> {
try {
const response = await this.page.report.service.hpm.get<IFilter[]>(`/report/pages/${this.page.name}/visuals/${this.name}/filters`, { uid: this.page.report.config.uniqueId }, this.page.report.iframe.contentWindow);
return response.body;
} catch (response) {
throw response.body;
}
}
/**
* Update the filters for the current visual according to the operation: Add, replace all, replace by target or remove.
*
* ```javascript
* visual.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 VisualLevelFilters[]
};
try {
return await this.page.report.service.hpm.post<void>(`/report/pages/${this.page.name}/visuals/${this.name}/filters`, updateFiltersRequest, { uid: this.page.report.config.uniqueId }, this.page.report.iframe.contentWindow);
} catch (response) {
throw response.body;
}
}
/**
* Removes all filters from the current visual.
*
* ```javascript
* visual.removeFilters();
* ```
*
* @returns {Promise<IHttpPostMessageResponse<void>>}
*/
async removeFilters(): Promise<IHttpPostMessageResponse<void>> {
return await this.updateFilters(FiltersOperations.RemoveAll);
}
/**
* Sets the filters on the current visual to 'filters'.
*
* ```javascript
* visual.setFilters(filters);
* .catch(errors => { ... });
* ```
*
* @param {(IFilter[])} filters
* @returns {Promise<IHttpPostMessageResponse<void>>}
*/
async setFilters(filters: IFilter[]): Promise<IHttpPostMessageResponse<void>> {
try {
return await this.page.report.service.hpm.put<void>(`/report/pages/${this.page.name}/visuals/${this.name}/filters`, filters, { uid: this.page.report.config.uniqueId }, this.page.report.iframe.contentWindow);
} catch (response) {
throw response.body;
}
}
/**
* Exports Visual data.
* Can export up to 30K rows.
*
* @param rows: Optional. Default value is 30K, maximum value is 30K as well.
* @param exportDataType: Optional. Default is ExportDataType.Summarized.
* ```javascript
* visual.exportData()
* .then(data => { ... });
* ```
*
* @returns {(Promise<IExportDataResult>)}
*/
async exportData(exportDataType?: ExportDataType, rows?: number): Promise<IExportDataResult> {
const exportDataRequestBody: IExportDataRequest = {
rows: rows,
exportDataType: exportDataType
};
try {
const response = await this.page.report.service.hpm.post<IExportDataResult>(`/report/pages/${this.page.name}/visuals/${this.name}/exportData`, exportDataRequestBody, { uid: this.page.report.config.uniqueId }, this.page.report.iframe.contentWindow);
return response.body;
} catch (response) {
throw response.body;
}
}
/**
* Set slicer state.
* Works only for visuals of type slicer.
*
* @param state: A new state which contains the slicer filters.
* ```javascript
* visual.setSlicerState()
* .then(() => { ... });
* ```
*/
async setSlicerState(state: ISlicerState): Promise<IHttpPostMessageResponse<void>> {
try {
return await this.page.report.service.hpm.put<void>(`/report/pages/${this.page.name}/visuals/${this.name}/slicer`, state, { uid: this.page.report.config.uniqueId }, this.page.report.iframe.contentWindow);
} catch (response) {
throw response.body;
}
}
/**
* Get slicer state.
* Works only for visuals of type slicer.
*
* ```javascript
* visual.getSlicerState()
* .then(state => { ... });
* ```
*
* @returns {(Promise<ISlicerState>)}
*/
async getSlicerState(): Promise<ISlicerState> {
try {
const response = await this.page.report.service.hpm.get<ISlicerState>(`/report/pages/${this.page.name}/visuals/${this.name}/slicer`, { uid: this.page.report.config.uniqueId }, this.page.report.iframe.contentWindow);
return response.body;
} catch (response) {
throw response.body;
}
}
/**
* Clone existing visual to a new instance.
*
* @returns {(Promise<ICloneVisualResponse>)}
*/
async clone(request: ICloneVisualRequest = {}): Promise<ICloneVisualResponse> {
try {
const response = await this.page.report.service.hpm.post<ICloneVisualResponse>(`/report/pages/${this.page.name}/visuals/${this.name}/clone`, request, { uid: this.page.report.config.uniqueId }, this.page.report.iframe.contentWindow);
return response.body;
} catch (response) {
throw response.body;
}
}
/**
* Sort a visual by dataField and direction.
*
* @param request: Sort by visual request.
*
* ```javascript
* visual.sortBy(request)
* .then(() => { ... });
* ```
*/
async sortBy(request: ISortByVisualRequest): Promise<IHttpPostMessageResponse<void>> {
try {
return await this.page.report.service.hpm.put<void>(`/report/pages/${this.page.name}/visuals/${this.name}/sortBy`, request, { uid: this.page.report.config.uniqueId }, this.page.report.iframe.contentWindow);
} catch (response) {
throw response.body;
}
}
/**
* Updates the position of a visual.
*
* ```javascript
* visual.moveVisual(x, y, z)
* .catch(error => { ... });
* ```
*
* @param {number} x
* @param {number} y
* @param {number} z
* @returns {Promise<IHttpPostMessageResponse<void>>}
*/
async moveVisual(x: number, y: number, z?: number): Promise<IHttpPostMessageResponse<void>> {
const pageName = this.page.name;
const visualName = this.name;
const report = this.page.report as Report;
return report.moveVisual(pageName, visualName, x, y, z);
}
/**
* Updates the display state of a visual.
*
* ```javascript
* visual.setVisualDisplayState(displayState)
* .catch(error => { ... });
* ```
*
* @param {VisualContainerDisplayMode} displayState
* @returns {Promise<IHttpPostMessageResponse<void>>}
*/
async setVisualDisplayState(displayState: VisualContainerDisplayMode): Promise<IHttpPostMessageResponse<void>> {
const pageName = this.page.name;
const visualName = this.name;
const report = this.page.report as Report;
return report.setVisualDisplayState(pageName, visualName, displayState);
}
/**
* Resize a visual.
*
* ```javascript
* visual.resizeVisual(width, height)
* .catch(error => { ... });
* ```
*
* @param {number} width
* @param {number} height
* @returns {Promise<IHttpPostMessageResponse<void>>}
*/
async resizeVisual(width: number, height: number): Promise<IHttpPostMessageResponse<void>> {
const pageName = this.page.name;
const visualName = this.name;
const report = this.page.report as Report;
return report.resizeVisual(pageName, visualName, width, height);
}
/**
* Get insights for single visual
*
* ```javascript
* visual.getSmartNarrativeInsights();
* ```
*
* @returns {Promise<ISmartNarratives>}
*/
async getSmartNarrativeInsights(): Promise<ISmartNarratives> {
try {
const response = await this.page.report.service.hpm.get<ISmartNarratives>(`/report/pages/${this.page.name}/visuals/${this.name}/smartNarrativeInsights`, { uid: this.page.report.config.uniqueId }, this.page.report.iframe.contentWindow);
return response.body;
} catch (response) {
throw response.body;
}
}
}
You can’t perform that action at this time.