Skip to content

Commit d61dc4a

Browse files
ali-hamudali-hamud
committed
Update docs from new code.
1 parent fd2cd53 commit d61dc4a

File tree

75 files changed

+11279
-4611
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+11279
-4611
lines changed

‎assets/js/search.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎classes/_node_modules_powerbi_models_dist_models_d_.advancedfilter.html‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -277,9 +277,6 @@ <h4 class="tsd-returns-title">Returns <a href="../interfaces/_node_modules_power
277277
<li class=" tsd-kind-external-module">
278278
<a href="../modules/_src_util_.html">"src/util"</a>
279279
</li>
280-
<li class=" tsd-kind-external-module">
281-
<a href="../modules/_src_visual_.html">"src/visual"</a>
282-
</li>
283280
<li class=" tsd-kind-external-module">
284281
<a href="../modules/_typings_globals_es6_promise_index_d_.html">"typings/globals/es6-<wbr>promise/index.d"</a>
285282
</li>

‎classes/_node_modules_powerbi_models_dist_models_d_.basicfilter.html‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -277,9 +277,6 @@ <h4 class="tsd-returns-title">Returns <a href="../interfaces/_node_modules_power
277277
<li class=" tsd-kind-external-module">
278278
<a href="../modules/_src_util_.html">"src/util"</a>
279279
</li>
280-
<li class=" tsd-kind-external-module">
281-
<a href="../modules/_src_visual_.html">"src/visual"</a>
282-
</li>
283280
<li class=" tsd-kind-external-module">
284281
<a href="../modules/_typings_globals_es6_promise_index_d_.html">"typings/globals/es6-<wbr>promise/index.d"</a>
285282
</li>

‎classes/_node_modules_powerbi_models_dist_models_d_.filter.html‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -246,9 +246,6 @@ <h4 class="tsd-returns-title">Returns <a href="../interfaces/_node_modules_power
246246
<li class=" tsd-kind-external-module">
247247
<a href="../modules/_src_util_.html">"src/util"</a>
248248
</li>
249-
<li class=" tsd-kind-external-module">
250-
<a href="../modules/_src_visual_.html">"src/visual"</a>
251-
</li>
252249
<li class=" tsd-kind-external-module">
253250
<a href="../modules/_typings_globals_es6_promise_index_d_.html">"typings/globals/es6-<wbr>promise/index.d"</a>
254251
</li>

‎classes/_src_dashboard_.dashboard.html‎

Lines changed: 32 additions & 35 deletions
Large diffs are not rendered by default.

‎classes/_src_embed_.embed.html‎

Lines changed: 36 additions & 39 deletions
Large diffs are not rendered by default.

‎classes/_src_page_.page.html‎

