Skip to content

Commit

Permalink
documentation regenerated to reflect new types and events (#86)
Browse files Browse the repository at this point in the history
  • Loading branch information
@bryans99
bryans99 authored Jul 22, 2021
1 parent 6d44c80 commit d55c621
Show file tree
Hide file tree
Showing 42 changed files with 1,502 additions and 199 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.json
View file

Large diffs are not rendered by default.

78 changes: 39 additions & 39 deletions docs/classes/embedbuilder.html
View file

Large diffs are not rendered by default.

22 changes: 11 additions & 11 deletions docs/classes/embedclient.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> _builder</h3>
<div class="tsd-signature tsd-kind-icon">_builder<span class="tsd-signature-symbol">:</span> <a href="embedbuilder.html" class="tsd-signature-type">EmbedBuilder</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed.ts#L45">src/embed.ts:45</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed.ts#L45">src/embed.ts:45</a></li>
</ul>
</aside>
</section>
Expand All @@ -141,7 +141,7 @@ <h3>_client</h3>
<div class="tsd-signature tsd-kind-icon">_client<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed.ts#L39">src/embed.ts:39</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed.ts#L39">src/embed.ts:39</a></li>
</ul>
</aside>
</section>
Expand All @@ -151,7 +151,7 @@ <h3>_connection</h3>
<div class="tsd-signature tsd-kind-icon">_connection<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed.ts#L38">src/embed.ts:38</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed.ts#L38">src/embed.ts:38</a></li>
</ul>
</aside>
</section>
Expand All @@ -161,7 +161,7 @@ <h3>_host</h3>
<div class="tsd-signature tsd-kind-icon">_host<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ChattyHost</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed.ts#L37">src/embed.ts:37</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed.ts#L37">src/embed.ts:37</a></li>
</ul>
</aside>
</section>
Expand All @@ -171,7 +171,7 @@ <h3>_host<wbr>Builder</h3>
<div class="tsd-signature tsd-kind-icon">_host<wbr>Builder<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ChattyHostBuilder</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> = null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed.ts#L36">src/embed.ts:36</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed.ts#L36">src/embed.ts:36</a></li>
</ul>
</aside>
</section>
Expand All @@ -188,7 +188,7 @@ <h3>connection</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed.ts#L52">src/embed.ts:52</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed.ts#L52">src/embed.ts:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -211,7 +211,7 @@ <h3>is<wbr>Connected</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed.ts#L60">src/embed.ts:60</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed.ts#L60">src/embed.ts:60</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -233,7 +233,7 @@ <h3>target<wbr>Origin</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed.ts#L64">src/embed.ts:64</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed.ts#L64">src/embed.ts:64</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
Expand All @@ -253,7 +253,7 @@ <h3>connect</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed.ts#L143">src/embed.ts:143</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed.ts#L143">src/embed.ts:143</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -276,7 +276,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> create<wbr>Iframe</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed.ts#L72">src/embed.ts:72</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed.ts#L72">src/embed.ts:72</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -299,7 +299,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> create<wbr>Url</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed.ts#L101">src/embed.ts:101</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed.ts#L101">src/embed.ts:101</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></h4>
Expand Down
6 changes: 3 additions & 3 deletions docs/classes/lookerembedbase.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> _host</h3>
<div class="tsd-signature tsd-kind-icon">_host<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">ChattyHostConnection</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed_base.ts#L34">src/embed_base.ts:34</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed_base.ts#L34">src/embed_base.ts:34</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -137,7 +137,7 @@ <h3>send</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed_base.ts#L44">src/embed_base.ts:44</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed_base.ts#L44">src/embed_base.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -175,7 +175,7 @@ <h3>send<wbr>And<wbr>Receive</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed_base.ts#L56">src/embed_base.ts:56</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed_base.ts#L56">src/embed_base.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
22 changes: 11 additions & 11 deletions docs/classes/lookerembeddashboard.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -119,13 +119,13 @@ <h3>load<wbr>Dashboard</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/dashboard_client.ts#L92">src/dashboard_client.ts:92</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/dashboard_client.ts#L92">src/dashboard_client.ts:92</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Convenience method for loading a new dashboard.
Requires Looker 7.12 and Dashboards (Beta) (see <a href="embedbuilder.html#withnext">EmbedBuilder.withNext</a>).
Requires Looker 7.12 and Dashboards Next (see <a href="embedbuilder.html#withnext">EmbedBuilder.withNext</a>).
Throws an error if the dashboard load did not happen, which can happen if the
current dashboard is in edit mode.</p>
</div>
Expand Down Expand Up @@ -159,14 +159,14 @@ <h3>open<wbr>Schedule<wbr>Dialog</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/dashboard_client.ts#L78">src/dashboard_client.ts:78</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/dashboard_client.ts#L78">src/dashboard_client.ts:78</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Convenience method for opening the dashboard schedule dialog.</p>
</div>
<p>Requires Looker 7.18 and Dashboards (Beta) (see <a href="embedbuilder.html#withnext">EmbedBuilder.withNext</a>).</p>
<p>Requires Looker 7.18 and Dashboards Next (see <a href="embedbuilder.html#withnext">EmbedBuilder.withNext</a>).</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
Expand All @@ -182,7 +182,7 @@ <h3>run</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/dashboard_client.ts#L38">src/dashboard_client.ts:38</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/dashboard_client.ts#L38">src/dashboard_client.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -205,7 +205,7 @@ <h3>send</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="lookerembedbase.html">LookerEmbedBase</a>.<a href="lookerembedbase.html#send">send</a></p>
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed_base.ts#L44">src/embed_base.ts:44</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed_base.ts#L44">src/embed_base.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -244,7 +244,7 @@ <h3>send<wbr>And<wbr>Receive</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="lookerembedbase.html">LookerEmbedBase</a>.<a href="lookerembedbase.html#sendandreceive">sendAndReceive</a></p>
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed_base.ts#L56">src/embed_base.ts:56</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed_base.ts#L56">src/embed_base.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -282,7 +282,7 @@ <h3>set<wbr>Options</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/dashboard_client.ts#L68">src/dashboard_client.ts:68</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/dashboard_client.ts#L68">src/dashboard_client.ts:68</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -313,14 +313,14 @@ <h3>stop</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/dashboard_client.ts#L48">src/dashboard_client.ts:48</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/dashboard_client.ts#L48">src/dashboard_client.ts:48</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Convenience method for sending a stop message to the embedded dashboard.</p>
</div>
<p>Requires Looker 7.14 and Dashboards (Beta) (see <a href="embedbuilder.html#withnext">EmbedBuilder.withNext</a>).</p>
<p>Requires Looker 7.14 and Dashboards Next (see <a href="embedbuilder.html#withnext">EmbedBuilder.withNext</a>).</p>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
Expand All @@ -336,7 +336,7 @@ <h3>update<wbr>Filters</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/dashboard_client.ts#L58">src/dashboard_client.ts:58</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/dashboard_client.ts#L58">src/dashboard_client.ts:58</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
8 changes: 4 additions & 4 deletions docs/classes/lookerembedexplore.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ <h3>run</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/explore_client.ts#L38">src/explore_client.ts:38</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/explore_client.ts#L38">src/explore_client.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -138,7 +138,7 @@ <h3>send</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="lookerembedbase.html">LookerEmbedBase</a>.<a href="lookerembedbase.html#send">send</a></p>
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed_base.ts#L44">src/embed_base.ts:44</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed_base.ts#L44">src/embed_base.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -177,7 +177,7 @@ <h3>send<wbr>And<wbr>Receive</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="lookerembedbase.html">LookerEmbedBase</a>.<a href="lookerembedbase.html#sendandreceive">sendAndReceive</a></p>
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed_base.ts#L56">src/embed_base.ts:56</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed_base.ts#L56">src/embed_base.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -215,7 +215,7 @@ <h3>update<wbr>Filters</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/explore_client.ts#L48">src/explore_client.ts:48</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/explore_client.ts#L48">src/explore_client.ts:48</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
4 changes: 2 additions & 2 deletions docs/classes/lookerembedextension.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ <h3>send</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="lookerembedbase.html">LookerEmbedBase</a>.<a href="lookerembedbase.html#send">send</a></p>
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed_base.ts#L44">src/embed_base.ts:44</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed_base.ts#L44">src/embed_base.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -153,7 +153,7 @@ <h3>send<wbr>And<wbr>Receive</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="lookerembedbase.html">LookerEmbedBase</a>.<a href="lookerembedbase.html#sendandreceive">sendAndReceive</a></p>
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed_base.ts#L56">src/embed_base.ts:56</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed_base.ts#L56">src/embed_base.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
8 changes: 4 additions & 4 deletions docs/classes/lookerembedlook.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ <h3>run</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/look_client.ts#L38">src/look_client.ts:38</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/look_client.ts#L38">src/look_client.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -138,7 +138,7 @@ <h3>send</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="lookerembedbase.html">LookerEmbedBase</a>.<a href="lookerembedbase.html#send">send</a></p>
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed_base.ts#L44">src/embed_base.ts:44</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed_base.ts#L44">src/embed_base.ts:44</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -177,7 +177,7 @@ <h3>send<wbr>And<wbr>Receive</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="lookerembedbase.html">LookerEmbedBase</a>.<a href="lookerembedbase.html#sendandreceive">sendAndReceive</a></p>
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/embed_base.ts#L56">src/embed_base.ts:56</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/embed_base.ts#L56">src/embed_base.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -215,7 +215,7 @@ <h3>update<wbr>Filters</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/2f63384/src/look_client.ts#L48">src/look_client.ts:48</a></li>
<li>Defined in <a href="https://github.com/looker-open-source/embed-sdk/blob/6d44c80/src/look_client.ts#L48">src/look_client.ts:48</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading

0 comments on commit d55c621

Please sign in to comment.