FilesExpand file tree

 master

/

report.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

245 lines (227 loc) · 7.05 KB

 master

/

report.ts

Copy path

Top

File metadata and controls

• Code
• Blame

245 lines (227 loc) · 7.05 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

import * as service from './service';

import * as embed from './embed';

import * as models from 'powerbi-models';

import * as wpmp from 'window-post-message-proxy';

import * as hpm from 'http-post-message';

import * as utils from './util';

import { IFilterable } from './ifilterable';

import { IPageNode, Page } from './page';

/**

* A Report node within a report hierarchy

*

* @export

* @interface IReportNode

*/

export interface IReportNode {

iframe: HTMLIFrameElement;

service: service.IService;

config: embed.IInternalEmbedConfiguration

}

/**

* The Power BI Report embed component

*

* @export

* @class Report

* @extends {embed.Embed}

* @implements {IReportNode}

* @implements {IFilterable}

*/

export class Report extends embed.Embed implements IReportNode, IFilterable {

static allowedEvents = ["dataSelected", "filtersApplied", "pageChanged", "error"];

static reportIdAttribute = 'powerbi-report-id';

static filterPaneEnabledAttribute = 'powerbi-settings-filter-pane-enabled';

static navContentPaneEnabledAttribute = 'powerbi-settings-nav-content-pane-enabled';

static typeAttribute = 'powerbi-type';

static type = "Report";

/**

* Creates an instance of a Power BI Report.

*

* @param {service.Service} service

* @param {HTMLElement} element

* @param {embed.IEmbedConfiguration} config

*/

constructor(service: service.Service, element: HTMLElement, config: embed.IEmbedConfiguration) {

const filterPaneEnabled = (config.settings && config.settings.filterPaneEnabled) || !(element.getAttribute(Report.filterPaneEnabledAttribute) === "false");

const navContentPaneEnabled = (config.settings && config.settings.navContentPaneEnabled) || !(element.getAttribute(Report.navContentPaneEnabledAttribute) === "false");

const settings = utils.assign({

filterPaneEnabled,

navContentPaneEnabled

}, config.settings);

const configCopy = utils.assign({ settings }, config);

super(service, element, configCopy);

Array.prototype.push.apply(this.allowedEvents, Report.allowedEvents);

}

/**

* 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.

*

* @static

* @param {string} url

* @returns {string}

*/

static findIdFromEmbedUrl(url: string): string {

const reportIdRegEx = /reportId="?([^&]+)"?/

const reportIdMatch = url.match(reportIdRegEx);

let reportId;

if (reportIdMatch) {

reportId = reportIdMatch[1];

}

return reportId;

}

/**

* Gets filters that are applied at the report level.

*

* ```javascript

* // Get filters applied at report level

* report.getFilters()

* .then(filters => {

* ...

* });

* ```

*

* @returns {Promise<models.IFilter[]>}

*/

getFilters(): Promise<models.IFilter[]> {

return this.service.hpm.get<models.IFilter[]>(`/report/filters`, { uid: this.config.uniqueId }, this.iframe.contentWindow)

.then(response => response.body,

response => {

throw response.body;

});

}

/**

* Gets the report ID from the first available location: options, attribute, embed url.

*

* @returns {string}

*/

getId(): string {

const reportId = this.config.id || this.element.getAttribute(Report.reportIdAttribute) || Report.findIdFromEmbedUrl(this.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[]>}

*/

getPages(): Promise<Page[]> {

return this.service.hpm.get<models.IPage[]>('/report/pages', { uid: this.config.uniqueId }, this.iframe.contentWindow)

.then(response => {

return response.body

.map(page => {

return new Page(this, page.name, page.displayName);

});

}, 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.

*

* ```javascript

* const page = report.page('ReportSection1');

* page.setActive();

* ```

*

* @param {string} name

* @param {string} [displayName]

* @returns {Page}

*/

page(name: string, displayName?: string): Page {

return new Page(this, name, displayName);

}

/**

* Removes all filters at the report level.

*

* ```javascript

* report.removeFilters();

* ```

*

* @returns {Promise<void>}

*/

removeFilters(): Promise<void> {

return this.setFilters([]);

}

/**

* Sets the active page of the report.

*

* ```javascript

* report.setPage("page2")

* .catch(error => { ... });

* ```

*

* @param {string} pageName

* @returns {Promise<void>}

*/

setPage(pageName: string): Promise<void> {

const page: models.IPage = {

name: pageName,

displayName: null

};

return this.service.hpm.put<models.IError[]>('/report/pages/active', page, { uid: this.config.uniqueId }, this.iframe.contentWindow)

.catch(response => {

throw response.body;

});

}

/**

* Sets filters at the report level.

*

* ```javascript

* const filters: [

* ...

* ];

*

* report.setFilters(filters)

* .catch(errors => {

* ...

* });

* ```

*

* @param {(models.IFilter[])} filters

* @returns {Promise<void>}

*/

setFilters(filters: models.IFilter[]): Promise<void> {

return this.service.hpm.put<models.IError[]>(`/report/filters`, filters, { 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 = {

* navContentPaneEnabled: true,

* filterPaneEnabled: false

* };

*

* report.updateSettings(newSettings)

* .catch(error => { ... });

* ```

*

* @param {models.ISettings} settings

* @returns {Promise<void>}

*/

updateSettings(settings: models.ISettings): Promise<void> {

return this.service.hpm.patch<models.IError[]>('/report/settings', settings, { uid: this.config.uniqueId }, this.iframe.contentWindow)

.catch(response => {

throw response.body;

});

}

}