forked from microsoft/PowerBI-JavaScript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpage.ts
More file actions
127 lines (118 loc) · 2.89 KB
/
page.ts
File metadata and controls
127 lines (118 loc) · 2.89 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
import { IFilterable } from './ifilterable';
import { IReportNode } from './report';
import * as models from 'powerbi-models';
/**
* A Page node within a report hierarchy
*
* @export
* @interface IPageNode
*/
export interface IPageNode {
report: IReportNode;
name: string;
}
/**
* A Power BI report page
*
* @export
* @class Page
* @implements {IPageNode}
* @implements {IFilterable}
*/
export class Page implements IPageNode, IFilterable {
/**
* The parent Power BI report that this page is a member of
*
* @type {IReportNode}
*/
report: IReportNode;
/**
* The report page name
*
* @type {string}
*/
name: string;
/**
* The user defined display name of the report page, which is undefined if the page is created manually
*
* @type {string}
*/
displayName: string;
/**
* Creates an instance of a Power BI report page.
*
* @param {IReportNode} report
* @param {string} name
* @param {string} [displayName]
*/
constructor(report: IReportNode, name: string, displayName?: string) {
this.report = report;
this.name = name;
this.displayName = displayName;
}
/**
* Gets all page level filters within the report.
*
* ```javascript
* page.getFilters()
* .then(pages => { ... });
* ```
*
* @returns {(Promise<models.IFilter[]>)}
*/
getFilters(): Promise<models.IFilter[]> {
return this.report.service.hpm.get<models.IFilter[]>(`/report/pages/${this.name}/filters`, { uid: this.report.config.uniqueId }, this.report.iframe.contentWindow)
.then(response => response.body,
response => {
throw response.body;
});
}
/**
* Removes all filters from this page of the report.
*
* ```javascript
* page.removeFilters();
* ```
*
* @returns {Promise<void>}
*/
removeFilters(): Promise<void> {
return this.setFilters([]);
}
/**
* Makes the current page the active page of the report.
*
* ```javascripot
* page.setActive();
* ```
*
* @returns {Promise<void>}
*/
setActive(): Promise<void> {
const page: models.IPage = {
name: this.name,
displayName: null
};
return this.report.service.hpm.put<models.IError[]>('/report/pages/active', page, { uid: this.report.config.uniqueId }, this.report.iframe.contentWindow)
.catch(response => {
throw response.body;
});
}
/**
* Sets all filters on the current page.
*
* ```javascript
* page.setFilters(filters);
* .catch(errors => { ... });
* ```
*
* @param {(models.IFilter[])} filters
* @returns {Promise<void>}
*/
setFilters(filters: models.IFilter[]): Promise<void> {
return this.report.service.hpm.put<models.IError[]>(`/report/pages/${this.name}/filters`, filters, { uid: this.report.config.uniqueId }, this.report.iframe.contentWindow)
.catch(response => {
throw response.body;
});
}
}