microsoft
/
SandDance
зеркало из https://github.com/microsoft/SandDance.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Embed readme (#561) 

* add examples to readme

* split up types files

* move declarations inside namespace

* links to requests/responses

* add docs command

* link to embed docs

* remove unused function

* add link to docs

* add docs

* add theme

* minor version

* typedoc disableOutputCheck
This commit is contained in:
Dan Marshall 2022-12-08 17:06:34 -08:00 коммит произвёл GitHub
Родитель 543e56f34b
Коммит ac50545849
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
29 изменённых файлов: 2760 добавлений и 53 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

4
docs/_data/tree.json
Просмотреть файл

@ -30,6 +30,10 @@
"tree": "sanddance-explorer",
"url": "/docs/sanddance-explorer/v4"
},
{
"tree": "sanddance-embed",
"url": "/docs/sanddance-embed/v4"
},
{
"tree": "vega-morphcharts",
"url": "/docs/vega-morphcharts/v1"

1
docs/docs/index.md
Просмотреть файл

@ -11,4 +11,5 @@ SandDance is an offering of several JavaScript components:
* [sanddance-specs](sanddance-specs/v1) - Vega specifications for unit visualizations.
* [sanddance-react](sanddance-react/v4) - the core SandDance visualization canvas for use in React based applications.
* [sanddance-explorer](sanddance-explorer/v4) - the core SandDance visualization canvas with UI to enable data exploration, for use in React based applications.
* [sanddance-embed](sanddance-embed/v4) - the easiest way to embed SandDance explorer in your applications, via an `<iframe>` tag.
* [vega-morphcharts](vega-morphcharts/v1) - the View component for Vega visualizations, using MorphCharts for WebGL rendering.

160
docs/docs/sanddance-embed/v4/index.html Normal file
Просмотреть файл

@ -0,0 +1,160 @@
---
layout: typedoc
title: '@msrvida/sanddance-embed'
---
<header>
<div class="tsd-page-title">
<div class="typedoc-container">
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<a href="#msrvidasanddance-embed" id="msrvidasanddance-embed" style="color: inherit; text-decoration: none;">
<h1>@msrvida/sanddance-embed</h1>
</a>
<p>SandDance Embed is the easiest way to integrate <a href="https://microsoft.github.io/SandDance/">SandDance</a> into your custom app, via an <code>&lt;iframe&gt;</code> tag. SandDance Embed is a wrapper around SandDance Explorer, plus <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage">postMessage</a> handlers to load data and manage its display from outside the iframe.</p>
<p><img src="https://user-images.githubusercontent.com/11507384/72197128-a99cdd80-33d2-11ea-9b49-5d470db0abc1.png" alt="image"></p>
<p>There are two ways to create a SandDance Embed iframe instance:</p>
<ol>
<li>Cross-domain</li>
<li>In-domain</li>
</ol>
<a href="#cross-domain-iframe" id="cross-domain-iframe" style="color: inherit; text-decoration: none;">
<h2>Cross-domain iframe</h2>
</a>
<p>This is the simplest approach. Add an <code>&lt;iframe&gt;</code> tag in your HTML page:</p>
<pre><code class="language-html"><span style="color: #800000">&lt;iframe</span><span style="color: #000000"> </span><span style="color: #FF0000">id</span><span style="color: #000000">=</span><span style="color: #0000FF">&quot;embedIframe&quot;</span><span style="color: #000000"> </span><span style="color: #FF0000">src</span><span style="color: #000000">=</span><span style="color: #0000FF">&quot;https://microsoft.github.io/SandDance/embed/v4/sanddance-embed.html&quot;</span><span style="color: #000000"> </span><span style="color: #FF0000">style</span><span style="color: #000000">=</span><span style="color: #0000FF">&quot;height:700px;width:100%&quot;</span><span style="color: #800000">&gt;&lt;/iframe&gt;</span>
</code></pre>
<p>Get a code reference to this iframe:</p>
<pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">embedIframe</span><span style="color: #000000"> = </span><span style="color: #001080">document</span><span style="color: #000000">.</span><span style="color: #795E26">getElementById</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;embedIframe&#039;</span><span style="color: #000000">);</span>
<span style="color: #001080">embedIframe</span><span style="color: #000000">.</span><span style="color: #795E26">onload</span><span style="color: #000000"> = () </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
<span style="color: #000000"> </span><span style="color: #008000">//ready to send commands to SandDance Embed</span>
<span style="color: #000000">}</span>
</code></pre>
<p><em>Note the version number in the address to specify by major version. You may style the iframe as you see fit.</em></p>
<p><em>Security: The URL is hosted by the secure <a href="https://github.com/microsoft/SandDance/tree/master/docs/embed">SandDance GitHub Pages website</a>.</em></p>
<p><em>Privacy: The page does not collect any data that you pass to SandDance Embed.</em></p>
<a href="#in-domain-iframe" id="in-domain-iframe" style="color: inherit; text-decoration: none;">
<h2>In-domain iframe</h2>
</a>
<p>In JavaScript, create a SandDance Embed iframe and await it to be ready:</p>
<pre><code class="language-js"><span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">embedPromise</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #267F99">Promise</span><span style="color: #000000">((</span><span style="color: #001080">resolve</span><span style="color: #000000">, </span><span style="color: #001080">reject</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">embedIframe</span><span style="color: #000000"> = </span><span style="color: #001080">document</span><span style="color: #000000">.</span><span style="color: #795E26">createElement</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;iframe&#039;</span><span style="color: #000000">);</span>
<span style="color: #000000"> </span><span style="color: #001080">embedIframe</span><span style="color: #000000">.</span><span style="color: #001080">style</span><span style="color: #000000">.</span><span style="color: #001080">height</span><span style="color: #000000"> = </span><span style="color: #A31515">&#039;700px&#039;</span><span style="color: #000000">;</span>
<span style="color: #000000"> </span><span style="color: #001080">embedIframe</span><span style="color: #000000">.</span><span style="color: #001080">style</span><span style="color: #000000">.</span><span style="color: #001080">width</span><span style="color: #000000"> = </span><span style="color: #A31515">&#039;1000px&#039;</span>
<span style="color: #000000"> </span><span style="color: #001080">embedIframe</span><span style="color: #000000">.</span><span style="color: #795E26">onload</span><span style="color: #000000"> = () </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">embedScript</span><span style="color: #000000"> = </span><span style="color: #001080">embedIframe</span><span style="color: #000000">.</span><span style="color: #001080">contentDocument</span><span style="color: #000000">.</span><span style="color: #795E26">createElement</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;script&#039;</span><span style="color: #000000">);</span>
<span style="color: #000000"> </span><span style="color: #001080">embedScript</span><span style="color: #000000">.</span><span style="color: #001080">src</span><span style="color: #000000"> = </span><span style="color: #A31515">&#039;https://unpkg.com/@msrvida/sanddance-embed@4/dist/umd/sanddance-embed.js&#039;</span><span style="color: #000000">;</span>
<span style="color: #000000"> </span><span style="color: #001080">embedIframe</span><span style="color: #000000">.</span><span style="color: #001080">contentDocument</span><span style="color: #000000">.</span><span style="color: #001080">head</span><span style="color: #000000">.</span><span style="color: #795E26">appendChild</span><span style="color: #000000">(</span><span style="color: #001080">embedScript</span><span style="color: #000000">);</span>
<span style="color: #000000"> </span><span style="color: #001080">embedScript</span><span style="color: #000000">.</span><span style="color: #795E26">onload</span><span style="color: #000000"> = () </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> </span><span style="color: #795E26">resolve</span><span style="color: #000000">(</span><span style="color: #001080">embedIframe</span><span style="color: #000000">);</span>
<span style="color: #000000"> </span><span style="color: #001080">embedScript</span><span style="color: #000000">.</span><span style="color: #001080">onerror</span><span style="color: #000000"> = </span><span style="color: #001080">reject</span><span style="color: #000000">;</span>
<span style="color: #000000"> };</span>
<span style="color: #000000"> </span><span style="color: #001080">document</span><span style="color: #000000">.</span><span style="color: #001080">body</span><span style="color: #000000">.</span><span style="color: #795E26">appendChild</span><span style="color: #000000">(</span><span style="color: #001080">embedIframe</span><span style="color: #000000">);</span>
<span style="color: #000000"> });</span>
</code></pre>
<p>This promise provides you <code>embedIframe</code> when it is available:</p>
<pre><code class="language-js"><span style="color: #000000"> </span><span style="color: #001080">embedPromise</span><span style="color: #000000">.</span><span style="color: #795E26">then</span><span style="color: #000000">((</span><span style="color: #001080">embedIframe</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
<span style="color: #000000"> </span><span style="color: #008000">//ready to send commands to SandDance Embed</span>
<span style="color: #000000"> });</span>
</code></pre>
<a href="#send-commands-to-sanddance-embed" id="send-commands-to-sanddance-embed" style="color: inherit; text-decoration: none;">
<h2>Send commands to SandDance Embed</h2>
</a>
<p>Use <code>postMessage</code> to communicate with <code>embedIframe.contentWindow</code>. For all command requests, see <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts">https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts</a></p>
<ul>
<li><p>Load data and display initial chart:</p>
<pre><code class="language-js"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">data</span><span style="color: #000000"> = [</span>
<span style="color: #000000"> { </span><span style="color: #001080">x:</span><span style="color: #000000"> </span><span style="color: #098658">0</span><span style="color: #000000">, </span><span style="color: #001080">y:</span><span style="color: #000000"> </span><span style="color: #098658">0</span><span style="color: #000000">, </span><span style="color: #001080">z:</span><span style="color: #000000"> </span><span style="color: #098658">0</span><span style="color: #000000"> },</span>
<span style="color: #000000"> { </span><span style="color: #001080">x:</span><span style="color: #000000"> </span><span style="color: #098658">1</span><span style="color: #000000">, </span><span style="color: #001080">y:</span><span style="color: #000000"> </span><span style="color: #098658">1</span><span style="color: #000000">, </span><span style="color: #001080">z:</span><span style="color: #000000"> </span><span style="color: #098658">1</span><span style="color: #000000"> },</span>
<span style="color: #000000"> { </span><span style="color: #001080">x:</span><span style="color: #000000"> </span><span style="color: #098658">2</span><span style="color: #000000">, </span><span style="color: #001080">y:</span><span style="color: #000000"> </span><span style="color: #098658">2</span><span style="color: #000000">, </span><span style="color: #001080">z:</span><span style="color: #000000"> </span><span style="color: #098658">2</span><span style="color: #000000"> },</span>
<span style="color: #000000">];</span>
<span style="color: #001080">embedIframe</span><span style="color: #000000">.</span><span style="color: #001080">contentWindow</span><span style="color: #000000">.</span><span style="color: #795E26">postMessage</span><span style="color: #000000">({ </span><span style="color: #001080">action:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;load&#039;</span><span style="color: #000000">, </span><span style="color: #001080">data</span><span style="color: #000000">, </span><span style="color: #001080">props:</span><span style="color: #000000"> { </span><span style="color: #001080">theme:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;dark-theme&#039;</span><span style="color: #000000"> } }, </span><span style="color: #A31515">&#039;*&#039;</span><span style="color: #000000">);</span>
</code></pre>
<p> The <code>data</code> variable can be an array, or a <a href="https://microsoft.github.io/SandDance/docs/sanddance-explorer/v4/interfaces/DataFile.html">DataFile object</a>. The <code>props</code> member is optional <a href="https://microsoft.github.io/SandDance/docs/sanddance-explorer/v4/interfaces/Props.html">Explorer Props</a>, here is shown used to specify the dark color theme. </p>
</li>
<li><p>Get insight:</p>
<pre><code class="language-js"><span style="color: #001080">embedIframe</span><span style="color: #000000">.</span><span style="color: #001080">contentWindow</span><span style="color: #000000">.</span><span style="color: #795E26">postMessage</span><span style="color: #000000">({ </span><span style="color: #001080">action:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;getInsight&#039;</span><span style="color: #000000"> }, </span><span style="color: #A31515">&#039;*&#039;</span><span style="color: #000000">);</span>
</code></pre>
</li>
<li><p>Get or set theme:</p>
<pre><code class="language-js"><span style="color: #001080">embedIframe</span><span style="color: #000000">.</span><span style="color: #001080">contentWindow</span><span style="color: #000000">.</span><span style="color: #795E26">postMessage</span><span style="color: #000000">({ </span><span style="color: #001080">action:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;theme&#039;</span><span style="color: #000000">, </span><span style="color: #001080">dark:</span><span style="color: #000000"> </span><span style="color: #0000FF">true</span><span style="color: #000000"> }, </span><span style="color: #A31515">&#039;*&#039;</span><span style="color: #000000">);</span>
</code></pre>
</li>
</ul>
<a href="#receive-commands-from-sanddance-embed" id="receive-commands-from-sanddance-embed" style="color: inherit; text-decoration: none;">
<h2>Receive commands from SandDance Embed</h2>
</a>
<p>Attach a listener to your own window to observe message passing:</p>
<pre><code class="language-js"><span style="color: #000000"> </span><span style="color: #001080">window</span><span style="color: #000000">.</span><span style="color: #795E26">onmessage</span><span style="color: #000000"> = (</span><span style="color: #001080">e</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;messaged&#039;</span><span style="color: #000000">, </span><span style="color: #001080">e</span><span style="color: #000000">.</span><span style="color: #001080">data</span><span style="color: #000000">);</span>
<span style="color: #000000"> };</span>
</code></pre>
<p>The message will contain a property <code>request</code> which is a clone of the requesting message object which instigated the response. Other properties vary depending on the type of request. For all command responses, see <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-response.d.ts">https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-response.d.ts</a></p>
<p> Here is an example of the response for <code>getInsight</code>:</p>
<pre><code class="language-json"><span style="color: #000000">{</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;request&quot;</span><span style="color: #000000">: {</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;action&quot;</span><span style="color: #000000">: </span><span style="color: #A31515">&quot;getInsight&quot;</span>
<span style="color: #000000"> },</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;insight&quot;</span><span style="color: #000000">: {</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;colorBin&quot;</span><span style="color: #000000">: </span><span style="color: #0000FF">null</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;columns&quot;</span><span style="color: #000000">: {</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;x&quot;</span><span style="color: #000000">: </span><span style="color: #A31515">&quot;x&quot;</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;y&quot;</span><span style="color: #000000">: </span><span style="color: #A31515">&quot;y&quot;</span>
<span style="color: #000000"> },</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;facetStyle&quot;</span><span style="color: #000000">: </span><span style="color: #A31515">&quot;wrap&quot;</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;filter&quot;</span><span style="color: #000000">: </span><span style="color: #0000FF">null</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;hideAxes&quot;</span><span style="color: #000000">: </span><span style="color: #0000FF">false</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;hideLegend&quot;</span><span style="color: #000000">: </span><span style="color: #0000FF">false</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;signalValues&quot;</span><span style="color: #000000">: {</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;RoleZ_ProportionSignal&quot;</span><span style="color: #000000">: </span><span style="color: #098658">0.6</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;Text_ScaleSignal&quot;</span><span style="color: #000000">: </span><span style="color: #098658">1.2</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;RoleColor_BinCountSignal&quot;</span><span style="color: #000000">: </span><span style="color: #098658">7</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;RoleColor_ReverseSignal&quot;</span><span style="color: #000000">: </span><span style="color: #0000FF">false</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;Chart_PointScaleSignal&quot;</span><span style="color: #000000">: </span><span style="color: #098658">5</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;RoleZ_Grounded&quot;</span><span style="color: #000000">: </span><span style="color: #0000FF">false</span>
<span style="color: #000000"> },</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;size&quot;</span><span style="color: #000000">: {</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;height&quot;</span><span style="color: #000000">: </span><span style="color: #098658">663</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;width&quot;</span><span style="color: #000000">: </span><span style="color: #098658">700</span>
<span style="color: #000000"> },</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;totalStyle&quot;</span><span style="color: #000000">: </span><span style="color: #0000FF">null</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;transform&quot;</span><span style="color: #000000">: </span><span style="color: #0000FF">null</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;chart&quot;</span><span style="color: #000000">: </span><span style="color: #A31515">&quot;scatterplot&quot;</span><span style="color: #000000">,</span>
<span style="color: #000000"> </span><span style="color: #0451A5">&quot;view&quot;</span><span style="color: #000000">: </span><span style="color: #A31515">&quot;2d&quot;</span>
<span style="color: #000000"> }</span>
<span style="color: #000000">}</span>
</code></pre>
<a href="#for-more-information" id="for-more-information" style="color: inherit; text-decoration: none;">
<h2>For more information</h2>
</a>
<p>Please visit the <a href="https://microsoft.github.io/SandDance/">SandDance website</a>.</p>
</div>
</div>
<div class="col-4 col-menu menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/sanddance_embed.html">sanddance-<wbr>embed</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/types_message_request.html">types/message-<wbr>request</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/types_message_response.html">types/message-<wbr>response</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary">
<ul class="before-current">
</ul>
</nav>
</div>
</div>
</div>
<div class="overlay"></div>

169
docs/docs/sanddance-embed/v4/interfaces/types_message_request.MessageRequestBase.html Normal file
Просмотреть файл

@ -0,0 +1,169 @@
---
layout: typedoc
title: 'MessageRequestBase | @msrvida/sanddance-embed'
---
<header>
<div class="tsd-page-title">
<div class="typedoc-container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@msrvida/sanddance-embed</a>
</li>
<li>
<a href="../modules/types_message_request.html">types/message-request</a>
</li>
<li>
<a href="types_message_request.MessageRequestBase.html">MessageRequestBase</a>
</li>
</ul>
<h1>Interface MessageRequestBase</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">MessageRequestBase</span>
<ul class="tsd-hierarchy">
<li>
<a href="types_message_request.MessageRequest_Init.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageRequest_Init</a>
</li>
<li>
<a href="types_message_request.MessageRequest_Load.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageRequest_Load</a>
</li>
<li>
<a href="types_message_request.MessageRequest_GetData.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageRequest_GetData</a>
</li>
<li>
<a href="types_message_request.MessageRequest_GetInsight.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageRequest_GetInsight</a>
</li>
<li>
<a href="types_message_request.MessageRequest_Theme.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageRequest_Theme</a>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="types_message_request.MessageRequestBase.html#action" class="tsd-kind-icon">action</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="types_message_request.MessageRequestBase.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="types_message_request.MessageRequestBase.html#ts" class="tsd-kind-icon">ts</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="action" class="tsd-anchor"></a>
<h3>action</h3>
<div class="tsd-signature tsd-kind-icon">action<span class="tsd-signature-symbol">:</span> <a href="../modules/types_message_request.html#Actions" class="tsd-signature-type" data-tsd-kind="Type alias">Actions</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L4">types/message-request.d.ts:4</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L5">types/message-request.d.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ts" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ts</h3>
<div class="tsd-signature tsd-kind-icon">ts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L6">types/message-request.d.ts:6</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/sanddance_embed.html">sanddance-<wbr>embed</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/types_message_request.html">types/message-<wbr>request</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/types_message_response.html">types/message-<wbr>response</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequestBase.html" class="tsd-kind-icon">Message<wbr>Request<wbr>Base</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="types_message_request.MessageRequestBase.html#action" class="tsd-kind-icon">action</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="types_message_request.MessageRequestBase.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="types_message_request.MessageRequestBase.html#ts" class="tsd-kind-icon">ts</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_GetData.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Get<wbr>Data</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_GetInsight.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Get<wbr>Insight</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_Init.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Init</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_Load.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Load</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_Theme.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Theme</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#Actions" class="tsd-kind-icon">Actions</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#DataToLoad" class="tsd-kind-icon">Data<wbr>ToLoad</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#MessageRequest" class="tsd-kind-icon">Message<wbr>Request</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#MessageRequestWithSource" class="tsd-kind-icon">Message<wbr>Request<wbr>With<wbr>Source</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="overlay"></div>

160
docs/docs/sanddance-embed/v4/interfaces/types_message_request.MessageRequest_GetData.html Normal file
Просмотреть файл

@ -0,0 +1,160 @@
---
layout: typedoc
title: 'MessageRequest_GetData | @msrvida/sanddance-embed'
---
<header>
<div class="tsd-page-title">
<div class="typedoc-container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@msrvida/sanddance-embed</a>
</li>
<li>
<a href="../modules/types_message_request.html">types/message-request</a>
</li>
<li>
<a href="types_message_request.MessageRequest_GetData.html">MessageRequest_GetData</a>
</li>
</ul>
<h1>Interface MessageRequest_GetData</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="types_message_request.MessageRequestBase.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageRequestBase</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">MessageRequest_GetData</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="types_message_request.MessageRequest_GetData.html#action" class="tsd-kind-icon">action</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="types_message_request.MessageRequest_GetData.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="types_message_request.MessageRequest_GetData.html#ts" class="tsd-kind-icon">ts</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="action" class="tsd-anchor"></a>
<h3>action</h3>
<div class="tsd-signature tsd-kind-icon">action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;getData&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides <a href="types_message_request.MessageRequestBase.html">MessageRequestBase</a>.<a href="types_message_request.MessageRequestBase.html#action">action</a></p>
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L34">types/message-request.d.ts:34</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="types_message_request.MessageRequestBase.html">MessageRequestBase</a>.<a href="types_message_request.MessageRequestBase.html#id">id</a></p>
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L5">types/message-request.d.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="ts" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ts</h3>
<div class="tsd-signature tsd-kind-icon">ts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="types_message_request.MessageRequestBase.html">MessageRequestBase</a>.<a href="types_message_request.MessageRequestBase.html#ts">ts</a></p>
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L6">types/message-request.d.ts:6</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/sanddance_embed.html">sanddance-<wbr>embed</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/types_message_request.html">types/message-<wbr>request</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/types_message_response.html">types/message-<wbr>response</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary">
<ul class="before-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequestBase.html" class="tsd-kind-icon">Message<wbr>Request<wbr>Base</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_GetData.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Get<wbr>Data</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="types_message_request.MessageRequest_GetData.html#action" class="tsd-kind-icon">action</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="types_message_request.MessageRequest_GetData.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="types_message_request.MessageRequest_GetData.html#ts" class="tsd-kind-icon">ts</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_GetInsight.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Get<wbr>Insight</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_Init.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Init</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_Load.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Load</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_Theme.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Theme</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#Actions" class="tsd-kind-icon">Actions</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#DataToLoad" class="tsd-kind-icon">Data<wbr>ToLoad</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#MessageRequest" class="tsd-kind-icon">Message<wbr>Request</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#MessageRequestWithSource" class="tsd-kind-icon">Message<wbr>Request<wbr>With<wbr>Source</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="overlay"></div>

160
docs/docs/sanddance-embed/v4/interfaces/types_message_request.MessageRequest_GetInsight.html Normal file
Просмотреть файл

@ -0,0 +1,160 @@
---
layout: typedoc
title: 'MessageRequest_GetInsight | @msrvida/sanddance-embed'
---
<header>
<div class="tsd-page-title">
<div class="typedoc-container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@msrvida/sanddance-embed</a>
</li>
<li>
<a href="../modules/types_message_request.html">types/message-request</a>
</li>
<li>
<a href="types_message_request.MessageRequest_GetInsight.html">MessageRequest_GetInsight</a>
</li>
</ul>
<h1>Interface MessageRequest_GetInsight</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="types_message_request.MessageRequestBase.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageRequestBase</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">MessageRequest_GetInsight</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="types_message_request.MessageRequest_GetInsight.html#action" class="tsd-kind-icon">action</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="types_message_request.MessageRequest_GetInsight.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="types_message_request.MessageRequest_GetInsight.html#ts" class="tsd-kind-icon">ts</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="action" class="tsd-anchor"></a>
<h3>action</h3>
<div class="tsd-signature tsd-kind-icon">action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;getInsight&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides <a href="types_message_request.MessageRequestBase.html">MessageRequestBase</a>.<a href="types_message_request.MessageRequestBase.html#action">action</a></p>
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L38">types/message-request.d.ts:38</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="types_message_request.MessageRequestBase.html">MessageRequestBase</a>.<a href="types_message_request.MessageRequestBase.html#id">id</a></p>
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L5">types/message-request.d.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="ts" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ts</h3>
<div class="tsd-signature tsd-kind-icon">ts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="types_message_request.MessageRequestBase.html">MessageRequestBase</a>.<a href="types_message_request.MessageRequestBase.html#ts">ts</a></p>
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L6">types/message-request.d.ts:6</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/sanddance_embed.html">sanddance-<wbr>embed</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/types_message_request.html">types/message-<wbr>request</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/types_message_response.html">types/message-<wbr>response</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary">
<ul class="before-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequestBase.html" class="tsd-kind-icon">Message<wbr>Request<wbr>Base</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_GetData.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Get<wbr>Data</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_GetInsight.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Get<wbr>Insight</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="types_message_request.MessageRequest_GetInsight.html#action" class="tsd-kind-icon">action</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="types_message_request.MessageRequest_GetInsight.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="types_message_request.MessageRequest_GetInsight.html#ts" class="tsd-kind-icon">ts</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_Init.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Init</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_Load.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Load</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_Theme.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Theme</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#Actions" class="tsd-kind-icon">Actions</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#DataToLoad" class="tsd-kind-icon">Data<wbr>ToLoad</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#MessageRequest" class="tsd-kind-icon">Message<wbr>Request</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#MessageRequestWithSource" class="tsd-kind-icon">Message<wbr>Request<wbr>With<wbr>Source</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="overlay"></div>

160
docs/docs/sanddance-embed/v4/interfaces/types_message_request.MessageRequest_Init.html Normal file
Просмотреть файл

@ -0,0 +1,160 @@
---
layout: typedoc
title: 'MessageRequest_Init | @msrvida/sanddance-embed'
---
<header>
<div class="tsd-page-title">
<div class="typedoc-container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@msrvida/sanddance-embed</a>
</li>
<li>
<a href="../modules/types_message_request.html">types/message-request</a>
</li>
<li>
<a href="types_message_request.MessageRequest_Init.html">MessageRequest_Init</a>
</li>
</ul>
<h1>Interface MessageRequest_Init</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="types_message_request.MessageRequestBase.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageRequestBase</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">MessageRequest_Init</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="types_message_request.MessageRequest_Init.html#action" class="tsd-kind-icon">action</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="types_message_request.MessageRequest_Init.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="types_message_request.MessageRequest_Init.html#ts" class="tsd-kind-icon">ts</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="action" class="tsd-anchor"></a>
<h3>action</h3>
<div class="tsd-signature tsd-kind-icon">action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;init&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides <a href="types_message_request.MessageRequestBase.html">MessageRequestBase</a>.<a href="types_message_request.MessageRequestBase.html#action">action</a></p>
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L10">types/message-request.d.ts:10</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="types_message_request.MessageRequestBase.html">MessageRequestBase</a>.<a href="types_message_request.MessageRequestBase.html#id">id</a></p>
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L5">types/message-request.d.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="ts" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ts</h3>
<div class="tsd-signature tsd-kind-icon">ts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="types_message_request.MessageRequestBase.html">MessageRequestBase</a>.<a href="types_message_request.MessageRequestBase.html#ts">ts</a></p>
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L6">types/message-request.d.ts:6</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/sanddance_embed.html">sanddance-<wbr>embed</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/types_message_request.html">types/message-<wbr>request</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/types_message_response.html">types/message-<wbr>response</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary">
<ul class="before-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequestBase.html" class="tsd-kind-icon">Message<wbr>Request<wbr>Base</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_GetData.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Get<wbr>Data</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_GetInsight.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Get<wbr>Insight</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_Init.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Init</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="types_message_request.MessageRequest_Init.html#action" class="tsd-kind-icon">action</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="types_message_request.MessageRequest_Init.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="types_message_request.MessageRequest_Init.html#ts" class="tsd-kind-icon">ts</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_Load.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Load</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_Theme.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Theme</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#Actions" class="tsd-kind-icon">Actions</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#DataToLoad" class="tsd-kind-icon">Data<wbr>ToLoad</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#MessageRequest" class="tsd-kind-icon">Message<wbr>Request</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#MessageRequestWithSource" class="tsd-kind-icon">Message<wbr>Request<wbr>With<wbr>Source</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="overlay"></div>

212
docs/docs/sanddance-embed/v4/interfaces/types_message_request.MessageRequest_Load.html Normal file
Просмотреть файл

@ -0,0 +1,212 @@
---
layout: typedoc
title: 'MessageRequest_Load | @msrvida/sanddance-embed'
---
<header>
<div class="tsd-page-title">
<div class="typedoc-container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@msrvida/sanddance-embed</a>
</li>
<li>
<a href="../modules/types_message_request.html">types/message-request</a>
</li>
<li>
<a href="types_message_request.MessageRequest_Load.html">MessageRequest_Load</a>
</li>
</ul>
<h1>Interface MessageRequest_Load</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="types_message_request.MessageRequestBase.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageRequestBase</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">MessageRequest_Load</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="types_message_request.MessageRequest_Load.html#action" class="tsd-kind-icon">action</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="types_message_request.MessageRequest_Load.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="types_message_request.MessageRequest_Load.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="types_message_request.MessageRequest_Load.html#insight" class="tsd-kind-icon">insight</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="types_message_request.MessageRequest_Load.html#props" class="tsd-kind-icon">props</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="types_message_request.MessageRequest_Load.html#ts" class="tsd-kind-icon">ts</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="action" class="tsd-anchor"></a>
<h3>action</h3>
<div class="tsd-signature tsd-kind-icon">action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;load&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides <a href="types_message_request.MessageRequestBase.html">MessageRequestBase</a>.<a href="types_message_request.MessageRequestBase.html#action">action</a></p>
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L19">types/message-request.d.ts:19</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="data" class="tsd-anchor"></a>
<h3>data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <a href="../modules/types_message_request.html#DataToLoad" class="tsd-signature-type" data-tsd-kind="Type alias">DataToLoad</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L20">types/message-request.d.ts:20</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="types_message_request.MessageRequestBase.html">MessageRequestBase</a>.<a href="types_message_request.MessageRequestBase.html#id">id</a></p>
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L5">types/message-request.d.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="insight" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> insight</h3>
<div class="tsd-signature tsd-kind-icon">insight<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L25">types/message-request.d.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>See <a href="https://microsoft.github.io/SandDance/docs/sanddance-specs/v1/interfaces/Insight.html">https://microsoft.github.io/SandDance/docs/sanddance-specs/v1/interfaces/Insight.html</a></p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="props" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> props</h3>
<div class="tsd-signature tsd-kind-icon">props<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Props</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L30">types/message-request.d.ts:30</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>See <a href="https://microsoft.github.io/SandDance/docs/sanddance-explorer/v4/interfaces/Props.html">https://microsoft.github.io/SandDance/docs/sanddance-explorer/v4/interfaces/Props.html</a></p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="ts" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ts</h3>
<div class="tsd-signature tsd-kind-icon">ts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="types_message_request.MessageRequestBase.html">MessageRequestBase</a>.<a href="types_message_request.MessageRequestBase.html#ts">ts</a></p>
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L6">types/message-request.d.ts:6</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/sanddance_embed.html">sanddance-<wbr>embed</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/types_message_request.html">types/message-<wbr>request</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/types_message_response.html">types/message-<wbr>response</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary">
<ul class="before-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequestBase.html" class="tsd-kind-icon">Message<wbr>Request<wbr>Base</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_GetData.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Get<wbr>Data</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_GetInsight.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Get<wbr>Insight</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_Init.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Init</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_Load.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Load</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="types_message_request.MessageRequest_Load.html#action" class="tsd-kind-icon">action</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="types_message_request.MessageRequest_Load.html#data" class="tsd-kind-icon">data</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="types_message_request.MessageRequest_Load.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="types_message_request.MessageRequest_Load.html#insight" class="tsd-kind-icon">insight</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="types_message_request.MessageRequest_Load.html#props" class="tsd-kind-icon">props</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="types_message_request.MessageRequest_Load.html#ts" class="tsd-kind-icon">ts</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_Theme.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Theme</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#Actions" class="tsd-kind-icon">Actions</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#DataToLoad" class="tsd-kind-icon">Data<wbr>ToLoad</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#MessageRequest" class="tsd-kind-icon">Message<wbr>Request</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#MessageRequestWithSource" class="tsd-kind-icon">Message<wbr>Request<wbr>With<wbr>Source</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="overlay"></div>

174
docs/docs/sanddance-embed/v4/interfaces/types_message_request.MessageRequest_Theme.html Normal file
Просмотреть файл

@ -0,0 +1,174 @@
---
layout: typedoc
title: 'MessageRequest_Theme | @msrvida/sanddance-embed'
---
<header>
<div class="tsd-page-title">
<div class="typedoc-container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@msrvida/sanddance-embed</a>
</li>
<li>
<a href="../modules/types_message_request.html">types/message-request</a>
</li>
<li>
<a href="types_message_request.MessageRequest_Theme.html">MessageRequest_Theme</a>
</li>
</ul>
<h1>Interface MessageRequest_Theme</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="types_message_request.MessageRequestBase.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageRequestBase</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">MessageRequest_Theme</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="types_message_request.MessageRequest_Theme.html#action" class="tsd-kind-icon">action</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="types_message_request.MessageRequest_Theme.html#dark" class="tsd-kind-icon">dark</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="types_message_request.MessageRequest_Theme.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="types_message_request.MessageRequest_Theme.html#ts" class="tsd-kind-icon">ts</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="action" class="tsd-anchor"></a>
<h3>action</h3>
<div class="tsd-signature tsd-kind-icon">action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;theme&quot;</span></div>
<aside class="tsd-sources">
<p>Overrides <a href="types_message_request.MessageRequestBase.html">MessageRequestBase</a>.<a href="types_message_request.MessageRequestBase.html#action">action</a></p>
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L42">types/message-request.d.ts:42</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="dark" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> dark</h3>
<div class="tsd-signature tsd-kind-icon">dark<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L43">types/message-request.d.ts:43</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="id" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="types_message_request.MessageRequestBase.html">MessageRequestBase</a>.<a href="types_message_request.MessageRequestBase.html#id">id</a></p>
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L5">types/message-request.d.ts:5</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="ts" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ts</h3>
<div class="tsd-signature tsd-kind-icon">ts<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Date</span></div>
<aside class="tsd-sources">
<p>Inherited from <a href="types_message_request.MessageRequestBase.html">MessageRequestBase</a>.<a href="types_message_request.MessageRequestBase.html#ts">ts</a></p>
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L6">types/message-request.d.ts:6</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/sanddance_embed.html">sanddance-<wbr>embed</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/types_message_request.html">types/message-<wbr>request</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/types_message_response.html">types/message-<wbr>response</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary">
<ul class="before-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequestBase.html" class="tsd-kind-icon">Message<wbr>Request<wbr>Base</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_GetData.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Get<wbr>Data</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_GetInsight.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Get<wbr>Insight</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_Init.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Init</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_Load.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Load</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_request.MessageRequest_Theme.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Theme</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a href="types_message_request.MessageRequest_Theme.html#action" class="tsd-kind-icon">action</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="types_message_request.MessageRequest_Theme.html#dark" class="tsd-kind-icon">dark</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="types_message_request.MessageRequest_Theme.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="types_message_request.MessageRequest_Theme.html#ts" class="tsd-kind-icon">ts</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#Actions" class="tsd-kind-icon">Actions</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#DataToLoad" class="tsd-kind-icon">Data<wbr>ToLoad</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#MessageRequest" class="tsd-kind-icon">Message<wbr>Request</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_request.html#MessageRequestWithSource" class="tsd-kind-icon">Message<wbr>Request<wbr>With<wbr>Source</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="overlay"></div>

126
docs/docs/sanddance-embed/v4/interfaces/types_message_response.MessageResponseBase.html Normal file
Просмотреть файл

@ -0,0 +1,126 @@
---
layout: typedoc
title: 'MessageResponseBase | @msrvida/sanddance-embed'
---
<header>
<div class="tsd-page-title">
<div class="typedoc-container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@msrvida/sanddance-embed</a>
</li>
<li>
<a href="../modules/types_message_response.html">types/message-response</a>
</li>
<li>
<a href="types_message_response.MessageResponseBase.html">MessageResponseBase</a>
</li>
</ul>
<h1>Interface MessageResponseBase</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">MessageResponseBase</span>
<ul class="tsd-hierarchy">
<li>
<a href="types_message_response.MessageResponse_Init.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageResponse_Init</a>
</li>
<li>
<a href="types_message_response.MessageResponse_GetData.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageResponse_GetData</a>
</li>
<li>
<a href="types_message_response.MessageResponse_GetInsight.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageResponse_GetInsight</a>
</li>
<li>
<a href="types_message_response.MessageResponse_Theme.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageResponse_Theme</a>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="types_message_response.MessageResponseBase.html#request" class="tsd-kind-icon">request</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="request" class="tsd-anchor"></a>
<h3>request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <a href="../modules/types_message_request.html#MessageRequest" class="tsd-signature-type" data-tsd-kind="Type alias">MessageRequest</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-response.d.ts#L2">types/message-response.d.ts:2</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/sanddance_embed.html">sanddance-<wbr>embed</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/types_message_request.html">types/message-<wbr>request</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/types_message_response.html">types/message-<wbr>response</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponseBase.html" class="tsd-kind-icon">Message<wbr>Response<wbr>Base</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="types_message_response.MessageResponseBase.html#request" class="tsd-kind-icon">request</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponse_GetData.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Get<wbr>Data</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponse_GetInsight.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Get<wbr>Insight</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponse_Init.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Init</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponse_Theme.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Theme</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_response.html#MessageResponse" class="tsd-kind-icon">Message<wbr>Response</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="overlay"></div>

132
docs/docs/sanddance-embed/v4/interfaces/types_message_response.MessageResponse_GetData.html Normal file
Просмотреть файл

@ -0,0 +1,132 @@
---
layout: typedoc
title: 'MessageResponse_GetData | @msrvida/sanddance-embed'
---
<header>
<div class="tsd-page-title">
<div class="typedoc-container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@msrvida/sanddance-embed</a>
</li>
<li>
<a href="../modules/types_message_response.html">types/message-response</a>
</li>
<li>
<a href="types_message_response.MessageResponse_GetData.html">MessageResponse_GetData</a>
</li>
</ul>
<h1>Interface MessageResponse_GetData</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="types_message_response.MessageResponseBase.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageResponseBase</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">MessageResponse_GetData</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="types_message_response.MessageResponse_GetData.html#data" class="tsd-kind-icon">data</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="types_message_response.MessageResponse_GetData.html#request" class="tsd-kind-icon">request</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="data" class="tsd-anchor"></a>
<h3>data</h3>
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-response.d.ts#L8">types/message-response.d.ts:8</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="request" class="tsd-anchor"></a>
<h3>request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <a href="../modules/types_message_request.html#MessageRequest" class="tsd-signature-type" data-tsd-kind="Type alias">MessageRequest</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="types_message_response.MessageResponseBase.html">MessageResponseBase</a>.<a href="types_message_response.MessageResponseBase.html#request">request</a></p>
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-response.d.ts#L2">types/message-response.d.ts:2</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/sanddance_embed.html">sanddance-<wbr>embed</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/types_message_request.html">types/message-<wbr>request</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/types_message_response.html">types/message-<wbr>response</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary">
<ul class="before-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponseBase.html" class="tsd-kind-icon">Message<wbr>Response<wbr>Base</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponse_GetData.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Get<wbr>Data</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="types_message_response.MessageResponse_GetData.html#data" class="tsd-kind-icon">data</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="types_message_response.MessageResponse_GetData.html#request" class="tsd-kind-icon">request</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponse_GetInsight.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Get<wbr>Insight</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponse_Init.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Init</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponse_Theme.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Theme</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_response.html#MessageResponse" class="tsd-kind-icon">Message<wbr>Response</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="overlay"></div>

137
docs/docs/sanddance-embed/v4/interfaces/types_message_response.MessageResponse_GetInsight.html Normal file
Просмотреть файл

@ -0,0 +1,137 @@
---
layout: typedoc
title: 'MessageResponse_GetInsight | @msrvida/sanddance-embed'
---
<header>
<div class="tsd-page-title">
<div class="typedoc-container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@msrvida/sanddance-embed</a>
</li>
<li>
<a href="../modules/types_message_response.html">types/message-response</a>
</li>
<li>
<a href="types_message_response.MessageResponse_GetInsight.html">MessageResponse_GetInsight</a>
</li>
</ul>
<h1>Interface MessageResponse_GetInsight</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="types_message_response.MessageResponseBase.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageResponseBase</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">MessageResponse_GetInsight</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="types_message_response.MessageResponse_GetInsight.html#insight" class="tsd-kind-icon">insight</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="types_message_response.MessageResponse_GetInsight.html#request" class="tsd-kind-icon">request</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="insight" class="tsd-anchor"></a>
<h3>insight</h3>
<div class="tsd-signature tsd-kind-icon">insight<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-response.d.ts#L16">types/message-response.d.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>See <a href="https://microsoft.github.io/SandDance/docs/sanddance-specs/v1/interfaces/Insight.html">https://microsoft.github.io/SandDance/docs/sanddance-specs/v1/interfaces/Insight.html</a></p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="request" class="tsd-anchor"></a>
<h3>request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <a href="../modules/types_message_request.html#MessageRequest" class="tsd-signature-type" data-tsd-kind="Type alias">MessageRequest</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="types_message_response.MessageResponseBase.html">MessageResponseBase</a>.<a href="types_message_response.MessageResponseBase.html#request">request</a></p>
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-response.d.ts#L2">types/message-response.d.ts:2</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/sanddance_embed.html">sanddance-<wbr>embed</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/types_message_request.html">types/message-<wbr>request</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/types_message_response.html">types/message-<wbr>response</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary">
<ul class="before-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponseBase.html" class="tsd-kind-icon">Message<wbr>Response<wbr>Base</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponse_GetData.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Get<wbr>Data</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponse_GetInsight.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Get<wbr>Insight</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="types_message_response.MessageResponse_GetInsight.html#insight" class="tsd-kind-icon">insight</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="types_message_response.MessageResponse_GetInsight.html#request" class="tsd-kind-icon">request</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponse_Init.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Init</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponse_Theme.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Theme</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_response.html#MessageResponse" class="tsd-kind-icon">Message<wbr>Response</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="overlay"></div>

118
docs/docs/sanddance-embed/v4/interfaces/types_message_response.MessageResponse_Init.html Normal file
Просмотреть файл

@ -0,0 +1,118 @@
---
layout: typedoc
title: 'MessageResponse_Init | @msrvida/sanddance-embed'
---
<header>
<div class="tsd-page-title">
<div class="typedoc-container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@msrvida/sanddance-embed</a>
</li>
<li>
<a href="../modules/types_message_response.html">types/message-response</a>
</li>
<li>
<a href="types_message_response.MessageResponse_Init.html">MessageResponse_Init</a>
</li>
</ul>
<h1>Interface MessageResponse_Init</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="types_message_response.MessageResponseBase.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageResponseBase</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">MessageResponse_Init</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section tsd-is-inherited">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="types_message_response.MessageResponse_Init.html#request" class="tsd-kind-icon">request</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="request" class="tsd-anchor"></a>
<h3>request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <a href="../modules/types_message_request.html#MessageRequest" class="tsd-signature-type" data-tsd-kind="Type alias">MessageRequest</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="types_message_response.MessageResponseBase.html">MessageResponseBase</a>.<a href="types_message_response.MessageResponseBase.html#request">request</a></p>
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-response.d.ts#L2">types/message-response.d.ts:2</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/sanddance_embed.html">sanddance-<wbr>embed</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/types_message_request.html">types/message-<wbr>request</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/types_message_response.html">types/message-<wbr>response</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary">
<ul class="before-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponseBase.html" class="tsd-kind-icon">Message<wbr>Response<wbr>Base</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponse_GetData.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Get<wbr>Data</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponse_GetInsight.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Get<wbr>Insight</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponse_Init.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Init</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="types_message_response.MessageResponse_Init.html#request" class="tsd-kind-icon">request</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponse_Theme.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Theme</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_response.html#MessageResponse" class="tsd-kind-icon">Message<wbr>Response</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="overlay"></div>

132
docs/docs/sanddance-embed/v4/interfaces/types_message_response.MessageResponse_Theme.html Normal file
Просмотреть файл

@ -0,0 +1,132 @@
---
layout: typedoc
title: 'MessageResponse_Theme | @msrvida/sanddance-embed'
---
<header>
<div class="tsd-page-title">
<div class="typedoc-container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@msrvida/sanddance-embed</a>
</li>
<li>
<a href="../modules/types_message_response.html">types/message-response</a>
</li>
<li>
<a href="types_message_response.MessageResponse_Theme.html">MessageResponse_Theme</a>
</li>
</ul>
<h1>Interface MessageResponse_Theme</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="types_message_response.MessageResponseBase.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageResponseBase</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">MessageResponse_Theme</span>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="types_message_response.MessageResponse_Theme.html#request" class="tsd-kind-icon">request</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="types_message_response.MessageResponse_Theme.html#theme" class="tsd-kind-icon">theme</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a name="request" class="tsd-anchor"></a>
<h3>request</h3>
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <a href="../modules/types_message_request.html#MessageRequest" class="tsd-signature-type" data-tsd-kind="Type alias">MessageRequest</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="types_message_response.MessageResponseBase.html">MessageResponseBase</a>.<a href="types_message_response.MessageResponseBase.html#request">request</a></p>
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-response.d.ts#L2">types/message-response.d.ts:2</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="theme" class="tsd-anchor"></a>
<h3>theme</h3>
<div class="tsd-signature tsd-kind-icon">theme<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-response.d.ts#L20">types/message-response.d.ts:20</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/sanddance_embed.html">sanddance-<wbr>embed</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/types_message_request.html">types/message-<wbr>request</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/types_message_response.html">types/message-<wbr>response</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary">
<ul class="before-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponseBase.html" class="tsd-kind-icon">Message<wbr>Response<wbr>Base</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponse_GetData.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Get<wbr>Data</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponse_GetInsight.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Get<wbr>Insight</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponse_Init.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Init</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="types_message_response.MessageResponse_Theme.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Theme</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
<a href="types_message_response.MessageResponse_Theme.html#request" class="tsd-kind-icon">request</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="types_message_response.MessageResponse_Theme.html#theme" class="tsd-kind-icon">theme</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="../modules/types_message_response.html#MessageResponse" class="tsd-kind-icon">Message<wbr>Response</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="overlay"></div>

54
docs/docs/sanddance-embed/v4/modules.html Normal file
Просмотреть файл

@ -0,0 +1,54 @@
---
layout: typedoc
title: '@msrvida/sanddance-embed'
---
<header>
<div class="tsd-page-title">
<div class="typedoc-container">
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Modules</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-module"><a href="modules/sanddance_embed.html" class="tsd-kind-icon">sanddance-<wbr>embed</a></li>
<li class="tsd-kind-module"><a href="modules/types_message_request.html" class="tsd-kind-icon">types/message-<wbr>request</a></li>
<li class="tsd-kind-module"><a href="modules/types_message_response.html" class="tsd-kind-icon">types/message-<wbr>response</a></li>
</ul>
</section>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="current ">
<a href="modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/sanddance_embed.html">sanddance-<wbr>embed</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/types_message_request.html">types/message-<wbr>request</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/types_message_response.html">types/message-<wbr>response</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary">
<ul class="before-current">
</ul>
</nav>
</div>
</div>
</div>
<div class="overlay"></div>

236
docs/docs/sanddance-embed/v4/modules/sanddance_embed.SandDanceEmbed.html Normal file
Просмотреть файл

@ -0,0 +1,236 @@
---
layout: typedoc
title: 'SandDanceEmbed | @msrvida/sanddance-embed'
---
<header>
<div class="tsd-page-title">
<div class="typedoc-container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@msrvida/sanddance-embed</a>
</li>
<li>
<a href="sanddance_embed.html">sanddance-embed</a>
</li>
<li>
<a href="sanddance_embed.SandDanceEmbed.html">SandDanceEmbed</a>
</li>
</ul>
<h1>Namespace SandDanceEmbed</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="sanddance_embed.SandDanceEmbed.html#deps" class="tsd-kind-icon">deps</a></li>
<li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="sanddance_embed.SandDanceEmbed.html#requests" class="tsd-kind-icon">requests</a></li>
<li class="tsd-kind-variable tsd-parent-kind-namespace"><a href="sanddance_embed.SandDanceEmbed.html#sandDanceExplorer" class="tsd-kind-icon">sand<wbr>Dance<wbr>Explorer</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="sanddance_embed.SandDanceEmbed.html#changeColorScheme" class="tsd-kind-icon">change<wbr>Color<wbr>Scheme</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="sanddance_embed.SandDanceEmbed.html#defaultDependencies" class="tsd-kind-icon">default<wbr>Dependencies</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="sanddance_embed.SandDanceEmbed.html#getDependencies" class="tsd-kind-icon">get<wbr>Dependencies</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="sanddance_embed.SandDanceEmbed.html#load" class="tsd-kind-icon">load</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="sanddance_embed.SandDanceEmbed.html#respondToRequest" class="tsd-kind-icon">respond<wbr>ToRequest</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace">
<a name="deps" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagLet">Let</span> deps</h3>
<div class="tsd-signature tsd-kind-icon">deps<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EmbedDependency</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/sanddance-embed.ts#L55">sanddance-embed.ts:55</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace">
<a name="requests" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagConst">Const</span> requests</h3>
<div class="tsd-signature tsd-kind-icon">requests<span class="tsd-signature-symbol">:</span> <a href="types_message_request.html#MessageRequestWithSource" class="tsd-signature-type" data-tsd-kind="Type alias">MessageRequestWithSource</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/sanddance-embed.ts#L125">sanddance-embed.ts:125</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-namespace">
<a name="sandDanceExplorer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagLet">Let</span> sand<wbr>Dance<wbr>Explorer</h3>
<div class="tsd-signature tsd-kind-icon">sand<wbr>Dance<wbr>Explorer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">SandDanceExplorer.Explorer_Class</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/sanddance-embed.ts#L124">sanddance-embed.ts:124</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="changeColorScheme" class="tsd-anchor"></a>
<h3>change<wbr>Color<wbr>Scheme</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">change<wbr>Color<wbr>Scheme<span class="tsd-signature-symbol">(</span>darkTheme<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/sanddance-embed.ts#L182">sanddance-embed.ts:182</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>darkTheme: <span class="tsd-signature-type">boolean</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="defaultDependencies" class="tsd-anchor"></a>
<h3>default<wbr>Dependencies</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">default<wbr>Dependencies<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EmbedDependency</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/sanddance-embed.ts#L11">sanddance-embed.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EmbedDependency</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="getDependencies" class="tsd-anchor"></a>
<h3>get<wbr>Dependencies</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">get<wbr>Dependencies<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">EmbedDependency</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/sanddance-embed.ts#L44">sanddance-embed.ts:44</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">EmbedDependency</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="load" class="tsd-anchor"></a>
<h3>load</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">load<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="types_message_request.html#DataToLoad" class="tsd-signature-type" data-tsd-kind="Type alias">DataToLoad</a>, insight<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SandDanceExplorer.SandDance.specs.Insight</span><span class="tsd-signature-symbol">&gt;</span>, props<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">SandDanceExplorer.Props</span><span class="tsd-signature-symbol">)</span><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">unknown</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/sanddance-embed.ts#L129">sanddance-embed.ts:129</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>data: <a href="types_message_request.html#DataToLoad" class="tsd-signature-type" data-tsd-kind="Type alias">DataToLoad</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> insight: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SandDanceExplorer.SandDance.specs.Insight</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> props: <span class="tsd-signature-type">SandDanceExplorer.Props</span></h5>
</li>
</ul>
<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">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="respondToRequest" class="tsd-anchor"></a>
<h3>respond<wbr>ToRequest</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">respond<wbr>ToRequest<span class="tsd-signature-symbol">(</span>requestWithSource<span class="tsd-signature-symbol">: </span><a href="types_message_request.html#MessageRequestWithSource" class="tsd-signature-type" data-tsd-kind="Type alias">MessageRequestWithSource</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/sanddance-embed.ts#L195">sanddance-embed.ts:195</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>requestWithSource: <a href="types_message_request.html#MessageRequestWithSource" class="tsd-signature-type" data-tsd-kind="Type alias">MessageRequestWithSource</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary">
<ul class="before-current">
<li class=" tsd-kind-variable tsd-parent-kind-namespace">
<a href="sanddance_embed.SandDanceEmbed.html#deps" class="tsd-kind-icon">deps</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-namespace">
<a href="sanddance_embed.SandDanceEmbed.html#requests" class="tsd-kind-icon">requests</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-namespace">
<a href="sanddance_embed.SandDanceEmbed.html#sandDanceExplorer" class="tsd-kind-icon">sand<wbr>Dance<wbr>Explorer</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="sanddance_embed.SandDanceEmbed.html#changeColorScheme" class="tsd-kind-icon">change<wbr>Color<wbr>Scheme</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="sanddance_embed.SandDanceEmbed.html#defaultDependencies" class="tsd-kind-icon">default<wbr>Dependencies</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="sanddance_embed.SandDanceEmbed.html#getDependencies" class="tsd-kind-icon">get<wbr>Dependencies</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="sanddance_embed.SandDanceEmbed.html#load" class="tsd-kind-icon">load</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="sanddance_embed.SandDanceEmbed.html#respondToRequest" class="tsd-kind-icon">respond<wbr>ToRequest</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="overlay"></div>

61
docs/docs/sanddance-embed/v4/modules/sanddance_embed.html Normal file
Просмотреть файл

@ -0,0 +1,61 @@
---
layout: typedoc
title: 'sanddance-embed | @msrvida/sanddance-embed'
---
<header>
<div class="tsd-page-title">
<div class="typedoc-container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@msrvida/sanddance-embed</a>
</li>
<li>
<a href="sanddance_embed.html">sanddance-embed</a>
</li>
</ul>
<h1>Module sanddance-embed</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Namespaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-namespace tsd-parent-kind-module"><a href="sanddance_embed.SandDanceEmbed.html" class="tsd-kind-icon">Sand<wbr>Dance<wbr>Embed</a></li>
</ul>
</section>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class="current tsd-kind-module">
<a href="sanddance_embed.html">sanddance-<wbr>embed</a>
</li>
<li class=" tsd-kind-module">
<a href="types_message_request.html">types/message-<wbr>request</a>
</li>
<li class=" tsd-kind-module">
<a href="types_message_response.html">types/message-<wbr>response</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary">
<ul class="before-current">
</ul>
</nav>
</div>
</div>
</div>
<div class="overlay"></div>

153
docs/docs/sanddance-embed/v4/modules/types_message_request.html Normal file
Просмотреть файл

@ -0,0 +1,153 @@
---
layout: typedoc
title: 'types/message-request | @msrvida/sanddance-embed'
---
<header>
<div class="tsd-page-title">
<div class="typedoc-container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@msrvida/sanddance-embed</a>
</li>
<li>
<a href="types_message_request.html">types/message-request</a>
</li>
</ul>
<h1>Module types/message-request</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/types_message_request.MessageRequestBase.html" class="tsd-kind-icon">Message<wbr>Request<wbr>Base</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/types_message_request.MessageRequest_GetData.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Get<wbr>Data</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/types_message_request.MessageRequest_GetInsight.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Get<wbr>Insight</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/types_message_request.MessageRequest_Init.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Init</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/types_message_request.MessageRequest_Load.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Load</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/types_message_request.MessageRequest_Theme.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Theme</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types_message_request.html#Actions" class="tsd-kind-icon">Actions</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types_message_request.html#DataToLoad" class="tsd-kind-icon">Data<wbr>ToLoad</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types_message_request.html#MessageRequest" class="tsd-kind-icon">Message<wbr>Request</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types_message_request.html#MessageRequestWithSource" class="tsd-kind-icon">Message<wbr>Request<wbr>With<wbr>Source</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Type aliases</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
<a name="Actions" class="tsd-anchor"></a>
<h3>Actions</h3>
<div class="tsd-signature tsd-kind-icon">Actions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;init&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;load&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;getData&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;getInsight&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L1">types/message-request.d.ts:1</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
<a name="DataToLoad" class="tsd-anchor"></a>
<h3>Data<wbr>ToLoad</h3>
<div class="tsd-signature tsd-kind-icon">Data<wbr>ToLoad<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">SandDanceExplorer.DataFile</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L16">types/message-request.d.ts:16</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>See <a href="https://microsoft.github.io/SandDance/docs/sanddance-explorer/v4/interfaces/DataFile.html">https://microsoft.github.io/SandDance/docs/sanddance-explorer/v4/interfaces/DataFile.html</a></p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
<a name="MessageRequest" class="tsd-anchor"></a>
<h3>Message<wbr>Request</h3>
<div class="tsd-signature tsd-kind-icon">Message<wbr>Request<span class="tsd-signature-symbol">:</span> <a href="../interfaces/types_message_request.MessageRequest_Init.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageRequest_Init</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types_message_request.MessageRequest_Load.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageRequest_Load</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types_message_request.MessageRequest_GetData.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageRequest_GetData</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types_message_request.MessageRequest_GetInsight.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageRequest_GetInsight</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types_message_request.MessageRequest_Theme.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageRequest_Theme</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L46">types/message-request.d.ts:46</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
<a name="MessageRequestWithSource" class="tsd-anchor"></a>
<h3>Message<wbr>Request<wbr>With<wbr>Source</h3>
<div class="tsd-signature tsd-kind-icon">Message<wbr>Request<wbr>With<wbr>Source<span class="tsd-signature-symbol">:</span> <a href="types_message_request.html#MessageRequest" class="tsd-signature-type" data-tsd-kind="Type alias">MessageRequest</a><span class="tsd-signature-symbol"> &amp; </span><span class="tsd-signature-symbol">{ </span>source<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">WindowProxy</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts#L48">types/message-request.d.ts:48</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="sanddance_embed.html">sanddance-<wbr>embed</a>
</li>
<li class="current tsd-kind-module">
<a href="types_message_request.html">types/message-<wbr>request</a>
</li>
<li class=" tsd-kind-module">
<a href="types_message_response.html">types/message-<wbr>response</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary">
<ul class="before-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/types_message_request.MessageRequestBase.html" class="tsd-kind-icon">Message<wbr>Request<wbr>Base</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/types_message_request.MessageRequest_GetData.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Get<wbr>Data</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/types_message_request.MessageRequest_GetInsight.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Get<wbr>Insight</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/types_message_request.MessageRequest_Init.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Init</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/types_message_request.MessageRequest_Load.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Load</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/types_message_request.MessageRequest_Theme.html" class="tsd-kind-icon">Message<wbr>Request_<wbr><wbr>Theme</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="types_message_request.html#Actions" class="tsd-kind-icon">Actions</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="types_message_request.html#DataToLoad" class="tsd-kind-icon">Data<wbr>ToLoad</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="types_message_request.html#MessageRequest" class="tsd-kind-icon">Message<wbr>Request</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="types_message_request.html#MessageRequestWithSource" class="tsd-kind-icon">Message<wbr>Request<wbr>With<wbr>Source</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="overlay"></div>

102
docs/docs/sanddance-embed/v4/modules/types_message_response.html Normal file
Просмотреть файл

@ -0,0 +1,102 @@
---
layout: typedoc
title: 'types/message-response | @msrvida/sanddance-embed'
---
<header>
<div class="tsd-page-title">
<div class="typedoc-container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@msrvida/sanddance-embed</a>
</li>
<li>
<a href="types_message_response.html">types/message-response</a>
</li>
</ul>
<h1>Module types/message-response</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/types_message_response.MessageResponseBase.html" class="tsd-kind-icon">Message<wbr>Response<wbr>Base</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/types_message_response.MessageResponse_GetData.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Get<wbr>Data</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/types_message_response.MessageResponse_GetInsight.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Get<wbr>Insight</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/types_message_response.MessageResponse_Init.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Init</a></li>
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/types_message_response.MessageResponse_Theme.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Theme</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="types_message_response.html#MessageResponse" class="tsd-kind-icon">Message<wbr>Response</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Type aliases</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module">
<a name="MessageResponse" class="tsd-anchor"></a>
<h3>Message<wbr>Response</h3>
<div class="tsd-signature tsd-kind-icon">Message<wbr>Response<span class="tsd-signature-symbol">:</span> <a href="../interfaces/types_message_response.MessageResponse_Init.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageResponse_Init</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types_message_response.MessageResponse_GetData.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageResponse_GetData</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types_message_response.MessageResponse_GetInsight.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageResponse_GetInsight</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/types_message_response.MessageResponse_Theme.html" class="tsd-signature-type" data-tsd-kind="Interface">MessageResponse_Theme</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-response.d.ts#L23">types/message-response.d.ts:23</a></li>
</ul>
</aside>
</section>
</section>
</div>
<div class="col-4 col-menu menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="sanddance_embed.html">sanddance-<wbr>embed</a>
</li>
<li class=" tsd-kind-module">
<a href="types_message_request.html">types/message-<wbr>request</a>
</li>
<li class="current tsd-kind-module">
<a href="types_message_response.html">types/message-<wbr>response</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary">
<ul class="before-current">
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/types_message_response.MessageResponseBase.html" class="tsd-kind-icon">Message<wbr>Response<wbr>Base</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/types_message_response.MessageResponse_GetData.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Get<wbr>Data</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/types_message_response.MessageResponse_GetInsight.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Get<wbr>Insight</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/types_message_response.MessageResponse_Init.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Init</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/types_message_response.MessageResponse_Theme.html" class="tsd-kind-icon">Message<wbr>Response_<wbr><wbr>Theme</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module">
<a href="types_message_response.html#MessageResponse" class="tsd-kind-icon">Message<wbr>Response</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="overlay"></div>

125
packages/sanddance-embed/README.md Normal file
Просмотреть файл

@ -0,0 +1,125 @@
# @msrvida/sanddance-embed
SandDance Embed is the easiest way to integrate [SandDance](https://microsoft.github.io/SandDance/) into your custom app, via an `<iframe>` tag. SandDance Embed is a wrapper around SandDance Explorer, plus [postMessage](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage) handlers to load data and manage its display from outside the iframe.
![image](https://user-images.githubusercontent.com/11507384/72197128-a99cdd80-33d2-11ea-9b49-5d470db0abc1.png)
There are two ways to create a SandDance Embed iframe instance:
1. Cross-domain
2. In-domain
## Cross-domain iframe
This is the simplest approach. Add an `<iframe>` tag in your HTML page:
```html
<iframe id="embedIframe" src="https://microsoft.github.io/SandDance/embed/v4/sanddance-embed.html" style="height:700px;width:100%"></iframe>
```
Get a code reference to this iframe:
```js
const embedIframe = document.getElementById('embedIframe');
embedIframe.onload = () => {
//ready to send commands to SandDance Embed
}
```
*Note the version number in the address to specify by major version. You may style the iframe as you see fit.*
*Security: The URL is hosted by the secure [SandDance GitHub Pages website](https://github.com/microsoft/SandDance/tree/master/docs/embed).*
*Privacy: The page does not collect any data that you pass to SandDance Embed.*
## In-domain iframe
In JavaScript, create a SandDance Embed iframe and await it to be ready:
```js
const embedPromise = new Promise((resolve, reject) => {
const embedIframe = document.createElement('iframe');
embedIframe.style.height = '700px';
embedIframe.style.width = '1000px'
embedIframe.onload = () => {
const embedScript = embedIframe.contentDocument.createElement('script');
embedScript.src = 'https://unpkg.com/@msrvida/sanddance-embed@4/dist/umd/sanddance-embed.js';
embedIframe.contentDocument.head.appendChild(embedScript);
embedScript.onload = () => resolve(embedIframe);
embedScript.onerror = reject;
};
document.body.appendChild(embedIframe);
});
```
This promise provides you `embedIframe` when it is available:
```js
embedPromise.then((embedIframe) => {
//ready to send commands to SandDance Embed
});
```
## Send commands to SandDance Embed
Use `postMessage` to communicate with `embedIframe.contentWindow`. For all command requests, see https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-request.d.ts
* Load data and display initial chart:
```js
const data = [
{ x: 0, y: 0, z: 0 },
{ x: 1, y: 1, z: 1 },
{ x: 2, y: 2, z: 2 },
];
embedIframe.contentWindow.postMessage({ action: 'load', data, props: { theme: 'dark-theme' } }, '*');
```
The `data` variable can be an array, or a [DataFile object](https://microsoft.github.io/SandDance/docs/sanddance-explorer/v4/interfaces/DataFile.html). The `props` member is optional [Explorer Props](https://microsoft.github.io/SandDance/docs/sanddance-explorer/v4/interfaces/Props.html), here is shown used to specify the dark color theme.
* Get insight:
```js
embedIframe.contentWindow.postMessage({ action: 'getInsight' }, '*');
```
* Get or set theme:
```js
embedIframe.contentWindow.postMessage({ action: 'theme', dark: true }, '*');
```
## Receive commands from SandDance Embed
Attach a listener to your own window to observe message passing:
```js
window.onmessage = (e) => {
console.log('messaged', e.data);
};
```
The message will contain a property `request` which is a clone of the requesting message object which instigated the response. Other properties vary depending on the type of request. For all command responses, see https://github.com/microsoft/SandDance/blob/master/packages/sanddance-embed/src/types/message-response.d.ts
Here is an example of the response for `getInsight`:
```json
{
"request": {
"action": "getInsight"
},
"insight": {
"colorBin": null,
"columns": {
"x": "x",
"y": "y"
},
"facetStyle": "wrap",
"filter": null,
"hideAxes": false,
"hideLegend": false,
"signalValues": {
"RoleZ_ProportionSignal": 0.6,
"Text_ScaleSignal": 1.2,
"RoleColor_BinCountSignal": 7,
"RoleColor_ReverseSignal": false,
"Chart_PointScaleSignal": 5,
"RoleZ_Grounded": false
},
"size": {
"height": 663,
"width": 700
},
"totalStyle": null,
"transform": null,
"chart": "scatterplot",
"view": "2d"
}
}
```
## For more information
Please visit the [SandDance website](https://microsoft.github.io/SandDance/).

4
packages/sanddance-embed/package-lock.json сгенерированный
Просмотреть файл

@ -1,12 +1,12 @@
{
"name": "@msrvida/sanddance-embed",
"version": "4.3.0",
"version": "4.4.0",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "@msrvida/sanddance-embed",
"version": "4.3.0",
"version": "4.4.0",
"license": "MIT",
"devDependencies": {
"@fluentui/react": "^8",

3
packages/sanddance-embed/package.json
Просмотреть файл

@ -1,6 +1,6 @@
{
"name": "@msrvida/sanddance-embed",
"version": "4.3.0",
"version": "4.4.0",
"description": "Embeddable SandDance Explorer.",
"browser": "dist/umd/sanddance-embed.js",
"repository": {
@ -13,6 +13,7 @@
],
"scripts": {
"eslint": "eslint -c ../../.eslintrc.json --fix ./src/**/*.ts*",
"docs": "typedoc src/sanddance-embed.ts src/types/message-request.d.ts src/types/message-response.d.ts -out ../../docs/docs/sanddance-embed/v4 --theme ../../typedoc/theme --excludePrivate --gitRevision master --disableOutputCheck",
"build-css": "sass ./src/css/sanddance-embed.scss ./dist/css/sanddance-embed.css",
"build-typescript": "tsc -p .",
"build:sanddance-core": "npm run build-css && npm run build-typescript"

44
packages/sanddance-embed/src/sanddance-embed.ts
Просмотреть файл

@ -3,11 +3,11 @@
* Licensed under the MIT License.
*/
declare let vega: SandDanceExplorer.SandDance.VegaMorphCharts.types.VegaBase;
declare let FluentUIReact: _FluentUI.FluentUIComponents;
namespace SandDanceEmbed {
declare let vega: SandDanceExplorer.SandDance.VegaMorphCharts.types.VegaBase;
declare let FluentUIReact: _FluentUI.FluentUIComponents;
export function defaultDependencies(): EmbedDependency[] {
return [
{
@ -142,6 +142,13 @@ namespace SandDanceEmbed {
creating = true;
prepare.then(() => {
SandDanceExplorer.use(FluentUIReact, React, ReactDOM, vega);
const theme = props?.theme || '';
if (theme) {
FluentUIReact.loadTheme({ palette: SandDanceExplorer.themePalettes[theme] });
}
const viewerOptions = getViewerOptions(theme, props?.viewerOptions);
const explorerProps: SandDanceExplorer.Props = {
logoClickUrl: 'https://microsoft.github.io/SandDance/',
...props,
@ -151,6 +158,7 @@ namespace SandDanceEmbed {
innerLoad();
props?.mounted && props.mounted(explorer);
},
viewerOptions,
};
ReactDOM.render(React.createElement(SandDanceExplorer.Explorer, explorerProps), document.body);
});
@ -164,6 +172,26 @@ namespace SandDanceEmbed {
});
}
function getViewerOptions(theme: string, viewerOptions: Partial<SandDanceExplorer.SandDance.types.ViewerOptions>): Partial<SandDanceExplorer.ViewerOptions> {
return {
...viewerOptions,
colors: SandDanceExplorer.getColorSettingsFromThemePalette(SandDanceExplorer.themePalettes[theme]),
};
}
export function changeColorScheme(darkTheme: boolean) {
const theme = darkTheme ? 'dark-theme' : '';
FluentUIReact.loadTheme({ palette: SandDanceExplorer.themePalettes[theme] });
const viewerOptions = getViewerOptions(theme, sandDanceExplorer.viewerOptions);
vega.scheme(SandDanceExplorer.SandDance.constants.ColorScaleNone, () => viewerOptions.colors.defaultCube);
sandDanceExplorer.updateViewerOptions(viewerOptions);
sandDanceExplorer.viewer.renderSameLayout(viewerOptions);
const props: SandDanceExplorer.Props = { ...sandDanceExplorer.props, theme, viewerOptions };
ReactDOM.render(React.createElement(SandDanceExplorer.Explorer, props), document.body);
}
export function respondToRequest(requestWithSource: MessageRequestWithSource) {
requests.push(requestWithSource);
const copy: MessageRequestWithSource = { ...requestWithSource };
@ -203,6 +231,16 @@ namespace SandDanceEmbed {
};
break;
}
case 'theme': {
const request_theme = request as MessageRequest_Theme;
if (request_theme.dark !== undefined) {
changeColorScheme(request_theme.dark);
}
response = <MessageResponse_Theme>{
request,
theme: sandDanceExplorer.props.theme,
};
}
}
prepare.then(() => {
if (response) {

8
packages/sanddance-embed/src/types/deps.d.ts поставляемый Normal file
Просмотреть файл

@ -0,0 +1,8 @@
type EmbedDependencyType = 'script' | 'stylesheet';
interface EmbedDependency {
url: string;
type: EmbedDependencyType;
loaded?: boolean;
existed?: boolean;
}

47
packages/sanddance-embed/src/types/message.d.ts → packages/sanddance-embed/src/types/message-request.d.ts поставляемый
Просмотреть файл

@ -1,14 +1,3 @@
/// requests
type EmbedDependencyType = 'script' | 'stylesheet';
interface EmbedDependency {
url: string;
type: EmbedDependencyType;
loaded?: boolean;
existed?: boolean;
}
type Actions = 'init' | 'load' | 'getData' | 'getInsight';
interface MessageRequestBase {
@ -21,12 +10,23 @@ interface MessageRequest_Init extends MessageRequestBase {
action: 'init';
}
/**
* See https://microsoft.github.io/SandDance/docs/sanddance-explorer/v4/interfaces/DataFile.html
*/
type DataToLoad = object[] | SandDanceExplorer.DataFile;
interface MessageRequest_Load extends MessageRequestBase {
action: 'load';
data: DataToLoad;
/**
* See https://microsoft.github.io/SandDance/docs/sanddance-specs/v1/interfaces/Insight.html
*/
insight?: Partial<SandDance.types.Insight>;
/**
* See https://microsoft.github.io/SandDance/docs/sanddance-explorer/v4/interfaces/Props.html
*/
props?: SandDanceExplorer.Props;
}
@ -38,24 +38,11 @@ interface MessageRequest_GetInsight extends MessageRequestBase {
action: 'getInsight';
}
type MessageRequest = MessageRequest_Init | MessageRequest_Load | MessageRequest_GetData | MessageRequest_GetInsight;
interface MessageRequest_Theme extends MessageRequestBase {
action: 'theme';
dark?: boolean;
}
type MessageRequest = MessageRequest_Init | MessageRequest_Load | MessageRequest_GetData | MessageRequest_GetInsight | MessageRequest_Theme;
type MessageRequestWithSource = MessageRequest & { source: WindowProxy };
/// responses
interface MessageResponseBase {
request: MessageRequest;
}
interface MessageResponse_Init extends MessageResponseBase { }
interface MessageResponse_GetData extends MessageResponseBase {
data: object[];
}
interface MessageResponse_GetInsight extends MessageResponseBase {
insight: SandDanceExplorer.SandDance.types.Insight;
}
type MessageResponse = MessageResponse_Init | MessageResponse_GetData | MessageResponse_GetInsight;

23
packages/sanddance-embed/src/types/message-response.d.ts поставляемый Normal file
Просмотреть файл

@ -0,0 +1,23 @@
interface MessageResponseBase {
request: MessageRequest;
}
interface MessageResponse_Init extends MessageResponseBase { }
interface MessageResponse_GetData extends MessageResponseBase {
data: object[];
}
interface MessageResponse_GetInsight extends MessageResponseBase {
/**
* See https://microsoft.github.io/SandDance/docs/sanddance-specs/v1/interfaces/Insight.html
*/
insight: SandDanceExplorer.SandDance.types.Insight;
}
interface MessageResponse_Theme extends MessageResponseBase {
theme: string;
}
type MessageResponse = MessageResponse_Init | MessageResponse_GetData | MessageResponse_GetInsight | MessageResponse_Theme;

77
packages/sanddance-embed/test/indomain.html Normal file
Просмотреть файл

@ -0,0 +1,77 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>sanddance test</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body>
<header>
<h1>sanddance embed test</h1>
</header>
<script>
window.onmessage = (e) => {
console.log('messaged', e.data);
};
//create a SandDance Embed iframe, await it to be ready
const embedPromise = new Promise((resolve, reject) => {
const embedIframe = document.createElement('iframe');
embedIframe.style.height = '700px';
embedIframe.style.width = '1000px'
embedIframe.onload = (e) => {
const embedScript = embedIframe.contentDocument.createElement('script');
embedScript.src = 'https://unpkg.com/@msrvida/sanddance-embed@4/dist/umd/sanddance-embed.js';
embedIframe.contentDocument.head.appendChild(embedScript);
embedScript.onload = () => resolve(embedIframe);
embedScript.onerror = reject;
};
document.body.appendChild(embedIframe);
});
embedPromise.then((embedIframe) => {
const data = [
{ x: 0, y: 0, z: 0 },
{ x: 1, y: 1, z: 1 },
{ x: 2, y: 2, z: 2 },
];
//send to SandDance Embed
embedIframe.contentWindow.postMessage({ action: 'load', data }, '*');
const button1 = document.getElementById('button1');
button1.onclick = () => {
embedIframe.contentWindow.postMessage({ action: 'getInsight' }, '*');
};
const button2 = document.getElementById('button2');
button2.onclick = () => {
fetch('https://microsoft.github.io/SandDance/sample-data/titanicmaster.tsv')
.then(response => response.text())
.then(rawText => {
const data = { rawText, type: 'tsv' };
//send to SandDance Embed
embedIframe.contentWindow.postMessage({ action: 'load', data }, '*');
});
};
});
</script>
<div>
<button id="button1">Get insight</button>
<button id="button2">Load Titanic data</button>
</div>
</body>
</html>

15
packages/sanddance-embed/test/test.html
Просмотреть файл

@ -15,6 +15,10 @@
<iframe id="embed" title="embed" style="width: 90%; height: 700px"></iframe>
<div>
<button id="button1">toggle dark theme</button>
</div>
<script>
const deps = [
{
@ -51,17 +55,24 @@
};
const embedIframe = document.getElementById('embed');
embedIframe.onload = () => {
const embedWindow = embedIframe.contentWindow;
fetch('https://microsoft.github.io/SandDance/sample-data/titanicmaster.tsv')
.then(response => response.text())
.then(rawText => {
const data = { rawText, type: 'tsv' };
embedWindow.postMessage({ action: 'load', data }, '*');
embedIframe.contentWindow.postMessage({ action: 'load', data, props: { theme: 'dark-theme' } }, '*');
});
};
const testLocal = true;
const localQs = testLocal ? `?${encodeURIComponent(JSON.stringify(deps))}` : '';
embedIframe.src = 'sanddance-embed.html' + localQs;
let dark = false;
const button1 = document.getElementById('button1');
button1.onclick = () => {
dark = !dark;
embedIframe.contentWindow.postMessage({ action: 'theme', dark }, '*');
};
</script>
</body>

16
scripts/readme.js
Просмотреть файл

@ -7,21 +7,6 @@ function liquid(layout, title) {
return `---\nlayout: ${layout}\ntitle: '${title}'\n---\n\n`;
}
function copyReadme(title, packageRoot, packageDir, docRoot, version, fileNameIn, fileNameOut) {
const docRootPath = path.resolve(docRoot, packageDir);
if (!fs.existsSync(docRootPath)) return;
const readMePath = path.resolve(packageRoot, packageDir, fileNameIn);
if (!fs.existsSync(readMePath)) {
console.log(`no readme for ${packageDir} at ${readMePath}`);
return;
}
let readme = fs.readFileSync(readMePath, 'utf8');
readme = rewriteURLs(readme);
readme = liquid('docs', title) + readme;
fs.writeFileSync(path.resolve(docRootPath, version, fileNameOut), readme, 'utf8');
console.log(`readme copied for ${packageDir}`);
}
function convertHomePage() {
const readmeMarkdown = fs.readFileSync('./README.md', 'UTF8');
const html = liquid('page', 'Home') + rewriteURLs(marked(readmeMarkdown));
@ -35,6 +20,7 @@ const map = {
"packages/sanddance-specs/README.md": `/SandDance${tree.Components.filter(c=>c.tree==='sanddance-specs')[0].url}/`,
"packages/sanddance-react/README.md": `/SandDance${tree.Components.filter(c=>c.tree==='sanddance-react')[0].url}/`,
"packages/sanddance-explorer/README.md": `/SandDance${tree.Components.filter(c=>c.tree==='sanddance-explorer')[0].url}/`,
"packages/sanddance-embed/README.md": `/SandDance${tree.Components.filter(c=>c.tree==='sanddance-embed')[0].url}/`,
"packages/vega-deck.gl/README.md": `/SandDance${tree.Components.filter(c=>c.tree==='vega-deck.gl')[0].url}/`,
"packages/vega-morphcharts/README.md": `/SandDance${tree.Components.filter(c=>c.tree==='vega-morphcharts')[0].url}/`,
};