@disy/cadenza.js 1.3.0 → 1.4.0

package/apidoc/classes/CadenzaClient.html

@@ -31,7 +31,7 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
 <ul class="tsd-hierarchy">
 <li><span class="target">CadenzaClient</span></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L93">src/cadenza.js:93</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L97">src/cadenza.js:97</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -79,43 +79,43 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
 <div class="tsd-signature"><span class="tsd-kind-property">#base<wbr/>Url</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L95">src/cadenza.js:95</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L99">src/cadenza.js:99</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="_debug" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#debug</span><a href="#_debug" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">#debug</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L110">src/cadenza.js:110</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L114">src/cadenza.js:114</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="_iframe" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#iframe</span><a href="#_iframe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">#iframe</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">HTMLIFrameElement</span></div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L101">src/cadenza.js:101</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L105">src/cadenza.js:105</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="_iframeElement" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#iframe<wbr/>Element</span><a href="#_iframeElement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">#iframe<wbr/>Element</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">HTMLIFrameElement</span></div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L107">src/cadenza.js:107</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L111">src/cadenza.js:111</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="_origin" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#origin</span><a href="#_origin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">#origin</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L98">src/cadenza.js:98</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L102">src/cadenza.js:102</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="_subscriptions" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#subscriptions</span><a href="#_subscriptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">#subscriptions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L113">src/cadenza.js:113</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L117">src/cadenza.js:117</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="_webApplication" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#web<wbr/>Application</span><a href="#_webApplication" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">#web<wbr/>Application</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ExternalLinkKey.html" class="tsd-signature-type tsd-kind-interface">ExternalLinkKey</a></div>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L104">src/cadenza.js:104</a></li></ul></aside></section></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L108">src/cadenza.js:108</a></li></ul></aside></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Accessors</h2>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="_requiredIframe" class="tsd-anchor"></a>
@@ -125,7 +125,7 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
 <li class="tsd-description">
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">HTMLIFrameElement</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L165">src/cadenza.js:165</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L169">src/cadenza.js:169</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="baseUrl" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>base<wbr/>Url</span><a href="#baseUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <ul class="tsd-signatures">
@@ -136,7 +136,7 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L147">src/cadenza.js:147</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L151">src/cadenza.js:151</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="iframe" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>iframe</span><a href="#iframe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <ul class="tsd-signatures">
@@ -147,7 +147,7 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">HTMLIFrameElement</span></h4>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L152">src/cadenza.js:152</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L156">src/cadenza.js:156</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="_createUrl" class="tsd-anchor"></a>
@@ -164,7 +164,7 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
 <h5><span class="tsd-kind-parameter">params</span>: <span class="tsd-signature-type ">URLSearchParams</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">URL</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L552">src/cadenza.js:552</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L565">src/cadenza.js:565</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="_download" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#download</span><a href="#_download" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-is-private">
@@ -179,7 +179,7 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
 <h5><span class="tsd-kind-parameter">params</span>: <span class="tsd-signature-type ">URLSearchParams</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L540">src/cadenza.js:540</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L553">src/cadenza.js:553</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="_fetch" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#fetch</span><a href="#_fetch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-is-private">
@@ -205,7 +205,7 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type ">Response</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L496">src/cadenza.js:496</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L510">src/cadenza.js:510</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="_getIframePromise" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#get<wbr/>Iframe<wbr/>Promise</span><a href="#_getIframePromise" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-is-private">
@@ -218,7 +218,7 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
 <h5><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">AbortSignal</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L371">src/cadenza.js:371</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L386">src/cadenza.js:386</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="_log" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#log</span><a href="#_log" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-is-private">
@@ -231,7 +231,7 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
 <h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L562">src/cadenza.js:562</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L575">src/cadenza.js:575</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="_onMessage" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#on<wbr/>Message</span><a href="#_onMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-is-private">
@@ -244,7 +244,7 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
 <h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type ">MessageEvent</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/CadenzaEvent.html" class="tsd-signature-type tsd-kind-interface">CadenzaEvent</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L447">src/cadenza.js:447</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L462">src/cadenza.js:462</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="_postEvent" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#post<wbr/>Event</span><a href="#_postEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-is-private">
