@disy/cadenza.js 2.13.1 → 10.2.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 +9 -2
- package/apidoc/assets/highlight.css +30 -23
- package/apidoc/classes/AbortError.html +3 -3
- package/apidoc/classes/CadenzaClient.html +26 -26
- package/apidoc/classes/CadenzaError.html +5 -5
- package/apidoc/functions/cadenza.html +3 -3
- package/apidoc/index.html +35 -33
- package/apidoc/interfaces/CadenzaClientOptions.html +5 -5
- package/apidoc/interfaces/CadenzaEvent.html +4 -4
- package/apidoc/interfaces/Distance.html +2 -2
- package/apidoc/interfaces/ExternalLinkKey.html +5 -5
- package/apidoc/interfaces/Feature.html +7 -7
- package/apidoc/interfaces/FeatureCollection.html +3 -3
- package/apidoc/interfaces/Geometry.html +3 -3
- package/apidoc/interfaces/GeometryZoomTarget.html +3 -3
- package/apidoc/interfaces/PageSource.html +3 -3
- package/apidoc/modules.html +2 -2
- package/apidoc/types/CadenzaActionEvent.html +2 -2
- package/apidoc/types/CadenzaChangeSelectionEvent.html +2 -2
- package/apidoc/types/CadenzaDrillThroughEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryCancelEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryOkEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryUpdateEvent.html +2 -2
- package/apidoc/types/CadenzaErrorEvent.html +2 -2
- package/apidoc/types/CadenzaEventByType.html +1 -1
- package/apidoc/types/CadenzaEventType.html +2 -2
- package/apidoc/types/CadenzaObjectInfoEvent.html +2 -2
- package/apidoc/types/CadenzaSelectObjectsCancelEvent.html +2 -2
- package/apidoc/types/CadenzaSelectObjectsOkEvent.html +2 -2
- package/apidoc/types/DataType.html +2 -2
- package/apidoc/types/EmbeddingTargetId.html +2 -2
- package/apidoc/types/Extent.html +2 -2
- package/apidoc/types/FilterVariables.html +2 -2
- package/apidoc/types/GeometryType.html +2 -2
- package/apidoc/types/GlobalId.html +2 -2
- package/apidoc/types/LengthUnit.html +1 -1
- package/apidoc/types/OpaqueString.html +2 -2
- package/apidoc/types/OperationMode.html +2 -2
- package/apidoc/types/TablePart.html +2 -2
- package/apidoc/types/UiFeature.html +2 -2
- package/apidoc/types/WorkbookLayerPath.html +2 -2
- package/apidoc/types/ZoomTarget.html +2 -2
- package/cadenza.d.ts +9 -3
- package/cadenza.js +10 -4
- package/package.json +1 -1
- package/sandbox.html +19 -1
package/apidoc/index.html
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Cadenza JS - v2.13.
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Cadenza JS - v2.13.2</title><meta name="description" content="Documentation for Cadenza JS"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/icons.js" id="tsd-icons-script"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base="."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/DisyInformationssysteme/cadenza.js">Cadenza JS on GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">Cadenza JS - v2.13.2</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><h2>Cadenza JS - v2.13.2</h2></div><div class="tsd-panel tsd-typography"><!-- prettier-ignore-start -->
|
|
2
2
|
|
|
3
3
|
<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>
|
|
4
4
|
<ul>
|
|
@@ -7,31 +7,33 @@
|
|
|
7
7
|
<li><a href="#md:the-development-sandbox">The development sandbox</a></li>
|
|
8
8
|
</ul>
|
|
9
9
|
<a id="md:installation" class="tsd-anchor"></a><h2><a href="#md:installation">Installation</a></h2><p>Cadenza JS is included in the Cadenza distribution in the corresponding version.</p>
|
|
10
|
-
<p>Alternatively you can install the most recent version using npm:</p>
|
|
11
|
-
<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>
|
|
10
|
+
<p>Alternatively you can install the most recent version for a particular Cadenza Release using npm:</p>
|
|
11
|
+
<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@~10.2.0</span><span class="hl-1"> </span><span class="hl-3"># For latest version for Cadenza 10.2 </span>
|
|
12
12
|
</code><button>Copy</button></pre>
|
|
13
|
+
<p>The Cadenza main version is reflected in the corresponding major and minor version of Cadenza JS (e.g. 10.2.0 for Cadenza 10.2), while the last version segment is increased for both, bugfixes and functional changes.</p>
|
|
14
|
+
<a id="md:cadenza-101-and-earlier" class="tsd-anchor"></a><h3><a href="#md:cadenza-101-and-earlier">Cadenza 10.1 and earlier</a></h3><p>For Cadenza 10.1 and earlier versions Cadenza JS used did use genuine semantic versioning. Please consult the Cadenza Documentation for the corresponding major and minor version of cadenza.js.</p>
|
|
13
15
|
<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>
|
|
14
16
|
<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>
|
|
15
17
|
<p>There are two ways to use Cadenza JS: As a module and globally.</p>
|
|
16
18
|
<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>
|
|
17
|
-
<pre><code class="language-html"><span class="hl-
|
|
19
|
+
<pre><code class="language-html"><span class="hl-4"><</span><span class="hl-5">iframe</span><span class="hl-1"> </span><span class="hl-6">id</span><span class="hl-1">=</span><span class="hl-7">"cadenza-iframe"</span><span class="hl-4">></</span><span class="hl-5">iframe</span><span class="hl-4">></span>
|
|
18
20
|
</code><button>Copy</button></pre>
|
|
19
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
21
|
+
<pre><code class="language-javascript"><span class="hl-8">import</span><span class="hl-1"> { </span><span class="hl-9">cadenza</span><span class="hl-1"> } </span><span class="hl-8">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-10">const</span><span class="hl-1"> </span><span class="hl-11">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-9">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>
|
|
20
22
|
</code><button>Copy</button></pre>
|
|
21
23
|
<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>
|
|
22
|
-
<a id="md:globally" class="tsd-anchor"></a><h4><a href="#md:globally">Globally</a></h4><pre><code class="language-html"><span class="hl-
|
|
24
|
+
<a id="md:globally" class="tsd-anchor"></a><h4><a href="#md:globally">Globally</a></h4><pre><code class="language-html"><span class="hl-4"><</span><span class="hl-5">script</span><span class="hl-12"> </span><span class="hl-6">type</span><span class="hl-12">=</span><span class="hl-7">"module"</span><span class="hl-12"> </span><span class="hl-6">src</span><span class="hl-12">=</span><span class="hl-7">"./cadenza.js"</span><span class="hl-4">></span>
|
|
23
25
|
</code><button>Copy</button></pre>
|
|
24
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
26
|
+
<pre><code class="language-javascript"><span class="hl-10">const</span><span class="hl-1"> </span><span class="hl-11">cadenzaClient</span><span class="hl-1"> = </span><span class="hl-9">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>
|
|
25
27
|
</code><button>Copy</button></pre>
|
|
26
28
|
<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>
|
|
27
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
29
|
+
<pre><code class="language-javascript"><span class="hl-9">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-10">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-10">const</span><span class="hl-1"> </span><span class="hl-11">cadenzaClient</span><span class="hl-1"> = </span><span class="hl-9">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>
|
|
28
30
|
</code><button>Copy</button></pre>
|
|
29
31
|
<p>If for some reason you don't like the global <code>cadenza</code> field, you can remove it like so:</p>
|
|
30
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
32
|
+
<pre><code class="language-javascript"><span class="hl-10">const</span><span class="hl-1"> </span><span class="hl-11">cadenza</span><span class="hl-1"> = </span><span class="hl-9">window</span><span class="hl-1">.</span><span class="hl-9">cadenza</span><span class="hl-1">.</span><span class="hl-0">noConflict</span><span class="hl-1">();</span>
|
|
31
33
|
</code><button>Copy</button></pre>
|
|
32
34
|
<a id="md:communication-with-parent-cadenza" class="tsd-anchor"></a><h3><a href="#md:communication-with-parent-cadenza">Communication with parent Cadenza</a></h3><p>If your application is opened from inside Cadenza (e.g. in a popup), you can send commands to parent Cadenza window.
|
|
33
35
|
To do that, create CadenzaClient with no arguments:</p>
|
|
34
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
36
|
+
<pre><code class="language-javascript"><span class="hl-10">const</span><span class="hl-1"> </span><span class="hl-11">parentClient</span><span class="hl-1"> = </span><span class="hl-9">window</span><span class="hl-1">.</span><span class="hl-0">cadenza</span><span class="hl-1">();</span>
|
|
35
37
|
</code><button>Copy</button></pre>
|
|
36
38
|
<p><em>Warning:</em> Not every operation can be done when dealing with parent Cadenza. For example <code>reload</code> and <code>expandNavigator</code>
|
|
37
39
|
work, but <code>show</code>, <code>showMap</code> etc. require an iframe. Using these functions in this mode will result in errors.</p>
|
|
@@ -43,17 +45,17 @@ work, but <code>show</code>, <code>showMap</code> etc. require an iframe. Using
|
|
|
43
45
|
<li>Disable the designer.</li>
|
|
44
46
|
<li>Set the filter variable "var1" to "foo".</li>
|
|
45
47
|
</ul>
|
|
46
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
48
|
+
<pre><code class="language-javascript"><span class="hl-9">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-9">hideMainHeaderAndFooter:</span><span class="hl-1"> </span><span class="hl-10">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-9">hideWorkbookToolBar:</span><span class="hl-1"> </span><span class="hl-10">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-9">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-9">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><span class="hl-9">filter:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-9">var1:</span><span class="hl-1"> </span><span class="hl-2">'foo'</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">});</span>
|
|
47
49
|
</code><button>Copy</button></pre>
|
|
48
50
|
<ul>
|
|
49
51
|
<li>If the embedding target cannot be resolved, a 404 page is shown to the user.</li>
|
|
50
52
|
<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>
|
|
51
53
|
</ul>
|
|
52
54
|
<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 "dataType" option to "pdf".</p>
|
|
53
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
55
|
+
<pre><code class="language-javascript"><span class="hl-9">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-9">dataType:</span><span class="hl-1"> </span><span class="hl-2">'pdf'</span><br/><span class="hl-1">});</span>
|
|
54
56
|
</code><button>Copy</button></pre>
|
|
55
57
|
<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>
|
|
56
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
58
|
+
<pre><code class="language-javascript"><span class="hl-10">const</span><span class="hl-1"> </span><span class="hl-11">abortController</span><span class="hl-1"> = </span><span class="hl-10">new</span><span class="hl-1"> </span><span class="hl-0">AbortController</span><span class="hl-1">();</span><br/><span class="hl-8">try</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-9">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-9">signal:</span><span class="hl-1"> </span><span class="hl-9">abortController</span><span class="hl-1">.</span><span class="hl-9">signal</span><span class="hl-1"> });</span><br/><span class="hl-1">} </span><span class="hl-8">catch</span><span class="hl-1"> (</span><span class="hl-9">error</span><span class="hl-1">) {</span><br/><span class="hl-1"> </span><span class="hl-8">if</span><span class="hl-1"> (</span><span class="hl-9">error</span><span class="hl-1">.</span><span class="hl-9">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-9">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-9">cancelButton</span><span class="hl-1">.</span><span class="hl-0">onclick</span><span class="hl-1"> = () </span><span class="hl-10">=></span><span class="hl-1"> </span><span class="hl-9">abortController</span><span class="hl-1">.</span><span class="hl-0">abort</span><span class="hl-1">();</span>
|
|
57
59
|
</code><button>Copy</button></pre>
|
|
58
60
|
<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>
|
|
59
61
|
<!--
|
|
@@ -75,9 +77,9 @@ cadenzaClient.setFilter({ '<variableName>': 'value' });
|
|
|
75
77
|
<li>Show the given GeoJSON geometry on the map.</li>
|
|
76
78
|
</ul>
|
|
77
79
|
<p>The coordinates of extent and geometry are in the map's SRS (<code>useMapSrs: true</code>).</p>
|
|
78
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
80
|
+
<pre><code class="language-javascript"><span class="hl-9">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-9">useMapSrs:</span><span class="hl-1"> </span><span class="hl-10">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-9">mapExtent:</span><span class="hl-1"> [</span><br/><span class="hl-1"> -</span><span class="hl-13">572_513.341856</span><span class="hl-1">, </span><span class="hl-13">5_211_017.966314</span><span class="hl-1">, </span><span class="hl-13">916_327.095083</span><span class="hl-1">, </span><span class="hl-13">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-9">geometry:</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-9">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-9">coordinates:</span><span class="hl-1"> [</span><span class="hl-13">328_627.563458</span><span class="hl-1">, </span><span class="hl-13">5_921_296.662223</span><span class="hl-1">],</span><br/><span class="hl-1"> },</span><br/><span class="hl-1">});</span>
|
|
79
81
|
</code><button>Copy</button></pre>
|
|
80
|
-
<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-
|
|
82
|
+
<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-9">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-9">locationFinder:</span><span class="hl-1"> </span><span class="hl-2">'Karlsruhe'</span><span class="hl-1">,</span><br/><span class="hl-1">});</span>
|
|
81
83
|
</code><button>Copy</button></pre>
|
|
82
84
|
<!--
|
|
83
85
|
### Set the Visibility of a Layer in the Currently Shown Workbook Map View
|
|
@@ -107,20 +109,20 @@ canvas.drawImage(await createImageBitmap(data), 0, 0);
|
|
|
107
109
|
|
|
108
110
|
<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>
|
|
109
111
|
<p>Edit a GeoJSON geometry with a workbook map view in the background. The geometry coordinates are in the map's SRS (<code>useMapSrs: true</code>).</p>
|
|
110
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
112
|
+
<pre><code class="language-javascript"><span class="hl-10">const</span><span class="hl-1"> </span><span class="hl-11">geometry</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-9">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-9">coordinates:</span><span class="hl-1"> [</span><span class="hl-13">328_627.563458</span><span class="hl-1">, </span><span class="hl-13">5_921_296.662223</span><span class="hl-1">],</span><br/><span class="hl-1">};</span><br/><span class="hl-9">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-9">geometry</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-9">useMapSrs:</span><span class="hl-1"> </span><span class="hl-10">true</span><span class="hl-1">,</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-9">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-9">event</span><span class="hl-1">) </span><span class="hl-10">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-9">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-9">event</span><span class="hl-1">.</span><span class="hl-9">detail</span><span class="hl-1">.</span><span class="hl-9">geometry</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-9">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-9">event</span><span class="hl-1">) </span><span class="hl-10">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-9">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-9">event</span><span class="hl-1">.</span><span class="hl-9">detail</span><span class="hl-1">.</span><span class="hl-9">geometry</span><span class="hl-1">);</span><br/><span class="hl-1">});</span><br/><span class="hl-9">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-9">event</span><span class="hl-1">) </span><span class="hl-10">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-9">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>
|
|
111
113
|
</code><button>Copy</button></pre>
|
|
112
114
|
<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>
|
|
113
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
115
|
+
<pre><code class="language-javascript"><span class="hl-10">const</span><span class="hl-1"> </span><span class="hl-11">unsubscribe</span><span class="hl-1"> = </span><span class="hl-9">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-9">event</span><span class="hl-1">) </span><span class="hl-10">=></span><span class="hl-1"> ...);</span><br/><span class="hl-1">...</span><br/><span class="hl-0">unsubscribe</span><span class="hl-1">();</span>
|
|
114
116
|
</code><button>Copy</button></pre>
|
|
115
117
|
<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>
|
|
116
118
|
<p>Edit a GeoJSON point geometry with a workbook map view in the background. The geometry coordinates are in the map's SRS (<code>useMapSrs: true</code>).</p>
|
|
117
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
119
|
+
<pre><code class="language-javascript"><span class="hl-9">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-9">useMapSrs:</span><span class="hl-1"> </span><span class="hl-10">true</span><span class="hl-1">,</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-9">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-9">event</span><span class="hl-1">) </span><span class="hl-10">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-9">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-9">event</span><span class="hl-1">.</span><span class="hl-9">detail</span><span class="hl-1">.</span><span class="hl-9">geometry</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
|
118
120
|
</code><button>Copy</button></pre>
|
|
119
121
|
<p><em>Note:</em> Under the hood, creating a geometry is similar to editing a geometry.
|
|
120
122
|
That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
121
123
|
<a id="md:select-objects-in-a-workbook-map-view" class="tsd-anchor"></a><h3><a href="#md:select-objects-in-a-workbook-map-view">Select Objects in a Workbook Map View</a></h3><p><small>API: <a href="./classes/CadenzaClient.html#selectObjects">CadenzaClient#selectObjects</a></small></p>
|
|
122
124
|
<p>Ask the user to select objects in a workbook map view. In the example the selection is restricted to specific layers. For layers in groups, pass the layer path.</p>
|
|
123
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
125
|
+
<pre><code class="language-javascript"><span class="hl-9">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">selectObjects</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-9">layers:</span><span class="hl-1"> [</span><br/><span class="hl-1"> [ </span><span class="hl-2">'<layerGroupPrintName>'</span><span class="hl-1">, </span><span class="hl-2">'<layerPrintName>'</span><span class="hl-1"> ],</span><br/><span class="hl-1"> [ </span><span class="hl-2">'<layerPrintName>'</span><span class="hl-1"> ]</span><br/><span class="hl-1"> ]</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-9">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">on</span><span class="hl-1">(</span><span class="hl-2">'selectObjects:ok'</span><span class="hl-1">, (</span><span class="hl-9">event</span><span class="hl-1">) </span><span class="hl-10">=></span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-9">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-2">'Object selection was completed'</span><span class="hl-1">, </span><span class="hl-9">event</span><span class="hl-1">.</span><span class="hl-9">detail</span><span class="hl-1">.</span><span class="hl-9">selection</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
|
|
124
126
|
</code><button>Copy</button></pre>
|
|
125
127
|
<!--
|
|
126
128
|
#### _Programmatically_ Set the Selection in the Currently Shown Workbook Map View
|
|
@@ -143,45 +145,45 @@ You can also add to or remove from the current selection:
|
|
|
143
145
|
|
|
144
146
|
<a id="md:highlight-an-item-in-the-navigator" class="tsd-anchor"></a><h3><a href="#md:highlight-an-item-in-the-navigator">Highlight an Item in the Navigator</a></h3><p><small>API: <a href="./classes/CadenzaClient.html#show">CadenzaClient#show</a></small></p>
|
|
145
147
|
<p>Show an embedding target in an iframe and highlight an item in the navigator. Additionally, expand the navigator tree.</p>
|
|
146
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
148
|
+
<pre><code class="language-javascript"><span class="hl-9">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-9">expandNavigator:</span><span class="hl-1"> </span><span class="hl-10">true</span><span class="hl-1">, </span><span class="hl-9">highlightGlobalId:</span><span class="hl-1"> </span><span class="hl-2">'ROOT.MyFolder'</span><span class="hl-1">});</span>
|
|
147
149
|
</code><button>Copy</button></pre>
|
|
148
150
|
<a id="md:highlight-an-item-in-the-navigator-on-the-welcome-page" class="tsd-anchor"></a><h4><a href="#md:highlight-an-item-in-the-navigator-on-the-welcome-page">Highlight an Item in the Navigator on the Welcome Page</a></h4><p><small>API: <a href="./classes/CadenzaClient.html#show">CadenzaClient#show</a></small></p>
|
|
149
151
|
<p>Show Cadenza's welcome page in an iframe and highlight an item in the navigator.</p>
|
|
150
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
152
|
+
<pre><code class="language-javascript"><span class="hl-9">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">show</span><span class="hl-1">({</span><span class="hl-9">page:</span><span class="hl-1"> </span><span class="hl-2">'welcome'</span><span class="hl-1">}, {</span><span class="hl-9">highlightGlobalId:</span><span class="hl-1"> </span><span class="hl-2">'ROOT.MyFolder'</span><span class="hl-1">});</span>
|
|
151
153
|
</code><button>Copy</button></pre>
|
|
152
154
|
<a id="md:expand-the-navigator" class="tsd-anchor"></a><h4><a href="#md:expand-the-navigator">Expand the Navigator</a></h4><p><small>API: <a href="./classes/CadenzaClient.html#expandNavigator">CadenzaClient#expandNavigator</a></small></p>
|
|
153
155
|
<p>Expand the navigator.</p>
|
|
154
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
156
|
+
<pre><code class="language-javascript"><span class="hl-9">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">expandNavigator</span><span class="hl-1">();</span>
|
|
155
157
|
</code><button>Copy</button></pre>
|
|
156
158
|
<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>
|
|
157
159
|
<p>Fetch data from a workbook view in CSV format.</p>
|
|
158
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
160
|
+
<pre><code class="language-javascript"><span class="hl-10">const</span><span class="hl-1"> </span><span class="hl-11">response</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-9">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">'csv'</span><span class="hl-1">);</span><br/><br/><span class="hl-10">const</span><span class="hl-1"> </span><span class="hl-11">text</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-9">response</span><span class="hl-1">.</span><span class="hl-0">text</span><span class="hl-1">();</span><br/><span class="hl-1">...</span>
|
|
159
161
|
</code><button>Copy</button></pre>
|
|
160
162
|
<a id="md:control-the-contents-of-the-fetched-table-data" class="tsd-anchor"></a><h4><a href="#md:control-the-contents-of-the-fetched-table-data">Control the Contents of the Fetched Table Data</a></h4><p>Fetch data from a workbook view in JSON format and include only the data values and the aggregation totals. (Do not include the column names.)</p>
|
|
161
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
163
|
+
<pre><code class="language-javascript"><span class="hl-10">const</span><span class="hl-1"> </span><span class="hl-11">response</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-9">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">'json'</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-9">parts:</span><span class="hl-1"> [</span><span class="hl-2">'values'</span><span class="hl-1">, </span><span class="hl-2">'totals'</span><span class="hl-1">]</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-10">const</span><span class="hl-1"> </span><span class="hl-11">tableData</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-9">response</span><span class="hl-1">.</span><span class="hl-0">json</span><span class="hl-1">();</span><br/><span class="hl-1">...</span>
|
|
162
164
|
</code><button>Copy</button></pre>
|
|
163
165
|
<a id="md:fetch-the-object-info-from-a-workbook-map-view" class="tsd-anchor"></a><h3><a href="#md:fetch-the-object-info-from-a-workbook-map-view">Fetch the Object Info from a Workbook Map View</a></h3><p><small>API: [CadenzaClient#fetchObjectInfo(./classes/CadenzaClient.html#fetchObjectInfo)</small></p>
|
|
164
166
|
<p>Fetch the object info from a workbook map view in JSON format. The result contains all information, that is shown in the object info within cadenza.</p>
|
|
165
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
167
|
+
<pre><code class="language-javascript"><span class="hl-10">const</span><span class="hl-1"> </span><span class="hl-11">objectInfo</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-9">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">fetchObjectInfo</span><span class="hl-1">(</span><span class="hl-2">'embeddingTargetId'</span><span class="hl-1">, </span><span class="hl-2">'layerPrintName'</span><span class="hl-1">, [[</span><span class="hl-2">'objectId'</span><span class="hl-1">]], {</span><br/><span class="hl-1"> </span><span class="hl-9">useMapSrs:</span><span class="hl-1"> </span><span class="hl-10">false</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-9">fullGeometries:</span><span class="hl-1"> </span><span class="hl-10">true</span><br/><span class="hl-1">});</span>
|
|
166
168
|
</code><button>Copy</button></pre>
|
|
167
169
|
<a id="md:fetch-the-area-intersection-from-a-workbook-map-view-layer" class="tsd-anchor"></a><h3><a href="#md:fetch-the-area-intersection-from-a-workbook-map-view-layer">Fetch the area intersection from a Workbook Map View Layer</a></h3><p><small>API: [CadenzaClient#fetchObjectInfo(./classes/CadenzaClient.html#fetchAreaIntersections)</small></p>
|
|
168
170
|
<p>Fetch the intersection area from a workbook map view layer in JSON format for a given area. The result contains all intersecting objects of the layer, their object ID, if defined the object name and a geometry representing the intersection area, with area size and area perimeter.</p>
|
|
169
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
171
|
+
<pre><code class="language-javascript"><span class="hl-10">const</span><span class="hl-1"> </span><span class="hl-11">geometry</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-9">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-9">coordinates:</span><span class="hl-1"> [</span><span class="hl-13">328_627.563458</span><span class="hl-1">, </span><span class="hl-13">5_921_296.662223</span><span class="hl-1">],</span><br/><span class="hl-1">};</span><br/><span class="hl-10">const</span><span class="hl-1"> </span><span class="hl-11">bufferSize</span><span class="hl-1"> = {</span><br/><span class="hl-1"> </span><span class="hl-9">value:</span><span class="hl-1"> </span><span class="hl-13">100</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-9">lengthUnit:</span><span class="hl-1"> </span><span class="hl-2">'m'</span><br/><span class="hl-1">}</span><br/><br/><span class="hl-10">const</span><span class="hl-1"> </span><span class="hl-11">featureCollection</span><span class="hl-1"> = </span><span class="hl-8">await</span><span class="hl-1"> </span><span class="hl-9">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">fetchAreaIntersections</span><span class="hl-1">(</span><span class="hl-2">'embeddingTargetId'</span><span class="hl-1">, </span><span class="hl-2">'layerPrintName'</span><span class="hl-1">, </span><span class="hl-9">geometry</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-9">useMapSrs:</span><span class="hl-1"> </span><span class="hl-10">true</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-9">bufferSize:</span><span class="hl-1"> </span><span class="hl-9">bufferSize</span><br/><span class="hl-1">});</span>
|
|
170
172
|
</code><button>Copy</button></pre>
|
|
171
173
|
<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>
|
|
172
174
|
<p>Download data from a workbook view in Excel format. This triggers the browser's download dialog.</p>
|
|
173
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
175
|
+
<pre><code class="language-javascript"><span class="hl-10">const</span><span class="hl-1"> </span><span class="hl-11">button</span><span class="hl-1"> = </span><span class="hl-9">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-9">button</span><span class="hl-1">.</span><span class="hl-9">textContent</span><span class="hl-1"> = </span><span class="hl-2">'Download Excel'</span><span class="hl-1">;</span><br/><span class="hl-9">button</span><span class="hl-1">.</span><span class="hl-0">onclick</span><span class="hl-1"> = () </span><span class="hl-10">=></span><span class="hl-1"> </span><span class="hl-9">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><span class="hl-2">'excel'</span><span class="hl-1">);</span>
|
|
174
176
|
</code><button>Copy</button></pre>
|
|
175
177
|
<a id="md:reload-the-views-of-a-worksheet" class="tsd-anchor"></a><h3><a href="#md:reload-the-views-of-a-worksheet">Reload the Views of a Worksheet</a></h3><p><small>API: <a href="./classes/CadenzaClient.html#reload">CadenzaClient#reload</a></small></p>
|
|
176
178
|
<p>To reload a worksheet:</p>
|
|
177
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
179
|
+
<pre><code class="language-javascript"><span class="hl-9">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">reload</span><span class="hl-1">();</span>
|
|
178
180
|
</code><button>Copy</button></pre>
|
|
179
181
|
<p>To invalidate caches and reload:</p>
|
|
180
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
182
|
+
<pre><code class="language-javascript"><span class="hl-9">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">reload</span><span class="hl-1">({ </span><span class="hl-9">invalidateCaches:</span><span class="hl-1"> </span><span class="hl-10">true</span><span class="hl-1"> });</span>
|
|
181
183
|
</code><button>Copy</button></pre>
|
|
182
184
|
<a id="md:close-the-cadenza-dialog-or-window-that-embeds-the-custom-application" class="tsd-anchor"></a><h3><a href="#md:close-the-cadenza-dialog-or-window-that-embeds-the-custom-application">Close the Cadenza Dialog or Window That Embeds the Custom Application</a></h3><p><small>API: <a href="./classes/CadenzaClient.html#closeMe">CadenzaClient#closeMe</a></small></p>
|
|
183
185
|
<p>Sends a message to parent Cadenza window to close the window containing this application.</p>
|
|
184
|
-
<pre><code class="language-javascript"><span class="hl-
|
|
186
|
+
<pre><code class="language-javascript"><span class="hl-9">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">closeMe</span><span class="hl-1">();</span>
|
|
185
187
|
</code><button>Copy</button></pre>
|
|
186
188
|
<a id="md:listen-for-cadenza-closing-the-custom-application" class="tsd-anchor"></a><h4><a href="#md:listen-for-cadenza-closing-the-custom-application">Listen for Cadenza Closing the Custom Application</a></h4><p>Cadenza does not send an event when the dialog or window is closed that embeds the custom application. Depending on your use case you might listen to these browser events instead:</p>
|
|
187
189
|
<ul>
|
|
@@ -206,10 +208,10 @@ You can also add to or remove from the current selection:
|
|
|
206
208
|
<p>The sandbox uses Cadenza JS with the "debug" option enabled, so you can see what is going on internally in the browser's devtools console. In the "Network" tab of the devtools you can see the requests to the Cadenza server.</p>
|
|
207
209
|
<a id="md:customize-the-cadenza-url" class="tsd-anchor"></a><h3><a href="#md:customize-the-cadenza-url">Customize the Cadenza URL</a></h3><p>By default, the sandbox expects Cadenza to run on <a href="http://localhost:8080/cadenza">http://localhost:8080/cadenza</a>. There are two ways to customize the Cadenza URL:</p>
|
|
208
210
|
<ul>
|
|
209
|
-
<li>Pass an argument:<pre><code class="language-bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">sandbox</span><span class="hl-1"> </span><span class="hl-
|
|
211
|
+
<li>Pass an argument:<pre><code class="language-bash"><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">sandbox</span><span class="hl-1"> </span><span class="hl-10">--</span><span class="hl-1"> </span><span class="hl-10">--cadenza-url</span><span class="hl-1"> </span><span class="hl-2">http://localhost:8000/my-cadenza</span>
|
|
210
212
|
</code><button>Copy</button></pre>
|
|
211
213
|
</li>
|
|
212
|
-
<li>Set an environment variable:<pre><code class="language-bash"><span class="hl-
|
|
214
|
+
<li>Set an environment variable:<pre><code class="language-bash"><span class="hl-10">export</span><span class="hl-1"> </span><span class="hl-9">CADENZA_URL</span><span class="hl-1">=</span><span class="hl-2">http://localhost:8000/my-cadenza</span><br/><span class="hl-0">npm</span><span class="hl-1"> </span><span class="hl-2">run</span><span class="hl-1"> </span><span class="hl-2">sandbox</span>
|
|
213
215
|
</code><button>Copy</button></pre>
|
|
214
216
|
</li>
|
|
215
217
|
</ul>
|
|
@@ -290,4 +292,4 @@ You can also add to or remove from the current selection:
|
|
|
290
292
|
<td></td>
|
|
291
293
|
</tr>
|
|
292
294
|
</tbody></table>
|
|
293
|
-
<!-- prettier-ignore-end --></div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:installation"><span>Installation</span></a><a href="#md:usage-examples"><span>Usage <wbr/>Examples</span></a><ul><li><a href="#md:general-usage"><span>General <wbr/>Usage</span></a></li><li><ul><li><a href="#md:as-a-module"><span>As a module</span></a></li><li><a href="#md:globally"><span>Globally</span></a></li></ul></li><li><a href="#md:communication-with-parent-cadenza"><span>Communication with parent <wbr/>Cadenza</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><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><li><a href="#md:abort-iframe-loading"><span>Abort (<wbr/>Iframe) <wbr/>Loading</span></a></li><li><a href="#md:show-a-workbook-map-view"><span>Show a <wbr/>Workbook <wbr/>Map <wbr/>View</span></a></li><li><ul><li><a href="#md:initialize-the-map-extent-by-setting-the-location-finder"><span>Initialize the <wbr/>Map <wbr/>Extent by <wbr/>Setting the <wbr/>Location <wbr/>Finder</span></a></li></ul></li><li><a href="#md:edit-an-existing-geometry"><span>Edit an <wbr/>Existing <wbr/>Geometry</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:select-objects-in-a-workbook-map-view"><span>Select <wbr/>Objects in a <wbr/>Workbook <wbr/>Map <wbr/>View</span></a></li><li><a href="#md:highlight-an-item-in-the-navigator"><span>Highlight an <wbr/>Item in the <wbr/>Navigator</span></a></li><li><ul><li><a href="#md:highlight-an-item-in-the-navigator-on-the-welcome-page"><span>Highlight an <wbr/>Item in the <wbr/>Navigator on the <wbr/>Welcome <wbr/>Page</span></a></li><li><a href="#md:expand-the-navigator"><span>Expand the <wbr/>Navigator</span></a></li></ul></li><li><a href="#md:fetch-data-from-a-workbook-view"><span>Fetch <wbr/>Data <wbr/>From a <wbr/>Workbook <wbr/>View</span></a></li><li><ul><li><a href="#md:control-the-contents-of-the-fetched-table-data"><span>Control the <wbr/>Contents of the <wbr/>Fetched <wbr/>Table <wbr/>Data</span></a></li></ul></li><li><a href="#md:fetch-the-object-info-from-a-workbook-map-view"><span>Fetch the <wbr/>Object <wbr/>Info from a <wbr/>Workbook <wbr/>Map <wbr/>View</span></a></li><li><a href="#md:fetch-the-area-intersection-from-a-workbook-map-view-layer"><span>Fetch the area intersection from a <wbr/>Workbook <wbr/>Map <wbr/>View <wbr/>Layer</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><li><a href="#md:reload-the-views-of-a-worksheet"><span>Reload the <wbr/>Views of a <wbr/>Worksheet</span></a></li><li><a href="#md:close-the-cadenza-dialog-or-window-that-embeds-the-custom-application"><span>Close the <wbr/>Cadenza <wbr/>Dialog or <wbr/>Window <wbr/>That <wbr/>Embeds the <wbr/>Custom <wbr/>Application</span></a></li><li><ul><li><a href="#md:listen-for-cadenza-closing-the-custom-application"><span>Listen for <wbr/>Cadenza <wbr/>Closing the <wbr/>Custom <wbr/>Application</span></a></li></ul></li></ul><a href="#md:the-development-sandbox"><span>The <wbr/>Development <wbr/>Sandbox</span></a><ul><li><a href="#md:the-sandbox-ui"><span>The <wbr/>Sandbox UI</span></a></li><li><a href="#md:customize-the-cadenza-url"><span>Customize the <wbr/>Cadenza URL</span></a></li></ul><a href="#md:json-representation-of-cadenza-object-data"><span>JSON <wbr/>Representation of <wbr/>Cadenza <wbr/>Object <wbr/>Data</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>Cadenza JS - v2.13.
|
|
295
|
+
<!-- prettier-ignore-end --></div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:installation"><span>Installation</span></a><ul><li><a href="#md:cadenza-101-and-earlier"><span>Cadenza 10.1 and earlier</span></a></li></ul><a href="#md:usage-examples"><span>Usage <wbr/>Examples</span></a><ul><li><a href="#md:general-usage"><span>General <wbr/>Usage</span></a></li><li><ul><li><a href="#md:as-a-module"><span>As a module</span></a></li><li><a href="#md:globally"><span>Globally</span></a></li></ul></li><li><a href="#md:communication-with-parent-cadenza"><span>Communication with parent <wbr/>Cadenza</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><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><li><a href="#md:abort-iframe-loading"><span>Abort (<wbr/>Iframe) <wbr/>Loading</span></a></li><li><a href="#md:show-a-workbook-map-view"><span>Show a <wbr/>Workbook <wbr/>Map <wbr/>View</span></a></li><li><ul><li><a href="#md:initialize-the-map-extent-by-setting-the-location-finder"><span>Initialize the <wbr/>Map <wbr/>Extent by <wbr/>Setting the <wbr/>Location <wbr/>Finder</span></a></li></ul></li><li><a href="#md:edit-an-existing-geometry"><span>Edit an <wbr/>Existing <wbr/>Geometry</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:select-objects-in-a-workbook-map-view"><span>Select <wbr/>Objects in a <wbr/>Workbook <wbr/>Map <wbr/>View</span></a></li><li><a href="#md:highlight-an-item-in-the-navigator"><span>Highlight an <wbr/>Item in the <wbr/>Navigator</span></a></li><li><ul><li><a href="#md:highlight-an-item-in-the-navigator-on-the-welcome-page"><span>Highlight an <wbr/>Item in the <wbr/>Navigator on the <wbr/>Welcome <wbr/>Page</span></a></li><li><a href="#md:expand-the-navigator"><span>Expand the <wbr/>Navigator</span></a></li></ul></li><li><a href="#md:fetch-data-from-a-workbook-view"><span>Fetch <wbr/>Data <wbr/>From a <wbr/>Workbook <wbr/>View</span></a></li><li><ul><li><a href="#md:control-the-contents-of-the-fetched-table-data"><span>Control the <wbr/>Contents of the <wbr/>Fetched <wbr/>Table <wbr/>Data</span></a></li></ul></li><li><a href="#md:fetch-the-object-info-from-a-workbook-map-view"><span>Fetch the <wbr/>Object <wbr/>Info from a <wbr/>Workbook <wbr/>Map <wbr/>View</span></a></li><li><a href="#md:fetch-the-area-intersection-from-a-workbook-map-view-layer"><span>Fetch the area intersection from a <wbr/>Workbook <wbr/>Map <wbr/>View <wbr/>Layer</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><li><a href="#md:reload-the-views-of-a-worksheet"><span>Reload the <wbr/>Views of a <wbr/>Worksheet</span></a></li><li><a href="#md:close-the-cadenza-dialog-or-window-that-embeds-the-custom-application"><span>Close the <wbr/>Cadenza <wbr/>Dialog or <wbr/>Window <wbr/>That <wbr/>Embeds the <wbr/>Custom <wbr/>Application</span></a></li><li><ul><li><a href="#md:listen-for-cadenza-closing-the-custom-application"><span>Listen for <wbr/>Cadenza <wbr/>Closing the <wbr/>Custom <wbr/>Application</span></a></li></ul></li></ul><a href="#md:the-development-sandbox"><span>The <wbr/>Development <wbr/>Sandbox</span></a><ul><li><a href="#md:the-sandbox-ui"><span>The <wbr/>Sandbox UI</span></a></li><li><a href="#md:customize-the-cadenza-url"><span>Customize the <wbr/>Cadenza URL</span></a></li></ul><a href="#md:json-representation-of-cadenza-object-data"><span>JSON <wbr/>Representation of <wbr/>Cadenza <wbr/>Object <wbr/>Data</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="assets/icons.svg#icon-1"></use></svg><span>Cadenza JS - v2.13.2</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CadenzaClientOptions | Cadenza JS - v2.13.
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CadenzaClientOptions | Cadenza JS - v2.13.2</title><meta name="description" content="Documentation for Cadenza JS"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/DisyInformationssysteme/cadenza.js">Cadenza JS on GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Cadenza JS - v2.13.2</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Cadenza JS</a></li><li><a href="CadenzaClientOptions.html">CadenzaClientOptions</a></li></ul><h1>Interface CadenzaClientOptions</h1></div><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">CadenzaClientOptions</span> <span class="tsd-signature-symbol">{ </span><br/><span> </span><a class="tsd-kind-property" href="CadenzaClientOptions.html#baseUrl">baseUrl</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><a class="tsd-kind-property" href="CadenzaClientOptions.html#debug">debug</a><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><a class="tsd-kind-property" href="CadenzaClientOptions.html#iframe">iframe</a><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><a class="tsd-kind-property" href="CadenzaClientOptions.html#webApplication">webApplication</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="ExternalLinkKey.html" class="tsd-signature-type tsd-kind-interface">ExternalLinkKey</a><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/ebe51ce80928f4ff475b6fda1dd735b905966ace/src/cadenza.js#L2">src/cadenza.js:2</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"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="CadenzaClientOptions.html#baseUrl" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Url</span></a>
|
|
2
2
|
<a href="CadenzaClientOptions.html#debug" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>debug</span></a>
|
|
3
3
|
<a href="CadenzaClientOptions.html#iframe" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>iframe</span></a>
|
|
4
4
|
<a href="CadenzaClientOptions.html#webApplication" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>web<wbr/>Application</span></a>
|
|
5
5
|
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="baseUrl" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>base<wbr/>Url</span><a href="#baseUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Url</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></div><div class="tsd-comment tsd-typography"><p>The base URL of the Cadenza server</p>
|
|
6
|
-
</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/
|
|
7
|
-
</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/
|
|
6
|
+
</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/ebe51ce80928f4ff475b6fda1dd735b905966ace/src/cadenza.js#L3">src/cadenza.js:3</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="debug" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>debug</span><a href="#debug" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">debug</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div><div class="tsd-comment tsd-typography"><p>Whether to enable debug logging</p>
|
|
7
|
+
</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/ebe51ce80928f4ff475b6fda1dd735b905966ace/src/cadenza.js#L11">src/cadenza.js:11</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="iframe" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>iframe</span><a href="#iframe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">iframe</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLIFrameElement</span></div><div class="tsd-comment tsd-typography"><p>An iframe for embedding Cadenza or the iframe's ID.
|
|
8
8
|
The iframe is required only for methods that embed Cadenza in an iframe, so e.g. not for <a href="../classes/CadenzaClient.html#fetchData" class="tsd-kind-method">CadenzaClient#fetchData</a>.
|
|
9
9
|
If you want to embed Cadenza in multiple iframes, you need to create an instance of the <code>CadenzaClient</code> per iframe.</p>
|
|
10
|
-
</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/
|
|
10
|
+
</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/ebe51ce80928f4ff475b6fda1dd735b905966ace/src/cadenza.js#L4">src/cadenza.js:4</a></li></ul></aside></section><section class="tsd-panel tsd-member"><a id="webApplication" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>web<wbr/>Application</span><a href="#webApplication" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">web<wbr/>Application</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="ExternalLinkKey.html" class="tsd-signature-type tsd-kind-interface">ExternalLinkKey</a></div><div class="tsd-comment tsd-typography"><p>An external link that Cadenza uses to resolve the
|
|
11
11
|
<a href="https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage#targetorigin">target origin</a> when posting events.
|
|
12
12
|
This is required if Cadenza and your application are not running on the same origin.
|
|
13
13
|
Please ensure that the user has view privilege for that link!</p>
|
|
14
|
-
</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/
|
|
14
|
+
</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/ebe51ce80928f4ff475b6fda1dd735b905966ace/src/cadenza.js#L7">src/cadenza.js:7</a></li></ul></aside></section></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#baseUrl" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>base<wbr/>Url</span></a><a href="#debug" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>debug</span></a><a href="#iframe" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>iframe</span></a><a href="#webApplication" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>web<wbr/>Application</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Cadenza JS - v2.13.2</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|