Lines changed: 10 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -127,11 +127,9 @@ <h3>Properties</h3>
127127
<h3>Methods</h3>
128128
<ul class="tsd-index-list">
129129
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_page_.page.html#getfilters" class="tsd-kind-icon">get<wbr>Filters</a></li>
130-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_page_.page.html#getvisuals" class="tsd-kind-icon">get<wbr>Visuals</a></li>
131130
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_page_.page.html#removefilters" class="tsd-kind-icon">remove<wbr>Filters</a></li>
132131
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_page_.page.html#setactive" class="tsd-kind-icon">set<wbr>Active</a></li>
133132
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_page_.page.html#setfilters" class="tsd-kind-icon">set<wbr>Filters</a></li>
134-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_src_page_.page.html#visual" class="tsd-kind-icon">visual</a></li>
135133
</ul>
136134
</section>
137135
</div>
@@ -149,7 +147,7 @@ <h3>constructor</h3>
149147
<li class="tsd-description">
150148
<aside class="tsd-sources">
151149
<ul>
152-
<li>Defined in <a href="https://github.com/Microsoft/PowerBI-JavaScript/blob/cd5b8d6/src/page.ts#L44">src/page.ts:44</a></li>
150+
<li>Defined in <a href="https://github.com/Microsoft/PowerBI-JavaScript/blob/cba63db/src/page.ts#L43">src/page.ts:43</a></li>
153151
</ul>
154152
</aside>
155153
<div class="tsd-comment tsd-typography">
@@ -182,7 +180,7 @@ <h3>display<wbr>Name</h3>
182180
<div class="tsd-signature tsd-kind-icon">display<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
183181
<aside class="tsd-sources">
184182
<ul>
185-
<li>Defined in <a href="https://github.com/Microsoft/PowerBI-JavaScript/blob/cd5b8d6/src/page.ts#L44">src/page.ts:44</a></li>
183+
<li>Defined in <a href="https://github.com/Microsoft/PowerBI-JavaScript/blob/cba63db/src/page.ts#L43">src/page.ts:43</a></li>
186184
</ul>
187185
</aside>
188186
<div class="tsd-comment tsd-typography">
@@ -203,7 +201,7 @@ <h3>name</h3>
203201
<aside class="tsd-sources">
204202
<p>Implementation of <a href="../interfaces/_src_page_.ipagenode.html">IPageNode</a>.<a href="../interfaces/_src_page_.ipagenode.html#name">name</a></p>
205203
<ul>
206-
<li>Defined in <a href="https://github.com/Microsoft/PowerBI-JavaScript/blob/cd5b8d6/src/page.ts#L37">src/page.ts:37</a></li>
204+
<li>Defined in <a href="https://github.com/Microsoft/PowerBI-JavaScript/blob/cba63db/src/page.ts#L36">src/page.ts:36</a></li>
207205
</ul>
208206
</aside>
209207
<div class="tsd-comment tsd-typography">
@@ -224,7 +222,7 @@ <h3>report</h3>
224222
<aside class="tsd-sources">
225223
<p>Implementation of <a href="../interfaces/_src_page_.ipagenode.html">IPageNode</a>.<a href="../interfaces/_src_page_.ipagenode.html#report">report</a></p>
226224
<ul>
227-
<li>Defined in <a href="https://github.com/Microsoft/PowerBI-JavaScript/blob/cd5b8d6/src/page.ts#L31">src/page.ts:31</a></li>
225+
<li>Defined in <a href="https://github.com/Microsoft/PowerBI-JavaScript/blob/cba63db/src/page.ts#L30">src/page.ts:30</a></li>
228226
</ul>
229227
</aside>
230228
<div class="tsd-comment tsd-typography">
@@ -252,46 +250,21 @@ <h3>get<wbr>Filters</h3>
252250
<aside class="tsd-sources">
253251
<p>Implementation of <a href="../interfaces/_src_ifilterable_.ifilterable.html">IFilterable</a>.<a href="../interfaces/_src_ifilterable_.ifilterable.html#getfilters">getFilters</a></p>
254252
<ul>
255-
<li>Defined in <a href="https://github.com/Microsoft/PowerBI-JavaScript/blob/cd5b8d6/src/page.ts#L69">src/page.ts:69</a></li>
253+
<li>Defined in <a href="https://github.com/Microsoft/PowerBI-JavaScript/blob/cba63db/src/page.ts#L68">src/page.ts:68</a></li>
256254
</ul>
257255
</aside>
258256
<div class="tsd-comment tsd-typography">
259257
<div class="lead">
260258
<p>Gets all page level filters within the report.</p>
261259
</div>
262260
<pre><code class="lang-javascript">page.getFilters()
263-
.then(pages =&gt; { ... });
261+
.then(<span class="hljs-function"><span class="hljs-params">pages</span> =&gt;</span> { ... });
264262
</code></pre>
265263
</div>
266264
<h4 class="tsd-returns-title">Returns <a href="_typings_globals_es6_promise_index_d_.promise.html" class="tsd-signature-type">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">models.IFilter</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
267265
</li>
268266
</ul>
269267
</section>
270-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
271-
<a name="getvisuals" class="tsd-anchor"></a>
272-
<h3>get<wbr>Visuals</h3>
273-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
274-
<li class="tsd-signature tsd-kind-icon">get<wbr>Visuals<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_typings_globals_es6_promise_index_d_.promise.html" class="tsd-signature-type">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="_src_visual_.visual.html" class="tsd-signature-type">Visual</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
275-
</ul>
276-
<ul class="tsd-descriptions">
277-
<li class="tsd-description">
278-
<aside class="tsd-sources">
279-
<ul>
280-
<li>Defined in <a href="https://github.com/Microsoft/PowerBI-JavaScript/blob/cd5b8d6/src/page.ts#L87">src/page.ts:87</a></li>
281-
</ul>
282-
</aside>
283-
<div class="tsd-comment tsd-typography">
284-
<div class="lead">
285-
<p>Gets all the visuals on the page.</p>
286-
</div>
287-
<pre><code class="lang-javascript">page.getVisuals()
288-
.then(visuals =&gt; { ... });
289-
</code></pre>
290-
</div>
291-
<h4 class="tsd-returns-title">Returns <a href="_typings_globals_es6_promise_index_d_.promise.html" class="tsd-signature-type">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="_src_visual_.visual.html" class="tsd-signature-type">Visual</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
292-
</li>
293-
</ul>
294-
</section>
295268
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
296269
<a name="removefilters" class="tsd-anchor"></a>
297270
<h3>remove<wbr>Filters</h3>
@@ -303,7 +276,7 @@ <h3>remove<wbr>Filters</h3>
303276
<aside class="tsd-sources">
304277
<p>Implementation of <a href="../interfaces/_src_ifilterable_.ifilterable.html">IFilterable</a>.<a href="../interfaces/_src_ifilterable_.ifilterable.html#removefilters">removeFilters</a></p>
305278
<ul>
306-
<li>Defined in <a href="https://github.com/Microsoft/PowerBI-JavaScript/blob/cd5b8d6/src/page.ts#L108">src/page.ts:108</a></li>
279+
<li>Defined in <a href="https://github.com/Microsoft/PowerBI-JavaScript/blob/cba63db/src/page.ts#L85">src/page.ts:85</a></li>
307280
</ul>
308281
</aside>
309282
<div class="tsd-comment tsd-typography">
@@ -327,7 +300,7 @@ <h3>set<wbr>Active</h3>
327300
<li class="tsd-description">
328301
<aside class="tsd-sources">
329302
<ul>
330-
<li>Defined in <a href="https://github.com/Microsoft/PowerBI-JavaScript/blob/cd5b8d6/src/page.ts#L121">src/page.ts:121</a></li>
303+
<li>Defined in <a href="https://github.com/Microsoft/PowerBI-JavaScript/blob/cba63db/src/page.ts#L98">src/page.ts:98</a></li>
331304
</ul>
332305
</aside>
333306
<div class="tsd-comment tsd-typography">
@@ -352,15 +325,15 @@ <h3>set<wbr>Filters</h3>
352325
<aside class="tsd-sources">
353326
<p>Implementation of <a href="../interfaces/_src_ifilterable_.ifilterable.html">IFilterable</a>.<a href="../interfaces/_src_ifilterable_.ifilterable.html#setfilters">setFilters</a></p>
354327
<ul>
355-
<li>Defined in <a href="https://github.com/Microsoft/PowerBI-JavaScript/blob/cd5b8d6/src/page.ts#L144">src/page.ts:144</a></li>
328+
<li>Defined in <a href="https://github.com/Microsoft/PowerBI-JavaScript/blob/cba63db/src/page.ts#L121">src/page.ts:121</a></li>
356329
</ul>
357330
</aside>
358331
<div class="tsd-comment tsd-typography">
359332
<div class="lead">
360333
<p>Sets all filters on the current page.</p>
361334
</div>
362335
<pre><code class="lang-javascript">page.setFilters(filters);
363-
.catch(errors =&gt; { ... });
336+
.catch(<span class="hljs-function"><span class="hljs-params">errors</span> =&gt;</span> { ... });
364337
</code></pre>
365338
</div>
366339
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -373,41 +346,6 @@ <h4 class="tsd-returns-title">Returns <a href="_typings_globals_es6_promise_inde
373346
</li>
374347
</ul>
375348
</section>
376-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
377-
<a name="visual" class="tsd-anchor"></a>
378-
<h3>visual</h3>
379-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
380-
<li class="tsd-signature tsd-kind-icon">visual<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_src_visual_.visual.html" class="tsd-signature-type">Visual</a></li>
381-
</ul>
382-
<ul class="tsd-descriptions">
383-
<li class="tsd-description">
384-
<aside class="tsd-sources">
385-
<ul>
386-
<li>Defined in <a href="https://github.com/Microsoft/PowerBI-JavaScript/blob/cd5b8d6/src/page.ts#L168">src/page.ts:168</a></li>
387-
</ul>
388-
</aside>
389-
<div class="tsd-comment tsd-typography">
390-
<div class="lead">
391-
<p>Creates a Visual object given a name for the visual.</p>
392-
</div>
393-
<p>Normally you would get Visual objects by calling <code>page.getVisuals()</code> but in the case
394-
that the visual name is known and you want to perform an action on a visual such as setting a filter
395-
without having to retrieve it first you can create it directly.</p>
396-
<p>Note: Because you are creating the visual manually there is no guarantee that the visual actually exists in the report and the subsequence requests could fail.</p>
397-
<pre><code class="lang-javascript"><span class="hljs-keyword">const</span> visual = report.page(<span class="hljs-string">'ReportSection1'</span>).visual(<span class="hljs-string">'BarChart1'</span>);
398-
visual.setFilters(filters);
399-
</code></pre>
400-
</div>
401-
<h4 class="tsd-parameters-title">Parameters</h4>
402-
<ul class="tsd-parameters">
403-
<li>
404-
<h5>name: <span class="tsd-signature-type">string</span></h5>
405-
</li>
406-
</ul>
407-
<h4 class="tsd-returns-title">Returns <a href="_src_visual_.visual.html" class="tsd-signature-type">Visual</a></h4>
408-
</li>
409-
</ul>
410-
</section>
411349
</section>
412350
</div>
413351
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
@@ -452,9 +390,6 @@ <h4 class="tsd-returns-title">Returns <a href="_src_visual_.visual.html" class="
452390
<li class=" tsd-kind-external-module">
453391
<a href="../modules/_src_util_.html">"src/util"</a>
454392
</li>
455-
<li class=" tsd-kind-external-module">
456-
<a href="../modules/_src_visual_.html">"src/visual"</a>
457-
</li>
458393
<li class=" tsd-kind-external-module">
459394
<a href="../modules/_typings_globals_es6_promise_index_d_.html">"typings/globals/es6-<wbr>promise/index.d"</a>
460395
</li>
@@ -482,9 +417,6 @@ <h4 class="tsd-returns-title">Returns <a href="_src_visual_.visual.html" class="
482417
<li class=" tsd-kind-method tsd-parent-kind-class">
483418
<a href="_src_page_.page.html#getfilters" class="tsd-kind-icon">get<wbr>Filters</a>
484419
</li>
485-
<li class=" tsd-kind-method tsd-parent-kind-class">
486-
<a href="_src_page_.page.html#getvisuals" class="tsd-kind-icon">get<wbr>Visuals</a>
487-
</li>
488420
<li class=" tsd-kind-method tsd-parent-kind-class">
489421
<a href="_src_page_.page.html#removefilters" class="tsd-kind-icon">remove<wbr>Filters</a>
490422
</li>
@@ -494,9 +426,6 @@ <h4 class="tsd-returns-title">Returns <a href="_src_visual_.visual.html" class="
494426
<li class=" tsd-kind-method tsd-parent-kind-class">
495427
<a href="_src_page_.page.html#setfilters" class="tsd-kind-icon">set<wbr>Filters</a>
496428
</li>
497-
<li class=" tsd-kind-method tsd-parent-kind-class">
498-
<a href="_src_page_.page.html#visual" class="tsd-kind-icon">visual</a>
499-
</li>
500429
</ul>
501430
</li>
502431
</ul>

0 commit comments

Comments
 (0)