@@ -259,7 +259,7 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
 <h5><span class="tsd-kind-parameter">detail</span>: <span class="tsd-signature-type">unknown</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L464">src/cadenza.js:464</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L479">src/cadenza.js:479</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="_show" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#show</span><a href="#_show" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <ul class="tsd-signatures tsd-is-private">
@@ -285,7 +285,7 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
 </div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L360">src/cadenza.js:360</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L375">src/cadenza.js:375</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="createGeometry" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>create<wbr/>Geometry</span><a href="#createGeometry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <ul class="tsd-signatures">
@@ -351,7 +351,7 @@ That&#39;s why the events use the <code>editGeometry</code> prefix.</p>
 <h4>Fires</h4><p><code>editGeometry:cancel</code> - When the user cancelled the geometry editing in Cadenza.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L306">src/cadenza.js:306</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L321">src/cadenza.js:321</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="downloadData" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>download<wbr/>Data</span><a href="#downloadData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <ul class="tsd-signatures">
@@ -392,7 +392,7 @@ That&#39;s why the events use the <code>editGeometry</code> prefix.</p>
 <div class="tsd-comment tsd-typography"></div></li>
 <li class="tsd-parameter">
 <h5><span class="tsd-kind-property">parts</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/TablePart.html" class="tsd-signature-type tsd-kind-type-alias">TablePart</a><span class="tsd-signature-symbol">[]</span></h5>
-<div class="tsd-comment tsd-typography"><p>An optional array of table parts to export. If not specified, all parts are exported.</p>
+<div class="tsd-comment tsd-typography"><p>Table parts to export; If not specified, all parts are exported.</p>
 </div>
 <div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
@@ -400,7 +400,7 @@ That&#39;s why the events use the <code>editGeometry</code> prefix.</p>
 <h4>Throws</h4><p>For invalid arguments</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L532">src/cadenza.js:532</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L546">src/cadenza.js:546</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="editGeometry" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>edit<wbr/>Geometry</span><a href="#editGeometry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <ul class="tsd-signatures">
@@ -464,26 +464,26 @@ That&#39;s why the events use the <code>editGeometry</code> prefix.</p>
 <h4>Fires</h4><p><code>editGeometry:cancel</code> - When the user cancelled the geometry editing in Cadenza.</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L341">src/cadenza.js:341</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L356">src/cadenza.js:356</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="expandNavigator" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>expand<wbr/>Navigator</span><a href="#expandNavigator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <ul class="tsd-signatures">
-<li class="tsd-signature tsd-anchor-link" id="expandNavigator.expandNavigator-1"><span class="tsd-kind-call-signature">expand<wbr/>Navigator</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">expandNavigator</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#expandNavigator.expandNavigator-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
+<li class="tsd-signature tsd-anchor-link" id="expandNavigator.expandNavigator-1"><span class="tsd-kind-call-signature">expand<wbr/>Navigator</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">expanded</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#expandNavigator.expandNavigator-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
 <li class="tsd-description">
-<div class="tsd-comment tsd-typography"><p>Expand/collapse the navigator tree.</p>
+<div class="tsd-comment tsd-typography"><p>Expand/collapse the navigator.</p>
 </div>
 <div class="tsd-parameters">
 <h4 class="tsd-parameters-title">Parameters</h4>
 <ul class="tsd-parameter-list">
 <li>
-<h5><span class="tsd-kind-parameter">expandNavigator</span>: <span class="tsd-signature-type">boolean</span></h5>
-<div class="tsd-comment tsd-typography"><p>The expansion state of the navigator.</p>
+<h5><span class="tsd-kind-parameter">expanded</span>: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
+<div class="tsd-comment tsd-typography"><p>The expansion state of the navigator</p>
 </div>
 <div class="tsd-comment tsd-typography"></div></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L281">src/cadenza.js:281</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L296">src/cadenza.js:296</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="fetchData" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>fetch<wbr/>Data</span><a href="#fetchData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <ul class="tsd-signatures">
