Skip to content

Commit

Permalink
Updates
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Oct 25, 2023
1 parent e94dcf7 commit ec5a117
Show file tree
Hide file tree
Showing 23 changed files with 66 additions and 225 deletions.
2 changes: 1 addition & 1 deletion assets/search.js

Large diffs are not rendered by default.

5 changes: 2 additions & 3 deletions classes/AbortError.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">AbortError</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/589c29f/src/cadenza.js#L724">src/cadenza.js:724</a></li></ul></aside>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/93fee76/src/cadenza.js#L692">src/cadenza.js:692</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">
Expand Down Expand Up @@ -100,7 +100,7 @@ <h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-
<h4 class="tsd-returns-title">Returns <a href="AbortError.html" class="tsd-signature-type tsd-kind-class">AbortError</a></h4><aside class="tsd-sources">
<p>Overrides DOMException.constructor</p>
<ul>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/589c29f/src/cadenza.js#L725">src/cadenza.js:725</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/93fee76/src/cadenza.js#L693">src/cadenza.js:693</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-inherited tsd-is-external"><a id="ABORT_ERR" class="tsd-anchor"></a>
Expand Down Expand Up @@ -526,7 +526,6 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../interfaces/CadenzaEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Cadenza<wbr/>Event</span></a></li>
<li><a href="../interfaces/ExternalLinkKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>External<wbr/>Link<wbr/>Key</span></a></li>
<li><a href="../interfaces/Geometry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Geometry</span></a></li>
<li><a href="../interfaces/PageSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Page<wbr/>Source</span></a></li>
<li><a href="../interfaces/WorkbookKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workbook<wbr/>Key</span></a></li>
<li><a href="../interfaces/WorkbookViewKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workbook<wbr/>View<wbr/>Key</span></a></li>
<li><a href="../interfaces/WorksheetKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worksheet<wbr/>Key</span></a></li>
Expand Down
92 changes: 30 additions & 62 deletions classes/CadenzaClient.html

Large diffs are not rendered by default.

