FilesExpand file tree

 master

/

dashboard.ts

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

136 lines (120 loc) · 3.96 KB

 master

/

dashboard.ts

Copy path

Top

File metadata and controls

• Code
• Blame

136 lines (120 loc) · 3.96 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

// Copyright (c) Microsoft Corporation.

// Licensed under the MIT License.

import { IError, validateDashboardLoad, PageView } from 'powerbi-models';

import { Service, IService } from './service';

import { Embed, IDashboardEmbedConfiguration, IEmbedConfigurationBase } from './embed';

/**

* A Dashboard node within a dashboard hierarchy

*

* @export

* @interface IDashboardNode

*/

export interface IDashboardNode {

iframe: HTMLIFrameElement;

service: IService;

config: IEmbedConfigurationBase;

}

/**

* A Power BI Dashboard embed component

*

* @export

* @class Dashboard

* @extends {Embed}

* @implements {IDashboardNode}

*/

export class Dashboard extends Embed implements IDashboardNode {

/** @hidden */

static allowedEvents = ["tileClicked", "error"];

/** @hidden */

static dashboardIdAttribute = 'powerbi-dashboard-id';

/** @hidden */

static typeAttribute = 'powerbi-type';

/** @hidden */

static type = "Dashboard";

/**

* Creates an instance of a Power BI Dashboard.

*

* @param {service.Service} service

* @hidden

* @param {HTMLElement} element

*/

constructor(service: Service, element: HTMLElement, config: IEmbedConfigurationBase, phasedRender?: boolean, isBootstrap?: boolean) {

super(service, element, config, /* iframe */ undefined, phasedRender, isBootstrap);

this.loadPath = "/dashboard/load";

this.phasedLoadPath = "/dashboard/prepare";

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

}

/**

* This adds backwards compatibility for older config which used the dashboardId query param to specify dashboard id.

* E.g. https://powerbi-df.analysis-df.windows.net/dashboardEmbedHost?dashboardId=e9363c62-edb6-4eac-92d3-2199c5ca2a9e

*

* By extracting the id we can ensure id is always explicitly provided as part of the load configuration.

*

* @hidden

* @static

* @param {string} url

* @returns {string}

*/

static findIdFromEmbedUrl(url: string): string {

const dashboardIdRegEx = /dashboardId="?([^&]+)"?/;

const dashboardIdMatch = url.match(dashboardIdRegEx);

let dashboardId: string;

if (dashboardIdMatch) {

dashboardId = dashboardIdMatch[1];

}

return dashboardId;

}

/**

* Get dashboard id from first available location: options, attribute, embed url.

*

* @returns {string}

*/

getId(): string {

const config = this.config as IDashboardEmbedConfiguration;

const dashboardId = config.id || this.element.getAttribute(Dashboard.dashboardIdAttribute) || Dashboard.findIdFromEmbedUrl(config.embedUrl);

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

throw new Error(`Dashboard id is required, but it was not found. You must provide an id either as part of embed configuration or as attribute '${Dashboard.dashboardIdAttribute}'.`);

}

return dashboardId;

}

/**

* Validate load configuration.

*

* @hidden

*/

validate(baseConfig: IEmbedConfigurationBase): IError[] {

const config = baseConfig as IDashboardEmbedConfiguration;

const error = validateDashboardLoad(config);

return error ? error : this.validatePageView(config.pageView);

}

/**

* Handle config changes.

*

* @hidden

* @returns {void}

*/

configChanged(isBootstrap: boolean): void {

if (isBootstrap) {

return;

}

// Populate dashboard id into config object.

(this.config as IDashboardEmbedConfiguration).id = this.getId();

}

/**

* @hidden

* @returns {string}

*/

getDefaultEmbedUrlEndpoint(): string {

return "dashboardEmbed";

}

/**

* Validate that pageView has a legal value: if page view is defined it must have one of the values defined in PageView

*

* @hidden

*/

private validatePageView(pageView: PageView): IError[] {

if (pageView && pageView !== "fitToWidth" && pageView !== "oneColumn" && pageView !== "actualSize") {

return [{ message: "pageView must be one of the followings: fitToWidth, oneColumn, actualSize" }];

}

}

}