@@ -518,7 +518,7 @@ That&#39;s why the events use the <code>editGeometry</code> prefix.</p>
 <ul class="tsd-parameters">
 <li class="tsd-parameter">
 <h5><span class="tsd-kind-property">parts</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/TablePart.html" class="tsd-signature-type tsd-kind-type-alias">TablePart</a><span class="tsd-signature-symbol">[]</span></h5>
-<div class="tsd-comment tsd-typography"><p>An optional array of table parts to export. If not specified, all parts are exported.</p>
+<div class="tsd-comment tsd-typography"><p>Table parts to export; If not specified, all parts are exported.</p>
 </div>
 <div class="tsd-comment tsd-typography"></div></li>
 <li class="tsd-parameter">
@@ -532,7 +532,7 @@ That&#39;s why the events use the <code>editGeometry</code> prefix.</p>
 <h4>Throws</h4><p>For invalid arguments</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L488">src/cadenza.js:488</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L503">src/cadenza.js:503</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="on" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <ul class="tsd-signatures">
@@ -580,7 +580,7 @@ That&#39;s why the events use the <code>editGeometry</code> prefix.</p>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul>
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L424">src/cadenza.js:424</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L439">src/cadenza.js:439</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="show" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>show</span><a href="#show" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <ul class="tsd-signatures">
@@ -597,7 +597,7 @@ That&#39;s why the events use the <code>editGeometry</code> prefix.</p>
 </div>
 <div class="tsd-comment tsd-typography"></div></li>
 <li>
-<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">disabledUiFeatures</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/UiFeature.html" class="tsd-signature-type tsd-kind-type-alias">UiFeature</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">expandNavigator</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">hideMainHeaderAndFooter</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">hideWorkbookToolBar</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">highlightGlobalId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">mediaType</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">operationMode</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/OperationMode.html" class="tsd-signature-type tsd-kind-type-alias">OperationMode</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">AbortSignal</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
+<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span>    </span><span class="tsd-kind-property">disabledUiFeatures</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/UiFeature.html" class="tsd-signature-type tsd-kind-type-alias">UiFeature</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">expandNavigator</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">hideMainHeaderAndFooter</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">hideWorkbookToolBar</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">highlightGlobalId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">labelSet</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">mediaType</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">operationMode</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/OperationMode.html" class="tsd-signature-type tsd-kind-type-alias">OperationMode</a><span class="tsd-signature-symbol">; </span><br/><span>    </span><span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">AbortSignal</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
 <div class="tsd-comment tsd-typography"></div>
 <ul class="tsd-parameters">
 <li class="tsd-parameter">
@@ -626,6 +626,11 @@ That&#39;s why the events use the <code>editGeometry</code> prefix.</p>
 </div>
 <div class="tsd-comment tsd-typography"></div></li>
 <li class="tsd-parameter">
+<h5><span class="tsd-kind-property">label<wbr/>Set</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
+<div class="tsd-comment tsd-typography"><p>The name of a label set defined in the <code>basicweb-config.xml</code> (only supported for the welcome page)</p>
+</div>
+<div class="tsd-comment tsd-typography"></div></li>
+<li class="tsd-parameter">
 <h5><span class="tsd-kind-property">media<wbr/>Type</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
 <div class="tsd-comment tsd-typography"><p>Set to &#39;application/pdf&#39; for views of type &quot;JasperReports report&quot;
     to show the report PDF directly, without any Cadenza headers or footers.</p>
@@ -647,7 +652,7 @@ That&#39;s why the events use the <code>editGeometry</code> prefix.</p>
 <h4>Throws</h4><p>For invalid arguments</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L191">src/cadenza.js:191</a></li></ul></aside></li></ul></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L196">src/cadenza.js:196</a></li></ul></aside></li></ul></section>
 <section class="tsd-panel tsd-member"><a id="showMap" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><span>show<wbr/>Map</span><a href="#showMap" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <ul class="tsd-signatures">
@@ -730,7 +735,7 @@ That&#39;s why the events use the <code>editGeometry</code> prefix.</p>
 <h4>Throws</h4><p>For invalid arguments</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L240">src/cadenza.js:240</a></li></ul></aside></li></ul></section></section></div>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L255">src/cadenza.js:255</a></li></ul></aside></li></ul></section></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">
