@disy/cadenza.js 0.0.1 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +13 -0
- package/LICENSE +201 -21
- package/README.md +54 -5
- package/apidoc/assets/highlight.css +22 -22
- package/apidoc/assets/search.js +1 -1
- package/apidoc/classes/AbortError.html +7 -2
- package/apidoc/classes/CadenzaClient.html +258 -63
- package/apidoc/classes/CadenzaError.html +9 -4
- package/apidoc/functions/cadenza.html +13 -3
- package/apidoc/index.html +43 -18
- package/apidoc/interfaces/CadenzaEvent.html +8 -3
- package/apidoc/interfaces/ExternalLinkKey.html +103 -0
- package/apidoc/interfaces/Geometry.html +7 -2
- package/apidoc/interfaces/WorkbookKey.html +8 -3
- package/apidoc/interfaces/WorkbookViewKey.html +9 -4
- package/apidoc/interfaces/WorksheetKey.html +9 -4
- package/apidoc/modules.html +10 -0
- package/apidoc/types/CadenzaErrorEvent.html +6 -1
- package/apidoc/types/EmbeddingTargetId.html +6 -1
- package/apidoc/types/Extent.html +6 -1
- package/apidoc/types/GeometryType.html +6 -1
- package/apidoc/types/GlobalId.html +65 -0
- package/apidoc/types/MediaType.html +66 -0
- package/apidoc/types/OperationMode.html +65 -0
- package/apidoc/types/UiFeature.html +70 -0
- package/apidoc/types/WorkbookSource.html +6 -1
- package/apidoc/types/WorkbookViewSource.html +6 -1
- package/apidoc/types/WorksheetSource.html +6 -1
- package/cadenza.d.ts +130 -20
- package/cadenza.js +264 -93
- package/package.json +12 -5
- package/sandbox.html +342 -0
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
<ul class="tsd-hierarchy">
|
|
28
28
|
<li><span class="target">CadenzaError</span></li></ul></li></ul></section><aside class="tsd-sources">
|
|
29
29
|
<ul>
|
|
30
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
30
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L751">src/cadenza.js:751</a></li></ul></aside>
|
|
31
31
|
<section class="tsd-panel-group tsd-index-group">
|
|
32
32
|
<section class="tsd-panel tsd-index-panel">
|
|
33
33
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -79,14 +79,14 @@
|
|
|
79
79
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
80
80
|
<p>Overrides Error.constructor</p>
|
|
81
81
|
<ul>
|
|
82
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
82
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L758">src/cadenza.js:758</a></li></ul></aside></li></ul></section></section>
|
|
83
83
|
<section class="tsd-panel-group tsd-member-group">
|
|
84
84
|
<h2>Properties</h2>
|
|
85
85
|
<section class="tsd-panel tsd-member tsd-is-private"><a id="_type" class="tsd-anchor"></a>
|
|
86
86
|
<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>
|
|
87
87
|
<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">
|
|
88
88
|
<ul>
|
|
89
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
89
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L752">src/cadenza.js:752</a></li></ul></aside></section>
|
|
90
90
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="cause" class="tsd-anchor"></a>
|
|
91
91
|
<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>
|
|
92
92
|
<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 @@
|
|
|
152
152
|
<li class="tsd-description">
|
|
153
153
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
|
|
154
154
|
<ul>
|
|
155
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
155
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L763">src/cadenza.js:763</a></li></ul></aside></li></ul></section></section>
|
|
156
156
|
<section class="tsd-panel-group tsd-member-group">
|
|
157
157
|
<h2>Methods</h2>
|
|
158
158
|
<section class="tsd-panel tsd-member tsd-is-inherited tsd-is-external"><a id="captureStackTrace" class="tsd-anchor"></a>
|
|
@@ -210,6 +210,7 @@
|
|
|
210
210
|
<li><a href="CadenzaClient.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cadenza<wbr/>Client</span></a></li>
|
|
211
211
|
<li><a href="CadenzaError.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cadenza<wbr/>Error</span></a></li>
|
|
212
212
|
<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>
|
|
213
|
+
<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>
|
|
213
214
|
<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>
|
|
214
215
|
<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>
|
|
215
216
|
<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>
|
|
@@ -218,6 +219,10 @@
|
|
|
218
219
|
<li><a href="../types/EmbeddingTargetId.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Embedding<wbr/>Target<wbr/>Id</span></a></li>
|
|
219
220
|
<li><a href="../types/Extent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Extent</span></a></li>
|
|
220
221
|
<li><a href="../types/GeometryType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Geometry<wbr/>Type</span></a></li>
|
|
222
|
+
<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>
|
|
223
|
+
<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>
|
|
224
|
+
<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>
|
|
225
|
+
<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>
|
|
221
226
|
<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>
|
|
222
227
|
<li><a href="../types/WorkbookViewSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Workbook<wbr/>View<wbr/>Source</span></a></li>
|
|
223
228
|
<li><a href="../types/WorksheetSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worksheet<wbr/>Source</span></a></li>
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
</div>
|
|
31
31
|
<div class="tsd-comment tsd-typography"></div></li>
|
|
32
32
|
<li>
|
|
33
|
-
<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">debug</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">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><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
|
33
|
+
<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">debug</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">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><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">webApplication</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><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
|
34
34
|
<div class="tsd-comment tsd-typography"><p>Options</p>
|
|
35
35
|
</div>
|
|
36
36
|
<div class="tsd-comment tsd-typography"></div>
|
|
@@ -44,13 +44,18 @@
|
|
|
44
44
|
<h5><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></h5>
|
|
45
45
|
<div class="tsd-comment tsd-typography"><p>An iframe for embedding Cadenza or the iframe's ID</p>
|
|
46
46
|
</div>
|
|
47
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
48
|
+
<li class="tsd-parameter">
|
|
49
|
+
<h5><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></h5>
|
|
50
|
+
<div class="tsd-comment tsd-typography"><p>An external link that Cadenza uses to resolve the <a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage#targetorigin">target origin</a> when posting events. This is required if Cadenza and your application are not running on the same origin.</p>
|
|
51
|
+
</div>
|
|
47
52
|
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div>
|
|
48
53
|
<h4 class="tsd-returns-title">Returns <a href="../classes/CadenzaClient.html" class="tsd-signature-type tsd-kind-class">CadenzaClient</a></h4>
|
|
49
54
|
<div class="tsd-comment tsd-typography">
|
|
50
|
-
<h4>Throws</h4><p>For invalid
|
|
55
|
+
<h4>Throws</h4><p>For invalid arguments</p>
|
|
51
56
|
</div><aside class="tsd-sources">
|
|
52
57
|
<ul>
|
|
53
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
58
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L11">src/cadenza.js:11</a></li></ul></aside></li></ul></section></div>
|
|
54
59
|
<div class="col-sidebar">
|
|
55
60
|
<div class="page-menu">
|
|
56
61
|
<div class="tsd-navigation settings">
|
|
@@ -73,6 +78,7 @@
|
|
|
73
78
|
<li><a href="../classes/CadenzaClient.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cadenza<wbr/>Client</span></a></li>
|
|
74
79
|
<li><a href="../classes/CadenzaError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cadenza<wbr/>Error</span></a></li>
|
|
75
80
|
<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>
|
|
81
|
+
<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>
|
|
76
82
|
<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>
|
|
77
83
|
<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>
|
|
78
84
|
<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>
|
|
@@ -81,6 +87,10 @@
|
|
|
81
87
|
<li><a href="../types/EmbeddingTargetId.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Embedding<wbr/>Target<wbr/>Id</span></a></li>
|
|
82
88
|
<li><a href="../types/Extent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Extent</span></a></li>
|
|
83
89
|
<li><a href="../types/GeometryType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Geometry<wbr/>Type</span></a></li>
|
|
90
|
+
<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>
|
|
91
|
+
<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>
|
|
92
|
+
<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>
|
|
93
|
+
<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>
|
|
84
94
|
<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>
|
|
85
95
|
<li><a href="../types/WorkbookViewSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Workbook<wbr/>View<wbr/>Source</span></a></li>
|
|
86
96
|
<li><a href="../types/WorksheetSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worksheet<wbr/>Source</span></a></li>
|
package/apidoc/index.html
CHANGED
|
@@ -13,35 +13,41 @@
|
|
|
13
13
|
<div class="tsd-page-title">
|
|
14
14
|
<h2>Cadenza JS</h2></div>
|
|
15
15
|
<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>
|
|
16
|
+
<a id="md:installation" class="tsd-anchor"></a><h2><a href="#md:installation">Installation</a></h2><p>Install using npm:</p>
|
|
17
|
+
<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>
|
|
18
|
+
</code><button>Copy</button></pre>
|
|
16
19
|
<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 "API:" links.</p>
|
|
17
20
|
<a id="md:general-usage" class="tsd-anchor"></a><h3><a href="#md:general-usage">General Usage</a></h3><p><small>API: <a href="./functions/cadenza.html">cadenza()</a></small></p>
|
|
18
21
|
<p>There are two ways to use Cadenza JS: As a module and globally.</p>
|
|
19
22
|
<a id="md:as-a-module" class="tsd-anchor"></a><h4><a href="#md:as-a-module">As a module</a></h4><p>Create an instance of the Cadenza client by calling <code>cadenza()</code> with the base URL of your Cadenza instance. Pass an iframe in the options if you want to show Cadenza in an iframe.</p>
|
|
20
|
-
<pre><code class="language-html"><span class="hl-
|
|
23
|
+
<pre><code class="language-html"><span class="hl-3"><</span><span class="hl-4">iframe</span><span class="hl-1"> </span><span class="hl-5">id</span><span class="hl-1">=</span><span class="hl-6">"cadenza-iframe"</span><span class="hl-3">></</span><span class="hl-4">iframe</span><span class="hl-3">></span>
|
|
21
24
|
</code><button>Copy</button></pre>
|
|
22
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
25
|
+
<pre><code class="language-javascript"><span class="hl-7">import</span><span class="hl-1"> { </span><span class="hl-8">cadenza</span><span class="hl-1"> } </span><span class="hl-7">from</span><span class="hl-1"> </span><span class="hl-2">'@disy/cadenza.js'</span><span class="hl-1">;</span><br/><br/><span class="hl-9">const</span><span class="hl-1"> </span><span class="hl-10">cadenzaClient</span><span class="hl-1"> = </span><span class="hl-0">cadenza</span><span class="hl-1">(</span><span class="hl-2">'{baseUrl}'</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-8">iframe:</span><span class="hl-1"> </span><span class="hl-2">'cadenza-iframe'</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
|
|
23
26
|
</code><button>Copy</button></pre>
|
|
24
27
|
<p><em>Tip:</em> If you develop your application in TypeScript - Cadenza JS is typed using JSDoc and also comes with a <code>cadenza.d.ts</code> type definition file.</p>
|
|
25
|
-
<a id="md:globally" class="tsd-anchor"></a><h4><a href="#md:globally">Globally</a></h4><pre><code class="language-html"><span class="hl-
|
|
28
|
+
<a id="md:globally" class="tsd-anchor"></a><h4><a href="#md:globally">Globally</a></h4><pre><code class="language-html"><span class="hl-3"><</span><span class="hl-4">script</span><span class="hl-11"> </span><span class="hl-5">type</span><span class="hl-11">=</span><span class="hl-6">"module"</span><span class="hl-11"> </span><span class="hl-5">src</span><span class="hl-11">=</span><span class="hl-6">"./cadenza.js"</span><span class="hl-3">></span>
|
|
26
29
|
</code><button>Copy</button></pre>
|
|
27
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
30
|
+
<pre><code class="language-javascript"><span class="hl-9">const</span><span class="hl-1"> </span><span class="hl-10">cadenzaClient</span><span class="hl-1"> = </span><span class="hl-8">window</span><span class="hl-1">.</span><span class="hl-0">cadenza</span><span class="hl-1">(</span><span class="hl-2">'{baseUrl}'</span><span class="hl-1">, ...);</span>
|
|
28
31
|
</code><button>Copy</button></pre>
|
|
29
32
|
<p>The <code>type="module"</code> has the effect that script execution is <a href="https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script#defer">deferred</a>. You might need to wait for the <code>DOMContentLoaded</code> event in order to use Cadenza JS.</p>
|
|
30
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
33
|
+
<pre><code class="language-javascript"><span class="hl-8">window</span><span class="hl-1">.</span><span class="hl-0">addEventListener</span><span class="hl-1">(</span><span class="hl-2">'DOMContentLoaded'</span><span class="hl-1">, () </span><span class="hl-9">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-9">const</span><span class="hl-1"> </span><span class="hl-10">cadenzaClient</span><span class="hl-1"> = </span><span class="hl-8">window</span><span class="hl-1">.</span><span class="hl-0">cadenza</span><span class="hl-1">(...);</span><br/><span class="hl-1"> ...</span><br/><span class="hl-1">});</span>
|
|
31
34
|
</code><button>Copy</button></pre>
|
|
32
35
|
<p>If for some reason you don't like the global <code>cadenza</code> field, you can remove it like so:</p>
|
|
33
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
36
|
+
<pre><code class="language-javascript"><span class="hl-9">const</span><span class="hl-1"> </span><span class="hl-10">cadenza</span><span class="hl-1"> = </span><span class="hl-8">window</span><span class="hl-1">.</span><span class="hl-8">cadenza</span><span class="hl-1">.</span><span class="hl-0">noConflict</span><span class="hl-1">();</span>
|
|
34
37
|
</code><button>Copy</button></pre>
|
|
35
38
|
<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>
|
|
36
|
-
<p>Show an embedding target in an iframe and hide Cadenza's main header and footer as well as the workbook toolbar
|
|
37
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
39
|
+
<p>Show an embedding target in an iframe and hide Cadenza's main header and footer as well as the workbook toolbar. Additionally, enable simplified operation mode and disable the designer.</p>
|
|
40
|
+
<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">'{embeddingTargetId}'</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-8">hideMainHeaderAndFooter:</span><span class="hl-1"> </span><span class="hl-9">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-8">hideWorkbookToolBar:</span><span class="hl-1"> </span><span class="hl-9">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-8">operationMode:</span><span class="hl-1"> </span><span class="hl-2">'simplified'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-8">disabledUiFeatures:</span><span class="hl-1"> [</span><span class="hl-2">'workbook-design'</span><span class="hl-1">]</span><br/><span class="hl-1">});</span>
|
|
38
41
|
</code><button>Copy</button></pre>
|
|
39
42
|
<ul>
|
|
40
43
|
<li>If the embedding target cannot be resolved, a 404 page is shown to the user.</li>
|
|
41
44
|
<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>
|
|
42
45
|
</ul>
|
|
46
|
+
<a id="md:show-the-generated-pdf-of-a-quotjasperreports-reportquot-view-directly" class="tsd-anchor"></a><h4><a href="#md:show-the-generated-pdf-of-a-quotjasperreports-reportquot-view-directly">Show the Generated PDF of a "JasperReports report" View Directly</a></h4><p>Views of type "JasperReports report" 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 "mediaType" option to "application/pdf".</p>
|
|
47
|
+
<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">'{embeddingTargetId}'</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-8">mediaType:</span><span class="hl-1"> </span><span class="hl-2">'application/pdf'</span><br/><span class="hl-1">});</span>
|
|
48
|
+
</code><button>Copy</button></pre>
|
|
43
49
|
<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>
|
|
44
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
50
|
+
<pre><code class="language-javascript"><span class="hl-9">const</span><span class="hl-1"> </span><span class="hl-10">abortController</span><span class="hl-1"> = </span><span class="hl-9">new</span><span class="hl-1"> </span><span class="hl-0">AbortController</span><span class="hl-1">();</span><br/><span class="hl-7">try</span><span class="hl-1"> {</span><br/><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">show</span><span class="hl-1">(</span><span class="hl-2">'{embeddingTargetId}'</span><span class="hl-1">, { </span><span class="hl-8">signal:</span><span class="hl-1"> </span><span class="hl-8">abortController</span><span class="hl-1">.</span><span class="hl-8">signal</span><span class="hl-1"> });</span><br/><span class="hl-1">} </span><span class="hl-7">catch</span><span class="hl-1"> (</span><span class="hl-8">error</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-7">if</span><span class="hl-1"> (</span><span class="hl-8">error</span><span class="hl-1">.</span><span class="hl-8">name</span><span class="hl-1"> === </span><span class="hl-2">'AbortError'</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-8">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'Iframe loading was aborted'</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-8">cancelButton</span><span class="hl-1">.</span><span class="hl-0">onclick</span><span class="hl-1"> = () </span><span class="hl-9">=></span><span class="hl-1"> </span><span class="hl-8">abortController</span><span class="hl-1">.</span><span class="hl-0">abort</span><span class="hl-1">();</span>
|
|
45
51
|
</code><button>Copy</button></pre>
|
|
46
52
|
<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>
|
|
47
53
|
<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>
|
|
@@ -51,26 +57,34 @@
|
|
|
51
57
|
<li>Show the given GeoJSON geometry on the map.</li>
|
|
52
58
|
</ul>
|
|
53
59
|
<p>The coordinates of extent and geometry are in the map's SRS.</p>
|
|
54
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
60
|
+
<pre><code class="language-javascript"><span class="hl-8">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">showMap</span><span class="hl-1">(</span><span class="hl-2">'{embeddingTargetId}'</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-8">useMapSrs:</span><span class="hl-1"> </span><span class="hl-9">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-8">mapExtent:</span><span class="hl-1"> [</span><br/><span class="hl-1"> -</span><span class="hl-12">572_513.341856</span><span class="hl-1">, </span><span class="hl-12">5_211_017.966314</span><span class="hl-1">, </span><span class="hl-12">916_327.095083</span><span class="hl-1">, </span><span class="hl-12">6_636_950.728974</span><span class="hl-1">,</span><br/><span class="hl-1"> ],</span><br/><span class="hl-1"> </span><span class="hl-8">geometry:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">type:</span><span class="hl-1"> </span><span class="hl-2">'Point'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-8">coordinates:</span><span class="hl-1"> [</span><span class="hl-12">328_627.563458</span><span class="hl-1">, </span><span class="hl-12">5_921_296.662223</span><span class="hl-1">],</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">});</span>
|
|
55
61
|
</code><button>Copy</button></pre>
|
|
56
|
-
<a id="md:initialize-the-map-extent-by-setting-the-location-finder" class="tsd-anchor"></a><h4><a href="#md:initialize-the-map-extent-by-setting-the-location-finder">Initialize the Map Extent by Setting the Location Finder</a></h4><pre><code class="language-javascript"><span class="hl-
|
|
62
|
+
<a id="md:initialize-the-map-extent-by-setting-the-location-finder" class="tsd-anchor"></a><h4><a href="#md:initialize-the-map-extent-by-setting-the-location-finder">Initialize the Map Extent by Setting the Location Finder</a></h4><pre><code class="language-javascript"><span class="hl-8">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">showMap</span><span class="hl-1">(</span><span class="hl-2">'{embeddingTargetId}'</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-8">locationFinder:</span><span class="hl-1"> </span><span class="hl-2">'Karlsruhe'</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
|
|
57
63
|
</code><button>Copy</button></pre>
|
|
58
64
|
<a id="md:edit-an-existing-geometry" class="tsd-anchor"></a><h3><a href="#md:edit-an-existing-geometry">Edit an Existing Geometry</a></h3><p><small>API: <a href="./classes/CadenzaClient.html#editGeometry">CadenzaClient#editGeometry</a>, <a href="./classes/CadenzaClient.html#on">CadenzaClient#on</a></small></p>
|
|
59
65
|
<p>Edit a GeoJSON geometry with a workbook map view in the background. The geometry coordinates are in the map's SRS.</p>
|
|
60
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
66
|
+
<pre><code class="language-javascript"><span class="hl-9">const</span><span class="hl-1"> </span><span class="hl-10">geometry</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-8">type:</span><span class="hl-1"> </span><span class="hl-2">'Point'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-8">coordinates:</span><span class="hl-1"> [</span><span class="hl-12">328_627.563458</span><span class="hl-1">, </span><span class="hl-12">5_921_296.662223</span><span class="hl-1">],</span><br/><span class="hl-1">};</span><br/><span class="hl-8">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">editGeometry</span><span class="hl-1">(</span><span class="hl-2">'{embeddingTargetId}'</span><span class="hl-1">, </span><span class="hl-8">geometry</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-8">useMapSrs:</span><span class="hl-1"> </span><span class="hl-9">true</span><span class="hl-1">,</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-8">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">'editGeometry:update'</span><span class="hl-1">, (</span><span class="hl-8">event</span><span class="hl-1">) </span><span class="hl-9">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'Geometry was updated'</span><span class="hl-1">, </span><span class="hl-8">event</span><span class="hl-1">.</span><span class="hl-8">detail</span><span class="hl-1">.</span><span class="hl-8">geometry</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-8">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">'editGeometry:ok'</span><span class="hl-1">, (</span><span class="hl-8">event</span><span class="hl-1">) </span><span class="hl-9">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'Geometry editing was completed'</span><span class="hl-1">, </span><span class="hl-8">event</span><span class="hl-1">.</span><span class="hl-8">detail</span><span class="hl-1">.</span><span class="hl-8">geometry</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-8">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">'editGeometry:cancel'</span><span class="hl-1">, (</span><span class="hl-8">event</span><span class="hl-1">) </span><span class="hl-9">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'Geometry editing was cancelled'</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
|
61
67
|
</code><button>Copy</button></pre>
|
|
62
68
|
<a id="md:subscribe-to-an-event-with-types" class="tsd-anchor"></a><h3><a href="#md:subscribe-to-an-event-with-types">Subscribe to an Event With Types</a></h3><p>If you develop your application in TypeScript, you need to define the type of the <code>event.detail</code> in order to access its properties:</p>
|
|
63
|
-
<pre><code class="language-typescript"><span class="hl-
|
|
69
|
+
<pre><code class="language-typescript"><span class="hl-8">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><br/><span class="hl-1"> </span><span class="hl-2">'editGeometry:ok'</span><span class="hl-1">,</span><br/><span class="hl-1"> (</span><span class="hl-8">event</span><span class="hl-1">: </span><span class="hl-13">CadenzaEvent</span><span class="hl-1"><{ </span><span class="hl-8">geometry</span><span class="hl-1">: </span><span class="hl-13">Geometry</span><span class="hl-1"> }>) </span><span class="hl-9">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'Geometry editing was completed'</span><span class="hl-1">, </span><span class="hl-8">event</span><span class="hl-1">.</span><span class="hl-8">detail</span><span class="hl-1">.</span><span class="hl-8">geometry</span><span class="hl-1">);</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">);</span>
|
|
64
70
|
</code><button>Copy</button></pre>
|
|
65
71
|
<a id="md:unsubscribe-from-an-event" class="tsd-anchor"></a><h3><a href="#md:unsubscribe-from-an-event">Unsubscribe From an Event</a></h3><p>The <code>on()</code> method returns an unsubscribe function.</p>
|
|
66
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
72
|
+
<pre><code class="language-javascript"><span class="hl-9">const</span><span class="hl-1"> </span><span class="hl-10">unsubscribe</span><span class="hl-1"> = </span><span class="hl-8">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">'editGeometry:ok'</span><span class="hl-1">, (</span><span class="hl-8">event</span><span class="hl-1">) </span><span class="hl-9">=></span><span class="hl-1"> ...);</span><br/><span class="hl-1">...</span><br/><span class="hl-0">unsubscribe</span><span class="hl-1">();</span>
|
|
67
73
|
</code><button>Copy</button></pre>
|
|
68
74
|
<a id="md:create-a-new-geometry" class="tsd-anchor"></a><h3><a href="#md:create-a-new-geometry">Create a New Geometry</a></h3><p><small>API: <a href="./classes/CadenzaClient.html#createGeometry">CadenzaClient#createGeometry</a></small></p>
|
|
69
75
|
<p>Edit a GeoJSON point geometry with a workbook map view in the background. The geometry coordinates are in the map's SRS.</p>
|
|
70
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
76
|
+
<pre><code class="language-javascript"><span class="hl-8">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">createGeometry</span><span class="hl-1">(</span><span class="hl-2">'{embeddingTargetId}'</span><span class="hl-1">, </span><span class="hl-2">'Point'</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-8">useMapSrs:</span><span class="hl-1"> </span><span class="hl-9">true</span><span class="hl-1">,</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-8">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">'editGeometry:ok'</span><span class="hl-1">, (</span><span class="hl-8">event</span><span class="hl-1">) </span><span class="hl-9">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'Geometry editing was completed'</span><span class="hl-1">, </span><span class="hl-8">event</span><span class="hl-1">.</span><span class="hl-8">detail</span><span class="hl-1">.</span><span class="hl-8">geometry</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
|
71
77
|
</code><button>Copy</button></pre>
|
|
72
78
|
<p><em>Note:</em> Under the hood, creating a geometry is similar to editing a geometry.
|
|
73
79
|
That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
80
|
+
<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>
|
|
81
|
+
<p>Fetch data from a workbook view in CSV format.</p>
|
|
82
|
+
<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">'{embeddingTargetId}'</span><span class="hl-1">, </span><span class="hl-2">'text/csv'</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>
|
|
83
|
+
</code><button>Copy</button></pre>
|
|
84
|
+
<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>
|
|
85
|
+
<p>Download data from a workbook view in Excel format. This triggers the browser's download dialog.</p>
|
|
86
|
+
<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">'button'</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">'Download Excel'</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">=></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">'{embeddingTargetId}'</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-2">'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'</span><span class="hl-1">);</span><br/><span class="hl-1">};</span>
|
|
87
|
+
</code><button>Copy</button></pre>
|
|
74
88
|
</div></div>
|
|
75
89
|
<div class="col-sidebar">
|
|
76
90
|
<div class="page-menu">
|
|
@@ -93,6 +107,9 @@ That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
|
93
107
|
<ul>
|
|
94
108
|
<li>
|
|
95
109
|
<ul>
|
|
110
|
+
<li><a href="#md:installation"><span>Installation</span></a></li>
|
|
111
|
+
<li>
|
|
112
|
+
<ul>
|
|
96
113
|
<li><a href="#md:usage-examples"><span>Usage <wbr/>Examples</span></a></li>
|
|
97
114
|
<li>
|
|
98
115
|
<ul>
|
|
@@ -100,10 +117,11 @@ That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
|
100
117
|
<li>
|
|
101
118
|
<ul>
|
|
102
119
|
<li><a href="#md:as-a-module"><span>As a module</span></a></li>
|
|
103
|
-
<li>
|
|
104
|
-
<ul>
|
|
105
120
|
<li><a href="#md:globally"><span>Globally</span></a></li></ul></li>
|
|
106
121
|
<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>
|
|
122
|
+
<li>
|
|
123
|
+
<ul>
|
|
124
|
+
<li><a href="#md:show-the-generated-pdf-of-a-quotjasperreports-reportquot-view-directly"><span>Show the <wbr/>Generated PDF of a "<wbr/>Jasper<wbr/>Reports report" <wbr/>View <wbr/>Directly</span></a></li></ul></li>
|
|
107
125
|
<li><a href="#md:abort-iframe-loading"><span>Abort (<wbr/>Iframe) <wbr/>Loading</span></a></li>
|
|
108
126
|
<li><a href="#md:show-a-workbook-map-view"><span>Show a <wbr/>Workbook <wbr/>Map <wbr/>View</span></a></li>
|
|
109
127
|
<li>
|
|
@@ -112,7 +130,9 @@ That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
|
112
130
|
<li><a href="#md:edit-an-existing-geometry"><span>Edit an <wbr/>Existing <wbr/>Geometry</span></a></li>
|
|
113
131
|
<li><a href="#md:subscribe-to-an-event-with-types"><span>Subscribe to an <wbr/>Event <wbr/>With <wbr/>Types</span></a></li>
|
|
114
132
|
<li><a href="#md:unsubscribe-from-an-event"><span>Unsubscribe <wbr/>From an <wbr/>Event</span></a></li>
|
|
115
|
-
<li><a href="#md:create-a-new-geometry"><span>Create a <wbr/>New <wbr/>Geometry</span></a></li
|
|
133
|
+
<li><a href="#md:create-a-new-geometry"><span>Create a <wbr/>New <wbr/>Geometry</span></a></li>
|
|
134
|
+
<li><a href="#md:fetch-data-from-a-workbook-view"><span>Fetch <wbr/>Data <wbr/>From a <wbr/>Workbook <wbr/>View</span></a></li>
|
|
135
|
+
<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>
|
|
116
136
|
<div class="site-menu">
|
|
117
137
|
<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>
|
|
118
138
|
<ul class="tsd-small-nested-navigation">
|
|
@@ -120,6 +140,7 @@ That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
|
120
140
|
<li><a href="classes/CadenzaClient.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cadenza<wbr/>Client</span></a></li>
|
|
121
141
|
<li><a href="classes/CadenzaError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cadenza<wbr/>Error</span></a></li>
|
|
122
142
|
<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>
|
|
143
|
+
<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>
|
|
123
144
|
<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>
|
|
124
145
|
<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>
|
|
125
146
|
<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>
|
|
@@ -128,6 +149,10 @@ That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
|
128
149
|
<li><a href="types/EmbeddingTargetId.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Embedding<wbr/>Target<wbr/>Id</span></a></li>
|
|
129
150
|
<li><a href="types/Extent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Extent</span></a></li>
|
|
130
151
|
<li><a href="types/GeometryType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Geometry<wbr/>Type</span></a></li>
|
|
152
|
+
<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>
|
|
153
|
+
<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>
|
|
154
|
+
<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>
|
|
155
|
+
<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>
|
|
131
156
|
<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>
|
|
132
157
|
<li><a href="types/WorkbookViewSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Workbook<wbr/>View<wbr/>Source</span></a></li>
|
|
133
158
|
<li><a href="types/WorksheetSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worksheet<wbr/>Source</span></a></li>
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
<ul class="tsd-hierarchy">
|
|
31
31
|
<li><span class="target">CadenzaEvent</span></li></ul></section><aside class="tsd-sources">
|
|
32
32
|
<ul>
|
|
33
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
33
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L733">src/cadenza.js:733</a></li></ul></aside>
|
|
34
34
|
<section class="tsd-panel-group tsd-index-group">
|
|
35
35
|
<section class="tsd-panel tsd-index-panel">
|
|
36
36
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -50,7 +50,7 @@
|
|
|
50
50
|
</div>
|
|
51
51
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
52
52
|
<ul>
|
|
53
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
53
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L735">src/cadenza.js:735</a></li></ul></aside></section>
|
|
54
54
|
<section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a>
|
|
55
55
|
<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>
|
|
56
56
|
<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>
|
|
@@ -58,7 +58,7 @@
|
|
|
58
58
|
</div>
|
|
59
59
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
60
60
|
<ul>
|
|
61
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
61
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L734">src/cadenza.js:734</a></li></ul></aside></section></section></div>
|
|
62
62
|
<div class="col-sidebar">
|
|
63
63
|
<div class="page-menu">
|
|
64
64
|
<div class="tsd-navigation settings">
|
|
@@ -87,6 +87,7 @@
|
|
|
87
87
|
<li><a href="../classes/CadenzaClient.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cadenza<wbr/>Client</span></a></li>
|
|
88
88
|
<li><a href="../classes/CadenzaError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cadenza<wbr/>Error</span></a></li>
|
|
89
89
|
<li><a href="CadenzaEvent.html" class="current"><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>
|
|
90
|
+
<li><a href="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>
|
|
90
91
|
<li><a href="Geometry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Geometry</span></a></li>
|
|
91
92
|
<li><a href="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>
|
|
92
93
|
<li><a href="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>
|
|
@@ -95,6 +96,10 @@
|
|
|
95
96
|
<li><a href="../types/EmbeddingTargetId.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Embedding<wbr/>Target<wbr/>Id</span></a></li>
|
|
96
97
|
<li><a href="../types/Extent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Extent</span></a></li>
|
|
97
98
|
<li><a href="../types/GeometryType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Geometry<wbr/>Type</span></a></li>
|
|
99
|
+
<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>
|
|
100
|
+
<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>
|
|
101
|
+
<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>
|
|
102
|
+
<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>
|
|
98
103
|
<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>
|
|
99
104
|
<li><a href="../types/WorkbookViewSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Workbook<wbr/>View<wbr/>Source</span></a></li>
|
|
100
105
|
<li><a href="../types/WorksheetSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worksheet<wbr/>Source</span></a></li>
|