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 3, 2023
1 parent a454290 commit 54f4045
Show file tree
Hide file tree
Showing 19 changed files with 62 additions and 64 deletions.
4 changes: 2 additions & 2 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/99f0f06/src/cadenza.js#L714">src/cadenza.js:714</a></li></ul></aside>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/0add82b/src/cadenza.js#L714">src/cadenza.js:714</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/99f0f06/src/cadenza.js#L715">src/cadenza.js:715</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/0add82b/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>Properties</h2>
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="ABORT_ERR" class="tsd-anchor"></a>
Expand Down
52 changes: 26 additions & 26 deletions classes/CadenzaClient.html

Large diffs are not rendered by default.

8 changes: 4 additions & 4 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/99f0f06/src/cadenza.js#L725">src/cadenza.js:725</a></li></ul></aside>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/0add82b/src/cadenza.js#L725">src/cadenza.js:725</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/99f0f06/src/cadenza.js#L732">src/cadenza.js:732</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/0add82b/src/cadenza.js#L732">src/cadenza.js:732</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/99f0f06/src/cadenza.js#L726">src/cadenza.js:726</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/0add82b/src/cadenza.js#L726">src/cadenza.js:726</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/99f0f06/src/cadenza.js#L737">src/cadenza.js:737</a></li></ul></aside></li></ul></section></section>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/0add82b/src/cadenza.js#L737">src/cadenza.js:737</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
2 changes: 1 addition & 1 deletion 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/99f0f06/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/0add82b/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 Down
6 changes: 2 additions & 4 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,13 +40,11 @@ <h2>Cadenza JS</h2></div>
<li>If the embedding target cannot be resolved, 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-the-generated-pdf-of-a-jasper-report-view-directly" class="tsd-anchor"></a><h4><a href="#md:show-the-generated-pdf-of-a-jasper-report-view-directly">Show the Generated PDF of a Jasper Report View Directly</a></h4><p>Views of type &quot;JasperReports report&quot; can be shown in an iFrame like any other view.
But there is an additional option to show only the generated PDF without any Cadenza footers or headers.
This is done by setting the &quot;mediaType&quot; option to &quot;application/pdf&quot;.</p>
<a id="md:show-the-generated-pdf-of-a-jasper-report-view-directly" class="tsd-anchor"></a><h4><a href="#md:show-the-generated-pdf-of-a-jasper-report-view-directly">Show the Generated PDF of a Jasper Report View Directly</a></h4><p>Views of type &quot;JasperReports report&quot; can be shown in an iframe like any other view. Additionally, there is an option to show only the generated PDF without any Cadenza footers or headers. This is done by setting the &quot;mediaType&quot; option to &quot;application/pdf&quot;.</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">mediaType:</span><span class="hl-2"> </span><span class="hl-7">&#39;application/pdf&#39;</span><br/><span class="hl-2">});</span>
</code><button>Copy</button></pre>
<a id="md:abort-iframe-loading" class="tsd-anchor"></a><h3><a href="#md:abort-iframe-loading">Abort (Iframe) Loading</a></h3><p>Cadenza JS uses the <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortController">AbortController Web API</a> for aborting requests. This is supported by most of the public methods.</p>
<pre><code class="language-javascript"><span class="hl-8">const</span><span class="hl-2"> </span><span class="hl-9">abortController</span><span class="hl-2"> = </span><span class="hl-8">new</span><span class="hl-2"> </span><span class="hl-10">AbortController</span><span class="hl-2">();</span><br/><span class="hl-5">try</span><span class="hl-2"> {</span><br/><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">show</span><span class="hl-2">(</span><span class="hl-7">&#39;{embeddingTargetId}&#39;</span><span class="hl-2">, { </span><span class="hl-6">signal:</span><span class="hl-2"> </span><span class="hl-6">abortController</span><span class="hl-2">.</span><span class="hl-6">signal</span><span class="hl-2"> });</span><br/><span class="hl-2">} </span><span class="hl-5">catch</span><span class="hl-2"> (</span><span class="hl-6">error</span><span class="hl-2">) {</span><br/><span class="hl-2"> </span><span class="hl-5">if</span><span class="hl-2"> (</span><span class="hl-6">error</span><span class="hl-2">.</span><span class="hl-6">name</span><span class="hl-2"> === </span><span class="hl-7">&#39;AbortError&#39;</span><span class="hl-2">) {</span><br/><span class="hl-2"> </span><span class="hl-6">console</span><span class="hl-2">.</span><span class="hl-10">log</span><span class="hl-2">(</span><span class="hl-7">&#39;Iframe loading was aborted&#39;</span><span class="hl-2">);</span><br/><span class="hl-2"> }</span><br/><span class="hl-2">}</span><br/><br/><span class="hl-6">cancelButton</span><span class="hl-2">.</span><span class="hl-10">onclick</span><span class="hl-2"> = () </span><span class="hl-8">=&gt;</span><span class="hl-2"> </span><span class="hl-6">abortController</span><span class="hl-2">.</span><span class="hl-10">abort</span><span class="hl-2">();</span>
<pre><code class="language-javascript"><span class="hl-8">const</span><span class="hl-2"> </span><span class="hl-9">abortController</span><span class="hl-2"> = </span><span class="hl-8">new</span><span class="hl-2"> </span><span class="hl-10">AbortController</span><span class="hl-2">();</span><br/><span class="hl-5">try</span><span class="hl-2"> {</span><br/><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">show</span><span class="hl-2">(</span><span class="hl-7">&#39;{embeddingTargetId}&#39;</span><span class="hl-2">, { </span><span class="hl-6">signal:</span><span class="hl-2"> </span><span class="hl-6">abortController</span><span class="hl-2">.</span><span class="hl-6">signal</span><span class="hl-2"> });</span><br/><span class="hl-2">} </span><span class="hl-5">catch</span><span class="hl-2"> (</span><span class="hl-6">error</span><span class="hl-2">) {</span><br/><span class="hl-2"> </span><span class="hl-5">if</span><span class="hl-2"> (</span><span class="hl-6">error</span><span class="hl-2">.</span><span class="hl-6">name</span><span class="hl-2"> === </span><span class="hl-7">&#39;AbortError&#39;</span><span class="hl-2">) {</span><br/><span class="hl-2"> </span><span class="hl-6">console</span><span class="hl-2">.</span><span class="hl-10">log</span><span class="hl-2">(</span><span class="hl-7">&#39;Iframe loading was aborted&#39;</span><span class="hl-2">);</span><br/><span class="hl-2"> }</span><br/><span class="hl-2">}</span><br/><br/><span class="hl-6">cancelButton</span><span class="hl-2">.</span><span class="hl-10">onclick</span><span class="hl-2"> = () </span><span class="hl-8">=&gt;</span><span class="hl-2"> </span><span class="hl-6">abortController</span><span class="hl-2">.</span><span class="hl-10">abort</span><span class="hl-2">();</span>
</code><button>Copy</button></pre>
<p><em>Tip:</em> You can use the same <code>AbortController</code> to abort multiple requests, e.g. when embedding Cadenza in multiple iframes.</p>
<a id="md:show-a-workbook-map-view" class="tsd-anchor"></a><h3><a href="#md:show-a-workbook-map-view">Show a Workbook Map View</a></h3><p><small>API: <a href="./classes/CadenzaClient.html#showMap">CadenzaClient#showMap</a></small></p>
Expand Down
6 changes: 3 additions & 3 deletions interfaces/CadenzaEvent.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">CadenzaEvent</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/99f0f06/src/cadenza.js#L707">src/cadenza.js:707</a></li></ul></aside>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/0add82b/src/cadenza.js#L707">src/cadenza.js:707</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 All @@ -50,15 +50,15 @@ <h3 class="tsd-anchor-link"><span>detail</span><a href="#detail" aria-label="Per
</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/99f0f06/src/cadenza.js#L709">src/cadenza.js:709</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/0add82b/src/cadenza.js#L709">src/cadenza.js:709</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><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>
<div class="tsd-comment tsd-typography"><p>The event type</p>
</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/99f0f06/src/cadenza.js#L708">src/cadenza.js:708</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/0add82b/src/cadenza.js#L708">src/cadenza.js:708</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
6 changes: 3 additions & 3 deletions interfaces/ExternalLinkKey.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">ExternalLinkKey</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/99f0f06/src/cadenza.js#L31">src/cadenza.js:31</a></li></ul></aside>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/0add82b/src/cadenza.js#L31">src/cadenza.js:31</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 All @@ -44,15 +44,15 @@ <h3 class="tsd-anchor-link"><span>external<wbr/>Link<wbr/>Id</span><a href="#ext
</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/99f0f06/src/cadenza.js#L33">src/cadenza.js:33</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/0add82b/src/cadenza.js#L33">src/cadenza.js:33</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="repositoryName" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>repository<wbr/>Name</span><a href="#repositoryName" 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">repository<wbr/>Name</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>The name of the link&#39;s repository</p>
</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/99f0f06/src/cadenza.js#L32">src/cadenza.js:32</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/0add82b/src/cadenza.js#L32">src/cadenza.js:32</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
4 changes: 2 additions & 2 deletions interfaces/Geometry.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">Geometry</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/99f0f06/src/cadenza.js#L58">src/cadenza.js:58</a></li></ul></aside>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/0add82b/src/cadenza.js#L58">src/cadenza.js:58</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 All @@ -43,7 +43,7 @@ <h3 class="tsd-anchor-link"><span>type</span><a href="#type" aria-label="Permali
</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/99f0f06/src/cadenza.js#L59">src/cadenza.js:59</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/0add82b/src/cadenza.js#L59">src/cadenza.js:59</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
6 changes: 3 additions & 3 deletions interfaces/WorkbookKey.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">WorkbookKey</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/99f0f06/src/cadenza.js#L36">src/cadenza.js:36</a></li></ul></aside>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/0add82b/src/cadenza.js#L36">src/cadenza.js:36</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 All @@ -44,15 +44,15 @@ <h3 class="tsd-anchor-link"><span>repository<wbr/>Name</span><a href="#repositor
</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/99f0f06/src/cadenza.js#L37">src/cadenza.js:37</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/0add82b/src/cadenza.js#L37">src/cadenza.js:37</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="workbookId" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>workbook<wbr/>Id</span><a href="#workbookId" 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">workbook<wbr/>Id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<div class="tsd-comment tsd-typography"><p>The ID of the workbook</p>
</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/99f0f06/src/cadenza.js#L38">src/cadenza.js:38</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/0add82b/src/cadenza.js#L38">src/cadenza.js:38</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand Down
Loading

0 comments on commit 54f4045

Please sign in to comment.