@@ -796,7 +801,6 @@ That&#39;s why the events use the <code>editGeometry</code> prefix.</p>
 <li><a href="../types/GlobalId.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Global<wbr/>Id</span></a></li>
 <li><a href="../types/MediaType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Media<wbr/>Type</span></a></li>
 <li><a href="../types/OperationMode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Operation<wbr/>Mode</span></a></li>
-<li><a href="../types/PageType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Page<wbr/>Type</span></a></li>
 <li><a href="../types/TablePart.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Table<wbr/>Part</span></a></li>
 <li><a href="../types/UiFeature.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Ui<wbr/>Feature</span></a></li>
 <li><a href="../types/WorkbookSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Workbook<wbr/>Source</span></a></li>

package/apidoc/classes/CadenzaError.html

@@ -27,7 +27,7 @@
 <ul class="tsd-hierarchy">
 <li><span class="target">CadenzaError</span></li></ul></li></ul></section><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L809">src/cadenza.js:809</a></li></ul></aside>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L811">src/cadenza.js:811</a></li></ul></aside>
 <section class="tsd-panel-group tsd-index-group">
 <section class="tsd-panel tsd-index-panel">
 <details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -79,14 +79,14 @@
 <div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
 <p>Overrides Error.constructor</p>
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L816">src/cadenza.js:816</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L818">src/cadenza.js:818</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Properties</h2>
 <section class="tsd-panel tsd-member tsd-is-private"><a id="_type" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#type</span><a href="#_type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">#type</span><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/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L810">src/cadenza.js:810</a></li></ul></aside></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L812">src/cadenza.js:812</a></li></ul></aside></section>
 <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a>
 <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>cause</span><a href="#cause" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
 <div class="tsd-signature"><span class="tsd-kind-property">cause</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">unknown</span></div><aside class="tsd-sources">
@@ -152,7 +152,7 @@
 <li class="tsd-description">
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L821">src/cadenza.js:821</a></li></ul></aside></li></ul></section></section>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L823">src/cadenza.js:823</a></li></ul></aside></li></ul></section></section>
 <section class="tsd-panel-group tsd-member-group">
 <h2>Methods</h2>
 <section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a>
@@ -223,7 +223,6 @@
 <li><a href="../types/GlobalId.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Global<wbr/>Id</span></a></li>
 <li><a href="../types/MediaType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Media<wbr/>Type</span></a></li>
 <li><a href="../types/OperationMode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Operation<wbr/>Mode</span></a></li>
-<li><a href="../types/PageType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Page<wbr/>Type</span></a></li>
 <li><a href="../types/TablePart.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Table<wbr/>Part</span></a></li>
 <li><a href="../types/UiFeature.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Ui<wbr/>Feature</span></a></li>
 <li><a href="../types/WorkbookSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Workbook<wbr/>Source</span></a></li>

package/apidoc/functions/cadenza.html

@@ -55,7 +55,7 @@
 <h4>Throws</h4><p>For invalid arguments</p>
 </div><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/23b23d8/src/cadenza.js#L11">src/cadenza.js:11</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/c840a7c/src/cadenza.js#L11">src/cadenza.js:11</a></li></ul></aside></li></ul></section></div>
 <div class="col-sidebar">
 <div class="page-menu">
 <div class="tsd-navigation settings">
@@ -91,7 +91,6 @@
 <li><a href="../types/GlobalId.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Global<wbr/>Id</span></a></li>
 <li><a href="../types/MediaType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Media<wbr/>Type</span></a></li>
 <li><a href="../types/OperationMode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Operation<wbr/>Mode</span></a></li>
-<li><a href="../types/PageType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Page<wbr/>Type</span></a></li>
 <li><a href="../types/TablePart.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Table<wbr/>Part</span></a></li>
 <li><a href="../types/UiFeature.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Ui<wbr/>Feature</span></a></li>
 <li><a href="../types/WorkbookSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Workbook<wbr/>Source</span></a></li>

package/apidoc/index.html

@@ -13,7 +13,13 @@
 <div class="tsd-page-title">
 <h2>Cadenza JS</h2></div>
 <div class="tsd-panel tsd-typography"><p>Cadenza JS is a JavaScript library to use the <a href="https://www.disy.net/en/products/disy-cadenza/">disy Cadenza</a> APIs conveniently without having to deal with technical details like parameter encoding or the <code>postMessage()</code> Web API.</p>
