FilesExpand file tree

 master

/

visual.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

176 lines (159 loc) · 5.16 KB

 master

/

visual.ts

Copy path

Top

File metadata and controls

• Code
• Blame

176 lines (159 loc) · 5.16 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

import * as service from './service';

import * as embed from './embed';

import * as models from 'powerbi-models';

import { Report } from './report'

import { Page } from './page';

/**

* The Power BI Visual embed component

*

* @export

* @class Visual

*/

export class Visual extends Report {

static type = "visual";

static GetPagesNotSupportedError = "Get pages is not supported while embedding a visual.";

static SetPageNotSupportedError = "Set page is not supported while embedding a visual.";

/**

* Creates an instance of a Power BI Single Visual.

*

* @param {service.Service} service

* @param {HTMLElement} element

* @param {embed.IEmbedConfiguration} config

*/

constructor(service: service.Service, element: HTMLElement, baseConfig: embed.IEmbedConfigurationBase, phasedRender?: boolean, iframe?: HTMLIFrameElement) {

super(service, element, baseConfig, phasedRender, iframe);

}

load(baseConfig: embed.IEmbedConfigurationBase, phasedRender?: boolean): Promise<void> {

var config = <embed.IVisualEmbedConfiguration>baseConfig;

if (typeof config.pageName !== 'string' || config.pageName.length === 0) {

throw new Error(`Page name is required when embedding a visual.`);

}

if (typeof config.visualName !== 'string' || config.visualName.length === 0) {

throw new Error(`Visual name is required, but it was not found. You must provide a visual name as part of embed configuration.`);

}

// calculate custom layout settings and override config.

let width = config.width ? config.width : this.iframe.offsetWidth;

let height = config.height ? config.height : this.iframe.offsetHeight;

const pageSize: models.ICustomPageSize = {

type: models.PageSizeType.Custom,

width: width,

height: height,

};

let pagesLayout: models.PagesLayout = {};

pagesLayout[config.pageName] = {

defaultLayout: {

displayState: {

mode: models.VisualContainerDisplayMode.Hidden

}

},

visualsLayout: {}

};

pagesLayout[config.pageName].visualsLayout[config.visualName] = {

displayState: {

mode: models.VisualContainerDisplayMode.Visible

},

x: 1,

y: 1,

z: 1,

width: pageSize.width,

height: pageSize.height

}

config.settings = config.settings || {};

config.settings.filterPaneEnabled = false;

config.settings.navContentPaneEnabled = false;

config.settings.layoutType = models.LayoutType.Custom;

config.settings.customLayout = {

displayOption: models.DisplayOption.FitToPage,

pageSize: pageSize,

pagesLayout: pagesLayout

};

return super.load(config, phasedRender);

}

/**

* Gets the list of pages within the report - not supported in visual embed.

*

* @returns {Promise<Page[]>}

*/

getPages(): Promise<Page[]> {

throw Visual.GetPagesNotSupportedError;

}

/**

* Sets the active page of the report - not supported in visual embed.

*

* @param {string} pageName

* @returns {Promise<void>}

*/

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

throw Visual.SetPageNotSupportedError;

}

/**

* Gets filters that are applied to the filter level.

* Default filter level is visual level.

*

* ```javascript

* visual.getFilters(filtersLevel)

* .then(filters => {

* ...

* });

* ```

*

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

*/

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

const url: string = this.getFiltersLevelUrl(filtersLevel);

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

.then(response => response.body,

response => {

throw response.body;

});

}

/**

* Sets filters at the filter level.

* Default filter level is visual level.

*

* ```javascript

* const filters: [

* ...

* ];

*

* visual.setFilters(filters, filtersLevel)

* .catch(errors => {

* ...

* });

* ```

*

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

* @returns {Promise<void>}

*/

setFilters(filters: models.IFilter[], filtersLevel?: models.FiltersLevel): Promise<void> {

const url: string = this.getFiltersLevelUrl(filtersLevel);

return this.service.hpm.put<models.IError[]>(url, filters, { uid: this.config.uniqueId }, this.iframe.contentWindow)

.catch(response => {

throw response.body;

});

}

/**

* Removes all filters from the current filter level.

* Default filter level is visual level.

*

* ```javascript

* visual.removeFilters(filtersLevel);

* ```

*

* @returns {Promise<void>}

*/

removeFilters(filtersLevel?: models.FiltersLevel): Promise<void> {

return this.setFilters([], filtersLevel);

}

private getFiltersLevelUrl(filtersLevel: models.FiltersLevel): string {

const config = <embed.IVisualEmbedConfiguration>this.config;

switch (filtersLevel) {

case models.FiltersLevel.Report:

return `/report/filters`;

case models.FiltersLevel.Page:

return `/report/pages/${config.pageName}/filters`;

default:

return `/report/pages/${config.pageName}/visuals/${config.visualName}/filters`;

}

}

}