Skip to content
Navigation Menu
{{ message }}
forked from microsoft/PowerBI-JavaScript
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
226 lines (226 loc) · 12.6 KB
/
Copy pathindex.html
File metadata and controls
226 lines (226 loc) · 12.6 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
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
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>powerbi-client</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">powerbi-client</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="globals.html">Globals</a>
</li>
</ul>
<h1> powerbi-client</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<h1 id="powerbi-client">powerbi-client</h1>
<p>JavaScript library for embedding Power BI into your apps.</p>
<p><a href="https://travis-ci.org/Microsoft/PowerBI-JavaScript"><img src="https://img.shields.io/travis/Microsoft/PowerBI-JavaScript/master.svg" alt="Build Status"></a>
<a href="https://www.npmjs.com/package/powerbi-client"><img src="https://img.shields.io/npm/v/powerbi-client.svg" alt="NPM Version"></a>
<a href="https://bower.io/search/?q=powerbi-client"><img src="https://img.shields.io/bower/v/powerbi-client.svg" alt="Bower Version"></a>
<a href="https://www.nuget.org/packages/Microsoft.PowerBI.JavaScript/"><img src="https://img.shields.io/nuget/v/Microsoft.PowerBI.JavaScript.svg" alt="Nuget Version"></a>
<a href="https://www.npmjs.com/package/powerbi-client"><img src="https://img.shields.io/npm/dt/powerbi-client.svg" alt="NPM Total Downloads"></a>
<a href="https://www.npmjs.com/package/powerbi-client"><img src="https://img.shields.io/npm/dm/powerbi-client.svg" alt="NPM Monthly Downloads"></a>
<a href="https://github.com/Microsoft/PowerBI-JavaScript/tags"><img src="https://img.shields.io/github/tag/microsoft/powerbi-javascript.svg" alt="GitHub tag"></a>
<a href="https://gitter.im/Microsoft/PowerBI-JavaScript"><img src="https://img.shields.io/gitter/room/Microsoft/PowerBI-JavaScript.svg" alt="Gitter"></a></p>
<h2 id="wiki">Wiki</h2>
<p>See the <a href="https://github.com/Microsoft/PowerBI-JavaScript/wiki">wiki</a> for more details about embedding, service configuration, setting default page, page navigation, dynamically applying filters, and more.</p>
<h2 id="code-docs">Code Docs</h2>
<p>See the <a href="https://microsoft.github.io/PowerBI-JavaScript">code docs</a> for detailed information about classes, interfaces, types, etc.</p>
<h2 id="demo">Demo</h2>
<p>New <a href="https://microsoft.github.io/PowerBI-JavaScript/demo">live demo</a> for sample application using the powerbi-client library in scenarios such as page navigation, applying filters, updating settings, and more.</p>
<h2 id="installation">Installation</h2>
<p>Install via Nuget:</p>
<p><code>Install-Package Microsoft.PowerBI.JavaScript -Pre</code></p>
<p>Install from NPM:</p>
<p><code>npm install --save powerbi-client</code></p>
<p>Install from Bower:</p>
<p><code>bower install powerbi-client --save</code></p>
<p>Installing beta versions:</p>
<p><code>npm install --save powerbi-client@beta</code></p>
<h2 id="include-the-library-via-import-or-manually">Include the library via import or manually</h2>
<p>Ideally you would use module loader or compilation step to import using ES6 modules as:</p>
<pre><code class="lang-javascript"><span class="hljs-keyword">import</span> * <span class="hljs-keyword">as</span> pbi <span class="hljs-keyword">from</span> <span class="hljs-string">'powerbi-client'</span>;
</code></pre>
<p>However, the library is exported as a Universal Module and the powerbi.js script can be included before your apps closing <code></body></code> tag as:</p>
<pre><code class="lang-html"><span class="hljs-tag"><<span class="hljs-name">script</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"/bower_components/powerbi-client/dist/powerbi.js"</span>></span><span class="undefined"></span><span class="hljs-tag"></<span class="hljs-name">script</span>></span>
</code></pre>
<p>When included directly the library is exposd as a global named 'powerbi-client'.
There is also another global <code>powerbi</code> which is an instance of the service.</p>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_node_modules_powerbi_models_dist_models_d_.html">"node_<wbr>modules/powerbi-<wbr>models/dist/models.d"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_config_.html">"src/config"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_create_.html">"src/create"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_dashboard_.html">"src/dashboard"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_embed_.html">"src/embed"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_factories_.html">"src/factories"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_ifilterable_.html">"src/ifilterable"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_page_.html">"src/page"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_powerbi_.html">"src/powerbi"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_report_.html">"src/report"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_service_.html">"src/service"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_tile_.html">"src/tile"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_src_util_.html">"src/util"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_typings_globals_es6_promise_index_d_.html">"typings/globals/es6-<wbr>promise/index.d"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
</body>
</html>
You can’t perform that action at this time.