-<a id="md:installation" class="tsd-anchor"></a><h2><a href="#md:installation">Installation</a></h2><p>Install using npm:</p>
+<ul>
+<li><a href="#installation">Installation</a></li>
+<li><a href="#usage-examples">Usage Examples</a></li>
+<li><a href="#the-development-sandbox">The development sandbox</a></li>
+</ul>
+<a id="md:installation" class="tsd-anchor"></a><h2><a href="#md:installation">Installation</a></h2><p>Cadenza JS is included in the Cadenza distribution in the corresponding version.</p>
+<p>Alternatively you can install the most recent version using npm:</p>
 <pre><code class="language-bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-2">@disy/cadenza.js</span>
 </code><button>Copy</button></pre>
 <a id="md:usage-examples" class="tsd-anchor"></a><h2><a href="#md:usage-examples">Usage Examples</a></h2><p>This section features usage examples for Cadenza JS. For detailed usage information, see the &quot;API:&quot; links.</p>
@@ -79,28 +85,45 @@
 That&#39;s why the events use the <code>editGeometry</code> prefix.</p>
 <a id="md:highlight-an-item-in-the-navigator" class="tsd-anchor"></a><h3><a href="#md:highlight-an-item-in-the-navigator">Highlight an Item in the Navigator</a></h3><p><small>API: <a href="./classes/CadenzaClient.html#show">CadenzaClient#show</a></small></p>
 <p>Show an embedding target in an iframe and highlight an item in the navigator. Additionally, expand the navigator tree.</p>
-<pre><code class="language-javascript"><span class="hl-8">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">show</span><span class="hl-1">({</span><span class="hl-8">embeddingTargetId</span><span class="hl-1">}, {</span><span class="hl-8">expandNavigator:</span><span class="hl-1"> </span><span class="hl-9">true</span><span class="hl-1">, </span><span class="hl-8">highlightGlobalId:</span><span class="hl-1"> </span><span class="hl-2">&#39;ROOT.MyFolder&#39;</span><span class="hl-1">});</span>
+<pre><code class="language-javascript"><span class="hl-8">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">show</span><span class="hl-1">(</span><span class="hl-2">&#39;{embeddingTargetId}&#39;</span><span class="hl-1">, {</span><span class="hl-8">expandNavigator:</span><span class="hl-1"> </span><span class="hl-9">true</span><span class="hl-1">, </span><span class="hl-8">highlightGlobalId:</span><span class="hl-1"> </span><span class="hl-2">&#39;ROOT.MyFolder&#39;</span><span class="hl-1">});</span>
 </code><button>Copy</button></pre>
 <a id="md:highlight-an-item-in-the-navigator-on-the-welcome-page" class="tsd-anchor"></a><h4><a href="#md:highlight-an-item-in-the-navigator-on-the-welcome-page">Highlight an Item in the Navigator on the Welcome Page</a></h4><p><small>API: <a href="./classes/CadenzaClient.html#show">CadenzaClient#show</a></small></p>
 <p>Show Cadenza&#39;s welcome page in an iframe and highlight an item in the navigator.</p>
 <pre><code class="language-javascript"><span class="hl-8">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">show</span><span class="hl-1">({</span><span class="hl-8">page:</span><span class="hl-1"> </span><span class="hl-2">&#39;welcome&#39;</span><span class="hl-1">}, {</span><span class="hl-8">highlightGlobalId:</span><span class="hl-1"> </span><span class="hl-2">&#39;ROOT.MyFolder&#39;</span><span class="hl-1">});</span>
 </code><button>Copy</button></pre>