9 changes: 4 additions & 5 deletions classes/CadenzaError.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ <h4>Hierarchy</h4>
<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/589c29f/src/cadenza.js#L735">src/cadenza.js:735</a></li></ul></aside>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/93fee76/src/cadenza.js#L703">src/cadenza.js:703</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">
Expand Down Expand Up @@ -79,14 +79,14 @@ <h4 class="tsd-returns-title">Returns <a href="CadenzaError.html" class="tsd-sig
<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/589c29f/src/cadenza.js#L742">src/cadenza.js:742</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/93fee76/src/cadenza.js#L710">src/cadenza.js:710</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/589c29f/src/cadenza.js#L736">src/cadenza.js:736</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/93fee76/src/cadenza.js#L704">src/cadenza.js:704</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">
Expand Down Expand Up @@ -152,7 +152,7 @@ <h3 class="tsd-anchor-link"><span>type</span><a href="#type" aria-label="Permali
<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/589c29f/src/cadenza.js#L747">src/cadenza.js:747</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/93fee76/src/cadenza.js#L715">src/cadenza.js:715</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>
Expand Down Expand Up @@ -212,7 +212,6 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="../interfaces/CadenzaEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Cadenza<wbr/>Event</span></a></li>
<li><a href="../interfaces/ExternalLinkKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>External<wbr/>Link<wbr/>Key</span></a></li>
<li><a href="../interfaces/Geometry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Geometry</span></a></li>
<li><a href="../interfaces/PageSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Page<wbr/>Source</span></a></li>
<li><a href="../interfaces/WorkbookKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workbook<wbr/>Key</span></a></li>
<li><a href="../interfaces/WorkbookViewKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workbook<wbr/>View<wbr/>Key</span></a></li>
<li><a href="../interfaces/WorksheetKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worksheet<wbr/>Key</span></a></li>
Expand Down
3 changes: 1 addition & 2 deletions functions/cadenza.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ <h4 class="tsd-returns-title">Returns <a href="../classes/CadenzaClient.html" cl
<h4>Throws</h4><p>For invalid base URL</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/589c29f/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/93fee76/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">
Expand All @@ -80,7 +80,6 @@ <h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</op
<li><a href="../interfaces/CadenzaEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Cadenza<wbr/>Event</span></a></li>
<li><a href="../interfaces/ExternalLinkKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>External<wbr/>Link<wbr/>Key</span></a></li>
<li><a href="../interfaces/Geometry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Geometry</span></a></li>
<li><a href="../interfaces/PageSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Page<wbr/>Source</span></a></li>
<li><a href="../interfaces/WorkbookKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workbook<wbr/>Key</span></a></li>
<li><a href="../interfaces/WorkbookViewKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workbook<wbr/>View<wbr/>Key</span></a></li>
<li><a href="../interfaces/WorksheetKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worksheet<wbr/>Key</span></a></li>
Expand Down
15 changes: 0 additions & 15 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,6 @@ <h2>Cadenza JS</h2></div>
<p>If for some reason you don&#39;t like the global <code>cadenza</code> field, you can remove it like so:</p>
<pre><code class="language-javascript"><span class="hl-8">const</span><span class="hl-2"> </span><span class="hl-9">cadenza</span><span class="hl-2"> = </span><span class="hl-6">window</span><span class="hl-2">.</span><span class="hl-6">cadenza</span><span class="hl-2">.</span><span class="hl-10">noConflict</span><span class="hl-2">();</span>
</code><button>Copy</button></pre>
<a id="md:show-a-cadenza-page-in-an-iframe" class="tsd-anchor"></a><h3><a href="#md:show-a-cadenza-page-in-an-iframe">Show a Cadenza page in an Iframe</a></h3><p><small>API: <a href="./classes/CadenzaClient.html#show">CadenzaClient#show</a></small></p>
<p>Show Cadenza&#39;s welcome page in an iframe:</p>
<pre><code class="language-javascript"><span class="hl-6">cadenzaClient</span><span class="hl-2">.</span><span class="hl-10">show</span><span class="hl-2">({</span><span class="hl-6">page:</span><span class="hl-2"> </span><span class="hl-7">&#39;welcome&#39;</span><span class="hl-2">});</span>
</code><button>Copy</button></pre>
<ul>
<li>If the specified page cannot be found, a 404 page is shown to the user.</li>
<li>Cadenza JS does not handle user authentication: If the user is not already logged in, the normal authentication flow of Cadenza will run. By default, the login page would be shown to the user.</li>
</ul>
<a id="md:show-an-embedding-target-in-an-iframe" class="tsd-anchor"></a><h3><a href="#md:show-an-embedding-target-in-an-iframe">Show an Embedding Target in an Iframe</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 hide Cadenza&#39;s main header and footer as well as the workbook toolbar:</p>
<pre><code class="language-javascript"><span class="hl-6">cadenzaClient</span><span class="hl-2">.</span><span class="hl-10">show</span><span class="hl-2">(</span><span class="hl-7">&#39;{embeddingTargetId}&#39;</span><span class="hl-2">, {</span><br/><span class="hl-2"> </span><span class="hl-6">hideMainHeaderAndFooter:</span><span class="hl-2"> </span><span class="hl-8">true</span><span class="hl-2">,</span><br/><span class="hl-2"> </span><span class="hl-6">hideWorkbookToolBar:</span><span class="hl-2"> </span><span class="hl-8">true</span><span class="hl-2">,</span><br/><span class="hl-2">});</span>
Expand Down Expand Up @@ -82,10 +74,6 @@ <h2>Cadenza JS</h2></div>
</code><button>Copy</button></pre>
<p><em>Note:</em> Under the hood, creating a geometry is similar to editing a geometry.
That&#39;s why the events use the <code>editGeometry</code> prefix.</p>
<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#downloadData">CadenzaClient#expandNavigator</a></small></p>
<p>Toggle the navigator tree expansion state.</p>
<pre><code class="language-javascript"><span class="hl-8">const</span><span class="hl-2"> </span><span class="hl-9">button1</span><span class="hl-2"> = </span><span class="hl-6">document</span><span class="hl-2">.</span><span class="hl-10">createElement</span><span class="hl-2">(</span><span class="hl-7">&#39;button&#39;</span><span class="hl-2">);</span><br/><span class="hl-6">button1</span><span class="hl-2">.</span><span class="hl-6">textContent</span><span class="hl-2"> = </span><span class="hl-7">&#39;Expand Navigator&#39;</span><span class="hl-2">;</span><br/><span class="hl-6">button1</span><span class="hl-2">.</span><span class="hl-10">onclick</span><span class="hl-2"> = (</span><span class="hl-6">event</span><span class="hl-2">) </span><span class="hl-8">=&gt;</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-6">cadenzaClient</span><span class="hl-2">.</span><span class="hl-10">expandNavigator</span><span class="hl-2">(</span><span class="hl-8">true</span><span class="hl-2">);</span><br/><span class="hl-2">};</span><br/><br/><span class="hl-8">const</span><span class="hl-2"> </span><span class="hl-9">button2</span><span class="hl-2"> = </span><span class="hl-6">document</span><span class="hl-2">.</span><span class="hl-10">createElement</span><span class="hl-2">(</span><span class="hl-7">&#39;button&#39;</span><span class="hl-2">);</span><br/><span class="hl-6">button2</span><span class="hl-2">.</span><span class="hl-6">textContent</span><span class="hl-2"> = </span><span class="hl-7">&#39;Collapse Navigator&#39;</span><span class="hl-2">;</span><br/><span class="hl-6">button2</span><span class="hl-2">.</span><span class="hl-10">onclick</span><span class="hl-2"> = (</span><span class="hl-6">event</span><span class="hl-2">) </span><span class="hl-8">=&gt;</span><span class="hl-2"> {</span><br/><span class="hl-2"> </span><span class="hl-6">cadenzaClient</span><span class="hl-2">.</span><span class="hl-10">expandNavigator</span><span class="hl-2">(</span><span class="hl-8">false</span><span class="hl-2">);</span><br/><span class="hl-2">};</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-8">const</span><span class="hl-2"> </span><span class="hl-9">response</span><span class="hl-2"> = </span><span class="hl-5">await</span><span class="hl-2"> </span><span class="hl-6">cadenzaClient</span><span class="hl-2">.</span><span class="hl-10">fetchData</span><span class="hl-2">(</span><span class="hl-7">&#39;{embeddingTargetId}&#39;</span><span class="hl-2">, </span><span class="hl-7">&#39;text/csv&#39;</span><span class="hl-2">);</span><br/><br/><span class="hl-8">const</span><span class="hl-2"> </span><span class="hl-9">text</span><span class="hl-2"> = </span><span class="hl-5">await</span><span class="hl-2"> </span><span class="hl-6">response</span><span class="hl-2">.</span><span class="hl-10">text</span><span class="hl-2">();</span><br/><span class="hl-2">...</span>
Expand Down Expand Up @@ -126,7 +114,6 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li>
<ul>
<li><a href="#md:globally"><span>Globally</span></a></li></ul></li>
<li><a href="#md:show-a-cadenza-page-in-an-iframe"><span>Show a <wbr/>Cadenza page in an <wbr/>Iframe</span></a></li>
<li><a href="#md:show-an-embedding-target-in-an-iframe"><span>Show an <wbr/>Embedding <wbr/>Target in an <wbr/>Iframe</span></a></li>
<li>
<ul>
Expand All @@ -140,7 +127,6 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="#md:subscribe-to-an-event-with-types"><span>Subscribe to an <wbr/>Event <wbr/>With <wbr/>Types</span></a></li>
<li><a href="#md:unsubscribe-from-an-event"><span>Unsubscribe <wbr/>From an <wbr/>Event</span></a></li>
<li><a href="#md:create-a-new-geometry"><span>Create a <wbr/>New <wbr/>Geometry</span></a></li>
<li><a href="#md:expandcollapse-the-navigator-tree"><span>Expand/collapse the navigator tree</span></a></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><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>
<div class="site-menu">
Expand All @@ -152,7 +138,6 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="interfaces/CadenzaEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Cadenza<wbr/>Event</span></a></li>
<li><a href="interfaces/ExternalLinkKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>External<wbr/>Link<wbr/>Key</span></a></li>
<li><a href="interfaces/Geometry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Geometry</span></a></li>
<li><a href="interfaces/PageSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Page<wbr/>Source</span></a></li>
<li><a href="interfaces/WorkbookKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workbook<wbr/>Key</span></a></li>
<li><a href="interfaces/WorkbookViewKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workbook<wbr/>View<wbr/>Key</span></a></li>
<li><a href="interfaces/WorksheetKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worksheet<wbr/>Key</span></a></li>
Expand Down
Loading

0 comments on commit ec5a117

Please sign in to comment.