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
118 lines (108 loc) · 2.57 KB
/
Copy pathvisualDescriptor.ts
File metadata and controls
118 lines (108 loc) · 2.57 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
import * as models from 'powerbi-models';
import { IFilterable } from './ifilterable';
import { IPageNode, Page } from './page';
/**
* A Visual node within a report hierarchy
*
* @export
* @interface IVisualNode
*/
export interface IVisualNode {
name: string;
title: string;
type: string;
layout: models.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 visiblity.
*
* @type {string}
*/
layout: models.IVisualLayout;
/**
* The parent Power BI page that contains this visual
*
* @type {IPageNode}
*/
page: IPageNode;
constructor(page: IPageNode, name: string, title: string, type: string, layout: models.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<models.IFilter[]>)}
*/
getFilters(): Promise<models.IFilter[]> {
return this.page.report.service.hpm.get<models.IFilter[]>(`/report/pages/${this.page.name}/visuals/${this.name}/filters`, { uid: this.page.report.config.uniqueId }, this.page.report.iframe.contentWindow)
.then(response => response.body,
response => {
throw response.body;
});
}
/**
* Removes all filters from the current visual.
*
* ```javascript
* visual.removeFilters();
* ```
*
* @returns {Promise<void>}
*/
removeFilters(): Promise<void> {
return this.setFilters([]);
}
/**
* Sets the filters on the current visual to 'filters'.
*
* ```javascript
* visual.setFilters(filters);
* .catch(errors => { ... });
* ```
*
* @param {(models.IFilter[])} filters
* @returns {Promise<void>}
*/
setFilters(filters: models.IFilter[]): Promise<void> {
return this.page.report.service.hpm.put<models.IError[]>(`/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;
});
}
}