-<a id="md:expandcollapse-the-navigator-tree" class="tsd-anchor"></a><h3><a href="#md:expandcollapse-the-navigator-tree">Expand/collapse the navigator tree</a></h3><p><small>API: <a href="./classes/CadenzaClient.html#expandNavigator">CadenzaClient#expandNavigator</a></small></p>
-<p>Expand the navigator tree.</p>
-<pre><code class="language-javascript"><span class="hl-9">const</span><span class="hl-1"> </span><span class="hl-10">button</span><span class="hl-1"> = </span><span class="hl-8">document</span><span class="hl-1">.</span><span class="hl-0">createElement</span><span class="hl-1">(</span><span class="hl-2">&#39;button&#39;</span><span class="hl-1">);</span><br/><span class="hl-8">button</span><span class="hl-1">.</span><span class="hl-8">textContent</span><span class="hl-1"> = </span><span class="hl-2">&#39;Expand Navigator&#39;</span><span class="hl-1">;</span><br/><span class="hl-8">button</span><span class="hl-1">.</span><span class="hl-0">onclick</span><span class="hl-1"> = (</span><span class="hl-8">event</span><span class="hl-1">) </span><span class="hl-9">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">  </span><span class="hl-8">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">expandNavigator</span><span class="hl-1">(</span><span class="hl-9">true</span><span class="hl-1">);</span><br/><span class="hl-1">};</span>
+<a id="md:expand-the-navigator" class="tsd-anchor"></a><h4><a href="#md:expand-the-navigator">Expand the Navigator</a></h4><p><small>API: <a href="./classes/CadenzaClient.html#expandNavigator">CadenzaClient#expandNavigator</a></small></p>
+<p>Expand the navigator.</p>
+<pre><code class="language-javascript"><span class="hl-8">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">expandNavigator</span><span class="hl-1">();</span>
 </code><button>Copy</button></pre>
 <a id="md:fetch-data-from-a-workbook-view" class="tsd-anchor"></a><h3><a href="#md:fetch-data-from-a-workbook-view">Fetch Data From a Workbook View</a></h3><p><small>API: <a href="./classes/CadenzaClient.html#fetchData">CadenzaClient#fetchData</a></small></p>
 <p>Fetch data from a workbook view in CSV format.</p>
 <pre><code class="language-javascript"><span class="hl-9">const</span><span class="hl-1"> </span><span class="hl-10">response</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-8">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">fetchData</span><span class="hl-1">(</span><span class="hl-2">&#39;{embeddingTargetId}&#39;</span><span class="hl-1">, </span><span class="hl-2">&#39;text/csv&#39;</span><span class="hl-1">);</span><br/><br/><span class="hl-9">const</span><span class="hl-1"> </span><span class="hl-10">text</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-8">response</span><span class="hl-1">.</span><span class="hl-0">text</span><span class="hl-1">();</span><br/><span class="hl-1">...</span>
 </code><button>Copy</button></pre>
-<a id="md:control-the-contents-of-the-fetched-table-data" class="tsd-anchor"></a><h4><a href="#md:control-the-contents-of-the-fetched-table-data">Control the contents of the fetched table data</a></h4><p>Fetch data from a workbook view in JSON format and include only the data values and the aggregations (totals) and exclude
-the column names.</p>
-<pre><code class="language-javascript"><span class="hl-9">const</span><span class="hl-1"> </span><span class="hl-10">response</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-8">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">fetchData</span><span class="hl-1">(</span><span class="hl-2">&#39;{embeddingTargetId}&#39;</span><span class="hl-1">, </span><span class="hl-2">&#39;application/json&#39;</span><span class="hl-1">, { </span><span class="hl-8">parts:</span><span class="hl-1"> [</span><span class="hl-2">&#39;values&#39;</span><span class="hl-1">, </span><span class="hl-2">&#39;totals&#39;</span><span class="hl-1">] });</span><br/><br/><span class="hl-9">const</span><span class="hl-1"> </span><span class="hl-10">tableData</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-8">response</span><span class="hl-1">.</span><span class="hl-0">json</span><span class="hl-1">();</span><br/><span class="hl-1">...</span>
+<a id="md:control-the-contents-of-the-fetched-table-data" class="tsd-anchor"></a><h4><a href="#md:control-the-contents-of-the-fetched-table-data">Control the Contents of the Fetched Table Data</a></h4><p>Fetch data from a workbook view in JSON format and include only the data values and the aggregation totals. (Do not include the column names.)</p>
+<pre><code class="language-javascript"><span class="hl-9">const</span><span class="hl-1"> </span><span class="hl-10">response</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-8">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">fetchData</span><span class="hl-1">(</span><br/><span class="hl-1">  </span><span class="hl-2">&#39;{embeddingTargetId}&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  </span><span class="hl-2">&#39;application/json&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">  { </span><span class="hl-8">parts:</span><span class="hl-1"> [</span><span class="hl-2">&#39;values&#39;</span><span class="hl-1">, </span><span class="hl-2">&#39;totals&#39;</span><span class="hl-1">] });</span><br/><br/><span class="hl-9">const</span><span class="hl-1"> </span><span class="hl-10">tableData</span><span class="hl-1"> = </span><span class="hl-7">await</span><span class="hl-1"> </span><span class="hl-8">response</span><span class="hl-1">.</span><span class="hl-0">json</span><span class="hl-1">();</span><br/><span class="hl-1">...</span>
 </code><button>Copy</button></pre>
 <a id="md:download-data-from-a-workbook-view" class="tsd-anchor"></a><h3><a href="#md:download-data-from-a-workbook-view">Download Data From a Workbook View</a></h3><p><small>API: <a href="./classes/CadenzaClient.html#downloadData">CadenzaClient#downloadData</a></small></p>
 <p>Download data from a workbook view in Excel format. This triggers the browser&#39;s download dialog.</p>
 <pre><code class="language-javascript"><span class="hl-9">const</span><span class="hl-1"> </span><span class="hl-10">button</span><span class="hl-1"> = </span><span class="hl-8">document</span><span class="hl-1">.</span><span class="hl-0">createElement</span><span class="hl-1">(</span><span class="hl-2">&#39;button&#39;</span><span class="hl-1">);</span><br/><span class="hl-8">button</span><span class="hl-1">.</span><span class="hl-8">textContent</span><span class="hl-1"> = </span><span class="hl-2">&#39;Download Excel&#39;</span><span class="hl-1">;</span><br/><br/><span class="hl-8">button</span><span class="hl-1">.</span><span class="hl-0">onclick</span><span class="hl-1"> = (</span><span class="hl-8">event</span><span class="hl-1">) </span><span class="hl-9">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1">  </span><span class="hl-8">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">downloadData</span><span class="hl-1">(</span><span class="hl-2">&#39;{embeddingTargetId}&#39;</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-2">&#39;application/vnd.openxmlformats-officedocument.spreadsheetml.sheet&#39;</span><span class="hl-1">);</span><br/><span class="hl-1">};</span>
 </code><button>Copy</button></pre>
+<a id="md:the-development-sandbox" class="tsd-anchor"></a><h2><a href="#md:the-development-sandbox">The Development Sandbox</a></h2><p>The development sandbox is a simple custom application (in fact a single <code>.html</code> file) for playing with Cadenza JS.</p>
+<p>To run it ...</p>
+<ul>
+<li>You need a Cadenza installation running on <a href="http://localhost:8080/cadenza">http://localhost:8080/cadenza</a>. (See <a href="#customize-the-cadenza-url">Customize the Cadenza URL</a> below)</li>
+<li>In <code>node_modules/@disy/cadenza.js</code> run <code>npm run sandbox</code> to start the sandbox.</li>
+</ul>
+<p>The command starts a proxy server that serves the <code>sandbox.html</code> and <code>cadenza.js</code> files and proxies all other requests to the Cadenza server. Since that way the sandbox and Cadenza run on the same origin, embedding and <code>postMessage</code> communication just work.</p>
+<a id="md:the-sandbox-ui" class="tsd-anchor"></a><h3><a href="#md:the-sandbox-ui">The Sandbox UI</a></h3><p><code>npm run sandbox</code> also opens the sandbox in a new browser window. Select the Cadenza JS method you want to play with in the select box at the top. For each method there are controls to define the parameters. Hit &quot;Go!&quot; to call the method.</p>
+<p>The sandbox uses Cadenza JS with the &quot;debug&quot; option enabled, so you can see what is going on internally in the browser&#39;s devtools console. In the &quot;Network&quot; tab of the devtools you can see the requests to the Cadenza server.</p>
+<a id="md:customize-the-cadenza-url" class="tsd-anchor"></a><h3><a href="#md:customize-the-cadenza-url">Customize the Cadenza URL</a></h3><p>By default, the sandbox expects Cadenza to run on <a href="http://localhost:8080/cadenza">http://localhost:8080/cadenza</a>. There are two ways to customize the Cadenza URL:</p>
+<ul>
+<li>Pass an argument:<pre><code class="language-bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">sandbox</span><span class="hl-1"> </span><span class="hl-9">--cadenza-url</span><span class="hl-1"> </span><span class="hl-2">http://localhost:8000/my-cadenza</span>
+</code><button>Copy</button></pre>
+</li>
+<li>Set an environment variable:<pre><code class="language-bash"><span class="hl-9">export</span><span class="hl-1"> </span><span class="hl-8">CADENZA_URL</span><span class="hl-1">=</span><span class="hl-2">http://localhost:8000/my-cadenza</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">sandbox</span>
+</code><button>Copy</button></pre>
+</li>
+</ul>
 </div></div>
 <div class="col-sidebar">
 <div class="page-menu">
@@ -150,13 +173,18 @@ the column names.</p>
 <li><a href="#md:highlight-an-item-in-the-navigator"><span>Highlight an <wbr/>Item in the <wbr/>Navigator</span></a></li>
 <li>
 <ul>
-<li><a href="#md:highlight-an-item-in-the-navigator-on-the-welcome-page"><span>Highlight an <wbr/>Item in the <wbr/>Navigator on the <wbr/>Welcome <wbr/>Page</span></a></li></ul></li>
-<li><a href="#md:expandcollapse-the-navigator-tree"><span>Expand/collapse the navigator tree</span></a></li>
+<li><a href="#md:highlight-an-item-in-the-navigator-on-the-welcome-page"><span>Highlight an <wbr/>Item in the <wbr/>Navigator on the <wbr/>Welcome <wbr/>Page</span></a></li>
+<li><a href="#md:expand-the-navigator"><span>Expand the <wbr/>Navigator</span></a></li></ul></li>
 <li><a href="#md:fetch-data-from-a-workbook-view"><span>Fetch <wbr/>Data <wbr/>From a <wbr/>Workbook <wbr/>View</span></a></li>
 <li>
 <ul>
-<li><a href="#md:control-the-contents-of-the-fetched-table-data"><span>Control the contents of the fetched table data</span></a></li></ul></li>
-<li><a href="#md:download-data-from-a-workbook-view"><span>Download <wbr/>Data <wbr/>From a <wbr/>Workbook <wbr/>View</span></a></li></ul></li></ul></li></ul></li></ul></div></details></div>
+<li><a href="#md:control-the-contents-of-the-fetched-table-data"><span>Control the <wbr/>Contents of the <wbr/>Fetched <wbr/>Table <wbr/>Data</span></a></li></ul></li>
+<li><a href="#md:download-data-from-a-workbook-view"><span>Download <wbr/>Data <wbr/>From a <wbr/>Workbook <wbr/>View</span></a></li></ul></li>
+<li><a href="#md:the-development-sandbox"><span>The <wbr/>Development <wbr/>Sandbox</span></a></li>
+<li>
+<ul>
+<li><a href="#md:the-sandbox-ui"><span>The <wbr/>Sandbox UI</span></a></li>
+<li><a href="#md:customize-the-cadenza-url"><span>Customize the <wbr/>Cadenza URL</span></a></li></ul></li></ul></li></ul></li></ul></div></details></div>
 <div class="site-menu">
 <nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>Cadenza JS</span></a>
 <ul class="tsd-small-nested-navigation">
@@ -177,7 +205,6 @@ the column names.</p>
 <li><a href="types/GlobalId.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Global<wbr/>Id</span></a></li>
 <li><a href="types/MediaType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Media<wbr/>Type</span></a></li>
 <li><a href="types/OperationMode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Operation<wbr/>Mode</span></a></li>
-<li><a href="types/PageType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Page<wbr/>Type</span></a></li>
 <li><a href="types/TablePart.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Table<wbr/>Part</span></a></li>
 <li><a href="types/UiFeature.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Ui<wbr/>Feature</span></a></li>
 <li><a href="types/WorkbookSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Workbook<wbr/>Source</span></a></li>