FilesExpand file tree

 master

/

bookmarksManager.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

162 lines (146 loc) · 4.64 KB

 master

/

bookmarksManager.ts

Copy path

Top

File metadata and controls

• Code
• Blame

162 lines (146 loc) · 4.64 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

/**

* @hidden

*/

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 * as errors from './errors';

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

import { Defaults } from './defaults';

import { IReportLoadConfiguration } from 'powerbi-models';

/**

* Report bookmarks management APIs.

*

* @export

* @interface IBookmarksManager

*/

export interface IBookmarksManager {

getBookmarks(): Promise<models.IReportBookmark[]>;

apply(bookmarkName: string): Promise<void>;

play(playMode: models.BookmarksPlayMode): Promise<void>;

capture(): Promise<models.IReportBookmark>;

applyState(state: string): Promise<void>;

}

/**

* Manages report bookmarks.

*

* @export

* @class BookmarksManager

* @implements {IBookmarksManager}

*/

export class BookmarksManager implements IBookmarksManager {

/**

* @hidden

*/

constructor(private service: service.Service, private config: embed.IEmbedConfigurationBase, private iframe?: HTMLIFrameElement) {

}

/**

* Gets bookmarks that are defined in the report.

*

* ```javascript

* // Gets bookmarks that are defined in the report

* bookmarksManager.getBookmarks()

* .then(bookmarks => {

* ...

* });

* ```

*

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

*/

getBookmarks(): Promise<models.IReportBookmark[]> {

if (utils.isRDLEmbed(this.config.embedUrl)) {

return Promise.reject(errors.APINotSupportedForRDLError);

}

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

.then(response => response.body,

response => {

throw response.body;

});

}

/**

* Apply bookmark by name.

*

* ```javascript

* bookmarksManager.apply(bookmarkName)

* ```

*

* @returns {Promise<void>}

*/

apply(bookmarkName: string): Promise<void> {

if (utils.isRDLEmbed(this.config.embedUrl)) {

return Promise.reject(errors.APINotSupportedForRDLError);

}

var request: models.IApplyBookmarkByNameRequest = {

name: bookmarkName

};

return this.service.hpm.post<models.IError[]>(`/report/bookmarks/applyByName`, request, { uid: this.config.uniqueId }, this.iframe.contentWindow)

.catch(response => {

throw response.body;

});

}

/**

* Play bookmarks: Enter or Exit bookmarks presentation mode.

*

* ```javascript

* // Enter presentation mode.

* bookmarksManager.play(true)

* ```

*

* @returns {Promise<void>}

*/

play(playMode: models.BookmarksPlayMode): Promise<void> {

if (utils.isRDLEmbed(this.config.embedUrl)) {

return Promise.reject(errors.APINotSupportedForRDLError);

}

var playBookmarkRequest: models.IPlayBookmarkRequest = {

playMode: playMode

};

return this.service.hpm.post<models.IError[]>(`/report/bookmarks/play`, playBookmarkRequest, { uid: this.config.uniqueId }, this.iframe.contentWindow)

.catch(response => {

throw response.body;

});

}

/**

* Capture bookmark from current state.

*

* ```javascript

* bookmarksManager.capture()

* ```

*

* @returns {Promise<models.IReportBookmark>}

*/

capture(): Promise<models.IReportBookmark> {

if (utils.isRDLEmbed(this.config.embedUrl)) {

return Promise.reject(errors.APINotSupportedForRDLError);

}

return this.service.hpm.post<models.IReportBookmark>(`/report/bookmarks/capture`, null, { uid: this.config.uniqueId }, this.iframe.contentWindow)

.then(response => response.body,

response => {

throw response.body;

});

}

/**

* Apply bookmark state.

*

* ```javascript

* bookmarksManager.applyState(bookmarkState)

* ```

*

* @returns {Promise<void>}

*/

applyState(state: string): Promise<void> {

if (utils.isRDLEmbed(this.config.embedUrl)) {

return Promise.reject(errors.APINotSupportedForRDLError);

}

var request: models.IApplyBookmarkStateRequest = {

state: state

};

return this.service.hpm.post<models.IError[]>(`/report/bookmarks/applyState`, request, { uid: this.config.uniqueId }, this.iframe.contentWindow)

.catch(response => {

throw response.body;

});

}

}