@disy/cadenza.js 10.2.8 → 10.2.10
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 +10 -0
- package/apidoc/assets/hierarchy.js +1 -0
- package/apidoc/assets/icons.js +17 -14
- package/apidoc/assets/icons.svg +1 -1
- package/apidoc/assets/main.js +5 -4
- package/apidoc/assets/navigation.js +1 -1
- package/apidoc/assets/search.js +1 -1
- package/apidoc/assets/style.css +1423 -1224
- package/apidoc/classes/AbortError.html +60 -60
- package/apidoc/classes/CadenzaClient.html +164 -188
- package/apidoc/classes/CadenzaError.html +15 -16
- package/apidoc/functions/cadenza.html +10 -9
- package/apidoc/index.html +146 -118
- package/apidoc/interfaces/CadenzaClientOptions.html +14 -14
- package/apidoc/interfaces/CadenzaEvent.html +6 -6
- package/apidoc/interfaces/Distance.html +3 -3
- package/apidoc/interfaces/ExternalLinkKey.html +8 -7
- package/apidoc/interfaces/Feature.html +16 -16
- package/apidoc/interfaces/FeatureCollection.html +6 -6
- package/apidoc/interfaces/Geometry.html +6 -6
- package/apidoc/interfaces/GeometryExtentStrategy.html +6 -6
- package/apidoc/interfaces/LayerDataExtentStrategy.html +7 -7
- package/apidoc/interfaces/LayerDefinition.html +7 -7
- package/apidoc/interfaces/LocationFinderExtentStrategy.html +6 -6
- package/apidoc/interfaces/PageSource.html +4 -4
- package/apidoc/interfaces/SnappingOptions.html +5 -0
- package/apidoc/interfaces/StaticExtentStrategy.html +6 -6
- package/apidoc/modules.html +1 -46
- 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/CadenzaReloadEvent.html +2 -2
- package/apidoc/types/CadenzaSelectObjectsCancelEvent.html +2 -2
- package/apidoc/types/CadenzaSelectObjectsOkEvent.html +2 -2
- package/apidoc/types/Coordinate.html +2 -2
- package/apidoc/types/CustomValidityType.html +2 -2
- package/apidoc/types/DataType.html +2 -2
- package/apidoc/types/EmbeddingTargetId.html +3 -3
- package/apidoc/types/Extent.html +2 -2
- package/apidoc/types/ExtentStrategy.html +5 -5
- 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 +4 -4
- package/apidoc/types/OperationMode.html +2 -2
- package/apidoc/types/TablePart.html +2 -2
- package/apidoc/types/UiFeature.html +3 -3
- package/apidoc/types/WorkbookLayerPath.html +3 -3
- package/cadenza.d.ts +71 -27
- package/cadenza.js +69 -36
- package/package.json +8 -8
- package/sandbox.html +69 -27
package/apidoc/index.html
CHANGED
|
@@ -1,62 +1,72 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta
|
|
2
|
-
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en" data-base="."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Cadenza JS - v10.2.10</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"><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" aria-hidden="true"><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 - v10.2.10</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" aria-hidden="true"><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"><h1>Cadenza JS - v10.2.10</h1></div><div class="tsd-panel tsd-typography"><!-- prettier-ignore-start -->
|
|
3
2
|
<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
3
|
<ul>
|
|
5
|
-
<li><a href="#
|
|
6
|
-
<li><a href="#
|
|
7
|
-
<li><a href="#
|
|
4
|
+
<li><a href="#installation">Installation</a></li>
|
|
5
|
+
<li><a href="#usage-examples">Usage Examples</a></li>
|
|
6
|
+
<li><a href="#the-development-sandbox">The development sandbox</a></li>
|
|
8
7
|
</ul>
|
|
9
|
-
<a id="
|
|
8
|
+
<a id="installation" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Installation<a href="#installation" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>Cadenza JS is included in the Cadenza distribution in the corresponding version.</p>
|
|
10
9
|
<p>Alternatively you can install the most recent version for a particular Cadenza Release using npm:</p>
|
|
11
|
-
<pre><code class="
|
|
12
|
-
</code><button>Copy</button></pre>
|
|
10
|
+
<pre><code class="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>
|
|
11
|
+
</code><button type="button">Copy</button></pre>
|
|
12
|
+
|
|
13
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="
|
|
15
|
-
<a id="
|
|
16
|
-
<a id="
|
|
14
|
+
<a id="cadenza-101-and-earlier" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Cadenza 10.1 and earlier<a href="#cadenza-101-and-earlier" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></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>
|
|
15
|
+
<a id="usage-examples" class="tsd-anchor"></a><h2 class="tsd-anchor-link">Usage Examples<a href="#usage-examples" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>This section features usage examples for Cadenza JS. For detailed usage information, see the "API:" links.</p>
|
|
16
|
+
<a id="general-usage" class="tsd-anchor"></a><h3 class="tsd-anchor-link">General Usage<a href="#general-usage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><small>API: <a href="./functions/cadenza.html">cadenza()</a></small></p>
|
|
17
17
|
<p>There are two ways to use Cadenza JS: As a module and globally.</p>
|
|
18
|
-
<a id="
|
|
19
|
-
<pre><code class="
|
|
20
|
-
</code><button>Copy</button></pre>
|
|
21
|
-
|
|
22
|
-
|
|
18
|
+
<a id="as-a-module" class="tsd-anchor"></a><h4 class="tsd-anchor-link">As a module<a href="#as-a-module" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></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>
|
|
19
|
+
<pre><code class="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>
|
|
20
|
+
</code><button type="button">Copy</button></pre>
|
|
21
|
+
|
|
22
|
+
<pre><code class="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>
|
|
23
|
+
</code><button type="button">Copy</button></pre>
|
|
24
|
+
|
|
23
25
|
<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>
|
|
24
|
-
<a id="
|
|
25
|
-
</code><button>Copy</button></pre>
|
|
26
|
-
|
|
27
|
-
|
|
26
|
+
<a id="globally" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Globally<a href="#globally" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="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>
|
|
27
|
+
</code><button type="button">Copy</button></pre>
|
|
28
|
+
|
|
29
|
+
<pre><code class="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>
|
|
30
|
+
</code><button type="button">Copy</button></pre>
|
|
31
|
+
|
|
28
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>
|
|
29
|
-
<pre><code class="
|
|
30
|
-
</code><button>Copy</button></pre>
|
|
31
|
-
|
|
32
|
-
<
|
|
33
|
-
|
|
34
|
-
|
|
33
|
+
<pre><code class="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>
|
|
34
|
+
</code><button type="button">Copy</button></pre>
|
|
35
|
+
|
|
36
|
+
<p>If for some reason you don't like the global <code>cadenza</code> field, you can remove it like so:</p>
|
|
37
|
+
<pre><code class="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>
|
|
38
|
+
</code><button type="button">Copy</button></pre>
|
|
39
|
+
|
|
40
|
+
<a id="communication-with-parent-cadenza" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Communication with parent Cadenza<a href="#communication-with-parent-cadenza" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>If your application is opened from inside Cadenza (e.g. in a popup), you can send commands to parent Cadenza window.
|
|
35
41
|
To do that, create CadenzaClient with no arguments:</p>
|
|
36
|
-
<pre><code class="
|
|
37
|
-
</code><button>Copy</button></pre>
|
|
38
|
-
|
|
42
|
+
<pre><code class="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>
|
|
43
|
+
</code><button type="button">Copy</button></pre>
|
|
44
|
+
|
|
45
|
+
<p><em>Warning:</em> Not every operation can be done when dealing with parent Cadenza. For example <code>reload</code> and <code>expandNavigator</code>
|
|
39
46
|
work, but <code>show</code>, <code>showMap</code> etc. require an iframe. Using these functions in this mode will result in errors.</p>
|
|
40
|
-
<a id="
|
|
47
|
+
<a id="show-an-embedding-target-in-an-iframe" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Show an Embedding Target in an Iframe<a href="#show-an-embedding-target-in-an-iframe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><small>API: <a href="./classes/CadenzaClient.html#show">CadenzaClient#show</a></small></p>
|
|
41
48
|
<p>Show an embedding target in an iframe and ...</p>
|
|
42
49
|
<ul>
|
|
43
|
-
<li>Hide Cadenza
|
|
50
|
+
<li>Hide Cadenza's main header and footer and the workbook toolbar.</li>
|
|
44
51
|
<li>Enable the simplified operation mode.</li>
|
|
45
52
|
<li>Disable the designer.</li>
|
|
46
53
|
<li>Set the filter variable "var1" to "foo".</li>
|
|
47
54
|
</ul>
|
|
48
|
-
<pre><code class="
|
|
49
|
-
</code><button>Copy</button></pre>
|
|
55
|
+
<pre><code class="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>
|
|
56
|
+
</code><button type="button">Copy</button></pre>
|
|
57
|
+
|
|
50
58
|
<ul>
|
|
51
59
|
<li>If the embedding target cannot be resolved, a 404 page is shown to the user.</li>
|
|
52
60
|
<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>
|
|
53
61
|
</ul>
|
|
54
|
-
<a id="
|
|
55
|
-
<pre><code class="
|
|
56
|
-
</code><button>Copy</button></pre>
|
|
57
|
-
|
|
58
|
-
<
|
|
59
|
-
|
|
62
|
+
<a id="show-the-generated-pdf-of-a-jasperreports-report-view-directly" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Show the Generated PDF of a "JasperReports report" View Directly<a href="#show-the-generated-pdf-of-a-jasperreports-report-view-directly" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></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>
|
|
63
|
+
<pre><code class="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>
|
|
64
|
+
</code><button type="button">Copy</button></pre>
|
|
65
|
+
|
|
66
|
+
<a id="abort-iframe-loading" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Abort (Iframe) Loading<a href="#abort-iframe-loading" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></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>
|
|
67
|
+
<pre><code class="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>
|
|
68
|
+
</code><button type="button">Copy</button></pre>
|
|
69
|
+
|
|
60
70
|
<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>
|
|
61
71
|
<!--
|
|
62
72
|
### Set Filters in the Currently Shown Embedding Target
|
|
@@ -69,18 +79,19 @@ Set filter variables using a mapping of variable names to values.
|
|
|
69
79
|
cadenzaClient.setFilter({ '<variableName>': 'value' });
|
|
70
80
|
```
|
|
71
81
|
-->
|
|
72
|
-
|
|
73
|
-
<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>
|
|
82
|
+
<a id="show-a-workbook-map-view" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Show a Workbook Map View<a href="#show-a-workbook-map-view" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><small>API: <a href="./classes/CadenzaClient.html#showMap">CadenzaClient#showMap</a></small></p>
|
|
74
83
|
<p>Show the embedding target of a workbook map view in an iframe and ...</p>
|
|
75
84
|
<ul>
|
|
76
85
|
<li>Set the initial map extent.</li>
|
|
77
86
|
<li>Show the given GeoJSON geometry on the map.</li>
|
|
78
87
|
</ul>
|
|
79
|
-
<p>The coordinates of extent and geometry are in the map
|
|
80
|
-
<pre><code class="
|
|
81
|
-
</code><button>Copy</button></pre>
|
|
82
|
-
|
|
83
|
-
|
|
88
|
+
<p>The coordinates of extent and geometry are in the map's SRS (<code>useMapSrs: true</code>).</p>
|
|
89
|
+
<pre><code class="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>
|
|
90
|
+
</code><button type="button">Copy</button></pre>
|
|
91
|
+
|
|
92
|
+
<a id="initialize-the-map-extent-by-setting-the-location-finder" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Initialize the Map Extent by Setting the Location Finder<a href="#initialize-the-map-extent-by-setting-the-location-finder" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><pre><code class="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>
|
|
93
|
+
</code><button type="button">Copy</button></pre>
|
|
94
|
+
|
|
84
95
|
<!--
|
|
85
96
|
### Set the Visibility of a Layer in the Currently Shown Workbook Map View
|
|
86
97
|
|
|
@@ -92,7 +103,6 @@ To set the visibility of a layer in the currently shown map, pass the layer path
|
|
|
92
103
|
cadenzaClient.setLayerVisibility('<layerPrintName>', false);
|
|
93
104
|
```
|
|
94
105
|
-->
|
|
95
|
-
|
|
96
106
|
<!--
|
|
97
107
|
### Get the Image of the Currently Shown Workbook Map View
|
|
98
108
|
|
|
@@ -106,27 +116,31 @@ const data = await cadenzaClient.getData('png');
|
|
|
106
116
|
canvas.drawImage(await createImageBitmap(data), 0, 0);
|
|
107
117
|
```
|
|
108
118
|
-->
|
|
119
|
+
<a id="edit-an-existing-geometry" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Edit an Existing Geometry<a href="#edit-an-existing-geometry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></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>
|
|
120
|
+
<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>
|
|
121
|
+
<pre><code class="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>
|
|
122
|
+
</code><button type="button">Copy</button></pre>
|
|
123
|
+
|
|
124
|
+
<a id="unsubscribe-from-an-event" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Unsubscribe From an Event<a href="#unsubscribe-from-an-event" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p>The <code>on()</code> method returns an unsubscribe function.</p>
|
|
125
|
+
<pre><code class="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>
|
|
126
|
+
</code><button type="button">Copy</button></pre>
|
|
127
|
+
|
|
128
|
+
<a id="create-a-new-geometry" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Create a New Geometry<a href="#create-a-new-geometry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><small>API: <a href="./classes/CadenzaClient.html#createGeometry">CadenzaClient#createGeometry</a></small></p>
|
|
129
|
+
<p>Create 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>
|
|
130
|
+
<pre><code class="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 creation 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>
|
|
131
|
+
</code><button type="button">Copy</button></pre>
|
|
109
132
|
|
|
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>
|
|
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>
|
|
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>
|
|
113
|
-
</code><button>Copy</button></pre>
|
|
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>
|
|
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>
|
|
116
|
-
</code><button>Copy</button></pre>
|
|
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>
|
|
118
|
-
<p>Create 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>
|
|
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 creation 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>
|
|
120
|
-
</code><button>Copy</button></pre>
|
|
121
133
|
<p><em>Note:</em> Under the hood, creating a geometry is similar to editing a geometry.
|
|
122
|
-
That
|
|
123
|
-
<a id="
|
|
124
|
-
<pre><code class="
|
|
125
|
-
</code><button>Copy</button></pre>
|
|
126
|
-
|
|
134
|
+
That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
135
|
+
<a id="additional-background-layers" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Additional Background Layers<a href="#additional-background-layers" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Create a GeoJSON polygon geometry with a workbook map view and some additional background layers.</p>
|
|
136
|
+
<pre><code class="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">'Polygon'</span><span class="hl-1">, {</span><br/><span class="hl-1"> </span><span class="hl-9">additionalLayers:</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">'geojson'</span><span class="hl-1">, </span><span class="hl-9">name:</span><span class="hl-1"> </span><span class="hl-2">'Example'</span><span class="hl-1">, </span><span class="hl-9">content:</span><span class="hl-1"> </span><span class="hl-4"><</span><span class="hl-14">FeatureCollection</span><span class="hl-4">></span><span class="hl-1"> },</span><br/><span class="hl-1"> ...</span><br/><span class="hl-1"> ]</span><br/><span class="hl-1">});</span>
|
|
137
|
+
</code><button type="button">Copy</button></pre>
|
|
138
|
+
|
|
139
|
+
<a id="select-objects-in-a-workbook-map-view" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Select Objects in a Workbook Map View<a href="#select-objects-in-a-workbook-map-view" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><small>API: <a href="./classes/CadenzaClient.html#selectObjects">CadenzaClient#selectObjects</a></small></p>
|
|
127
140
|
<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>
|
|
128
|
-
<pre><code class="
|
|
129
|
-
</code><button>Copy</button></pre>
|
|
141
|
+
<pre><code class="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>
|
|
142
|
+
</code><button type="button">Copy</button></pre>
|
|
143
|
+
|
|
130
144
|
<!--
|
|
131
145
|
#### _Programmatically_ Set the Selection in the Currently Shown Workbook Map View
|
|
132
146
|
|
|
@@ -145,59 +159,69 @@ You can also add to or remove from the current selection:
|
|
|
145
159
|
* <small>API: [CadenzaClient#addSelection](./classes/CadenzaClient.html#addSelection)</small>
|
|
146
160
|
* <small>API: [CadenzaClient#removeSelection](./classes/CadenzaClient.html#removeSelection)</small>
|
|
147
161
|
-->
|
|
148
|
-
|
|
149
|
-
<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>
|
|
162
|
+
<a id="highlight-an-item-in-the-navigator" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Highlight an Item in the Navigator<a href="#highlight-an-item-in-the-navigator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><small>API: <a href="./classes/CadenzaClient.html#show">CadenzaClient#show</a></small></p>
|
|
150
163
|
<p>Show an embedding target in an iframe and highlight an item in the navigator. Additionally, expand the navigator tree.</p>
|
|
151
|
-
<pre><code class="
|
|
152
|
-
</code><button>Copy</button></pre>
|
|
153
|
-
|
|
154
|
-
<
|
|
155
|
-
<
|
|
156
|
-
|
|
157
|
-
|
|
164
|
+
<pre><code class="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>
|
|
165
|
+
</code><button type="button">Copy</button></pre>
|
|
166
|
+
|
|
167
|
+
<a id="highlight-an-item-in-the-navigator-on-the-welcome-page" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Highlight an Item in the Navigator on the Welcome Page<a href="#highlight-an-item-in-the-navigator-on-the-welcome-page" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><p><small>API: <a href="./classes/CadenzaClient.html#show">CadenzaClient#show</a></small></p>
|
|
168
|
+
<p>Show Cadenza's welcome page in an iframe and highlight an item in the navigator.</p>
|
|
169
|
+
<pre><code class="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>
|
|
170
|
+
</code><button type="button">Copy</button></pre>
|
|
171
|
+
|
|
172
|
+
<a id="expand-the-navigator" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Expand the Navigator<a href="#expand-the-navigator" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h4><p><small>API: <a href="./classes/CadenzaClient.html#expandNavigator">CadenzaClient#expandNavigator</a></small></p>
|
|
158
173
|
<p>Expand the navigator.</p>
|
|
159
|
-
<pre><code class="
|
|
160
|
-
</code><button>Copy</button></pre>
|
|
161
|
-
|
|
174
|
+
<pre><code class="javascript"><span class="hl-9">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">expandNavigator</span><span class="hl-1">();</span>
|
|
175
|
+
</code><button type="button">Copy</button></pre>
|
|
176
|
+
|
|
177
|
+
<a id="fetch-data-from-a-workbook-view" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Fetch Data From a Workbook View<a href="#fetch-data-from-a-workbook-view" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><small>API: <a href="./classes/CadenzaClient.html#fetchData">CadenzaClient#fetchData</a></small></p>
|
|
162
178
|
<p>Fetch data from a workbook view in CSV format.</p>
|
|
163
|
-
<pre><code class="
|
|
164
|
-
</code><button>Copy</button></pre>
|
|
165
|
-
|
|
166
|
-
<
|
|
167
|
-
|
|
168
|
-
|
|
179
|
+
<pre><code class="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>
|
|
180
|
+
</code><button type="button">Copy</button></pre>
|
|
181
|
+
|
|
182
|
+
<a id="control-the-contents-of-the-fetched-table-data" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Control the Contents of the Fetched Table Data<a href="#control-the-contents-of-the-fetched-table-data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></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>
|
|
183
|
+
<pre><code class="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>
|
|
184
|
+
</code><button type="button">Copy</button></pre>
|
|
185
|
+
|
|
186
|
+
<a id="fetch-the-object-info-from-a-workbook-map-view" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Fetch the Object Info from a Workbook Map View<a href="#fetch-the-object-info-from-a-workbook-map-view" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><small>API: [CadenzaClient#fetchObjectInfo(./classes/CadenzaClient.html#fetchObjectInfo)</small></p>
|
|
169
187
|
<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>
|
|
170
|
-
<pre><code class="
|
|
171
|
-
</code><button>Copy</button></pre>
|
|
172
|
-
|
|
188
|
+
<pre><code class="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>
|
|
189
|
+
</code><button type="button">Copy</button></pre>
|
|
190
|
+
|
|
191
|
+
<a id="fetch-the-area-intersection-from-a-workbook-map-view-layer" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Fetch the area intersection from a Workbook Map View Layer<a href="#fetch-the-area-intersection-from-a-workbook-map-view-layer" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><small>API: [CadenzaClient#fetchObjectInfo(./classes/CadenzaClient.html#fetchAreaIntersections)</small></p>
|
|
173
192
|
<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>
|
|
174
|
-
<pre><code class="
|
|
175
|
-
</code><button>Copy</button></pre>
|
|
176
|
-
|
|
177
|
-
<
|
|
178
|
-
<
|
|
179
|
-
|
|
180
|
-
|
|
193
|
+
<pre><code class="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>
|
|
194
|
+
</code><button type="button">Copy</button></pre>
|
|
195
|
+
|
|
196
|
+
<a id="download-data-from-a-workbook-view" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Download Data From a Workbook View<a href="#download-data-from-a-workbook-view" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><small>API: <a href="./classes/CadenzaClient.html#downloadData">CadenzaClient#downloadData</a></small></p>
|
|
197
|
+
<p>Download data from a workbook view in Excel format. This triggers the browser's download dialog.</p>
|
|
198
|
+
<pre><code class="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>
|
|
199
|
+
</code><button type="button">Copy</button></pre>
|
|
200
|
+
|
|
201
|
+
<a id="reload-the-views-of-a-worksheet" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Reload the Views of a Worksheet<a href="#reload-the-views-of-a-worksheet" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><small>API: <a href="./classes/CadenzaClient.html#reload">CadenzaClient#reload</a></small></p>
|
|
181
202
|
<p>To reload a worksheet:</p>
|
|
182
|
-
<pre><code class="
|
|
183
|
-
</code><button>Copy</button></pre>
|
|
203
|
+
<pre><code class="javascript"><span class="hl-9">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">reload</span><span class="hl-1">();</span>
|
|
204
|
+
</code><button type="button">Copy</button></pre>
|
|
205
|
+
|
|
184
206
|
<p>To invalidate caches and reload:</p>
|
|
185
|
-
<pre><code class="
|
|
186
|
-
</code><button>Copy</button></pre>
|
|
187
|
-
|
|
207
|
+
<pre><code class="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>
|
|
208
|
+
</code><button type="button">Copy</button></pre>
|
|
209
|
+
|
|
210
|
+
<a id="close-the-cadenza-dialog-or-window-that-embeds-the-custom-application" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Close the Cadenza Dialog or Window That Embeds the Custom Application<a href="#close-the-cadenza-dialog-or-window-that-embeds-the-custom-application" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><small>API: <a href="./classes/CadenzaClient.html#closeMe">CadenzaClient#closeMe</a></small></p>
|
|
188
211
|
<p>Sends a message to parent Cadenza window to close the window containing this application.</p>
|
|
189
|
-
<pre><code class="
|
|
190
|
-
</code><button>Copy</button></pre>
|
|
191
|
-
|
|
212
|
+
<pre><code class="javascript"><span class="hl-9">cadenzaClient</span><span class="hl-1">.</span><span class="hl-0">closeMe</span><span class="hl-1">();</span>
|
|
213
|
+
</code><button type="button">Copy</button></pre>
|
|
214
|
+
|
|
215
|
+
<a id="listen-for-cadenza-closing-the-custom-application" class="tsd-anchor"></a><h4 class="tsd-anchor-link">Listen for Cadenza Closing the Custom Application<a href="#listen-for-cadenza-closing-the-custom-application" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></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>
|
|
192
216
|
<ul>
|
|
193
217
|
<li>The <a href="https://developer.mozilla.org/docs/Web/API/Window/unload_event">Window: <code>unload</code> event</a> is dispatched when the window/dialog is closed.</li>
|
|
194
218
|
<li>The <a href="https://developer.mozilla.org/docs/Web/API/Document/visibilitychange_event">Document: <code>visibilitychange</code> event</a> is dispatched when the window/dialog is closed <em>or hidden</em> (for example when the user switches to another browser tab).</li>
|
|
195
219
|
</ul>
|
|
196
|
-
<p><em>Note:</em> If you need to send a request to your server when the window/dialog is closed, you should use the <a href="https://developer.mozilla.org/docs/Web/API/Navigator/sendBeacon">Navigator: <code>sendBeacon()</code> method</a>. It
|
|
197
|
-
<a id="
|
|
220
|
+
<p><em>Note:</em> If you need to send a request to your server when the window/dialog is closed, you should use the <a href="https://developer.mozilla.org/docs/Web/API/Navigator/sendBeacon">Navigator: <code>sendBeacon()</code> method</a>. It's limited to POST requests, but in contrast to the "normal" XHR or <code>fetch()</code> APIs, it works reliably when the dialog/window is closed.</p>
|
|
221
|
+
<a id="the-development-sandbox" class="tsd-anchor"></a><h2 class="tsd-anchor-link">The Development Sandbox<a href="#the-development-sandbox" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p>The development sandbox is a simple custom application (in fact a single <code>.html</code> file) for playing with Cadenza JS.</p>
|
|
198
222
|
<p>To run it ...</p>
|
|
199
223
|
<ul>
|
|
200
|
-
<li>You need a Cadenza installation running on <a href="http://localhost:8080/cadenza">http://localhost:8080/cadenza</a>. (See <a href="#
|
|
224
|
+
<li>You need a Cadenza installation running on <a href="http://localhost:8080/cadenza">http://localhost:8080/cadenza</a>. (See <a href="#customize-the-cadenza-url">Customize the Cadenza URL</a> below)</li>
|
|
201
225
|
<li>In <code>node_modules/@disy/cadenza.js</code> run <code>npm run sandbox</code> to start the sandbox.</li>
|
|
202
226
|
</ul>
|
|
203
227
|
<p>The command starts a proxy server that serves the <code>sandbox.html</code> and <code>cadenza.js</code> files and proxies all other requests to the Cadenza server. Since that way the sandbox and Cadenza run on the same origin, embedding and <code>postMessage</code> communication just work.</p>
|
|
@@ -207,18 +231,20 @@ You can also add to or remove from the current selection:
|
|
|
207
231
|
<li>Now, <code>sandbox.html</code> is served on <a href="http://localhost:8080/cadenza/sandbox">http://localhost:8080/cadenza/sandbox</a> (replace with custom Cadenza url <code>/sandbox</code> as needed).</li>
|
|
208
232
|
</ul>
|
|
209
233
|
<p><code>cadenza.js</code> is automatically served when Cadenza starts.</p>
|
|
210
|
-
<a id="
|
|
211
|
-
<p>The sandbox uses Cadenza JS with the "debug" option enabled, so you can see what is going on internally in the browser
|
|
212
|
-
<a id="
|
|
234
|
+
<a id="the-sandbox-ui" class="tsd-anchor"></a><h3 class="tsd-anchor-link">The Sandbox UI<a href="#the-sandbox-ui" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h3><p><code>npm run sandbox</code> also opens the sandbox in a new browser window. Select the Cadenza JS method you want to play with in the select box at the top. For each method there are controls to define the parameters. Hit "Go!" to call the method.</p>
|
|
235
|
+
<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>
|
|
236
|
+
<a id="customize-the-cadenza-url" class="tsd-anchor"></a><h3 class="tsd-anchor-link">Customize the Cadenza URL<a href="#customize-the-cadenza-url" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></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>
|
|
213
237
|
<ul>
|
|
214
|
-
<li>Pass an argument:<pre><code class="
|
|
215
|
-
</code><button>Copy</button></pre>
|
|
238
|
+
<li>Pass an argument:<pre><code class="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>
|
|
239
|
+
</code><button type="button">Copy</button></pre>
|
|
240
|
+
|
|
216
241
|
</li>
|
|
217
|
-
<li>Set an environment variable:<pre><code class="
|
|
218
|
-
</code><button>Copy</button></pre>
|
|
242
|
+
<li>Set an environment variable:<pre><code class="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-9">http</span><span class="hl-1">://</span><span class="hl-9">localhost</span><span class="hl-1">:</span><span class="hl-9">8000</span><span class="hl-1">/</span><span class="hl-9">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>
|
|
243
|
+
</code><button type="button">Copy</button></pre>
|
|
244
|
+
|
|
219
245
|
</li>
|
|
220
246
|
</ul>
|
|
221
|
-
<a id="
|
|
247
|
+
<a id="json-representation-of-cadenza-object-data" class="tsd-anchor"></a><h2 class="tsd-anchor-link">JSON Representation of Cadenza Object Data<a href="#json-representation-of-cadenza-object-data" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p><a href="https://www.json.org/">JSON</a> is a simple data-interchange format, which is also used in the Cadenza API. It does not support all the attribute types of Cadenza objects, that's why there are some rules for representing Cadenza object data in JSON.</p>
|
|
222
248
|
<table>
|
|
223
249
|
<thead>
|
|
224
250
|
<tr>
|
|
@@ -228,7 +254,8 @@ You can also add to or remove from the current selection:
|
|
|
228
254
|
<th>Notes</th>
|
|
229
255
|
</tr>
|
|
230
256
|
</thead>
|
|
231
|
-
<tbody
|
|
257
|
+
<tbody>
|
|
258
|
+
<tr>
|
|
232
259
|
<td>Text (String)</td>
|
|
233
260
|
<td>string</td>
|
|
234
261
|
<td><code>"Text"</code></td>
|
|
@@ -244,7 +271,7 @@ You can also add to or remove from the current selection:
|
|
|
244
271
|
<td>Number (Long)</td>
|
|
245
272
|
<td>string</td>
|
|
246
273
|
<td><code>"1"</code></td>
|
|
247
|
-
<td>The long value range exceeds the range of the JSON number type. So it
|
|
274
|
+
<td>The long value range exceeds the range of the JSON number type. So it's represented as a string.</td>
|
|
248
275
|
</tr>
|
|
249
276
|
<tr>
|
|
250
277
|
<td>Floating point number (Double)</td>
|
|
@@ -256,7 +283,7 @@ You can also add to or remove from the current selection:
|
|
|
256
283
|
<td>Floating point number (Big decimal)</td>
|
|
257
284
|
<td>string</td>
|
|
258
285
|
<td><code>"1.23"</code></td>
|
|
259
|
-
<td>The big decimal value range exceeds the range of the JSON number type. So it
|
|
286
|
+
<td>The big decimal value range exceeds the range of the JSON number type. So it's represented as a string.</td>
|
|
260
287
|
</tr>
|
|
261
288
|
<tr>
|
|
262
289
|
<td>Date</td>
|
|
@@ -273,7 +300,7 @@ You can also add to or remove from the current selection:
|
|
|
273
300
|
<tr>
|
|
274
301
|
<td>Geometry</td>
|
|
275
302
|
<td>object</td>
|
|
276
|
-
<td><pre lang="json">{<br>
|
|
303
|
+
<td><pre lang="json">{<br> "type": "Point"<br> "coordinates": [125.6, 10.1]<br>}</pre></td>
|
|
277
304
|
<td>A geometry is represented as a <a href="https://geojson.org/">GeoJSON</a> object.<br><em>Note:</em> By default, coordinates in GeoJSON use the WGS84 projection.</td>
|
|
278
305
|
</tr>
|
|
279
306
|
<tr>
|
|
@@ -294,5 +321,6 @@ You can also add to or remove from the current selection:
|
|
|
294
321
|
<td></td>
|
|
295
322
|
<td></td>
|
|
296
323
|
</tr>
|
|
297
|
-
</tbody
|
|
298
|
-
|
|
324
|
+
</tbody>
|
|
325
|
+
</table>
|
|
326
|
+
<!-- prettier-ignore-end --></div></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><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-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></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><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-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#installation"><span>Installation</span></a><ul><li><a href="#cadenza-101-and-earlier"><span>Cadenza 10.1 and earlier</span></a></li></ul><a href="#usage-examples"><span>Usage <wbr/>Examples</span></a><ul><li><a href="#general-usage"><span>General <wbr/>Usage</span></a></li><li><ul><li><a href="#as-a-module"><span>As a module</span></a></li><li><a href="#globally"><span>Globally</span></a></li></ul></li><li><a href="#communication-with-parent-cadenza"><span>Communication with parent <wbr/>Cadenza</span></a></li><li><a href="#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="#show-the-generated-pdf-of-a-jasperreports-report-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="#abort-iframe-loading"><span>Abort (<wbr/>Iframe) <wbr/>Loading</span></a></li><li><a href="#show-a-workbook-map-view"><span>Show a <wbr/>Workbook <wbr/>Map <wbr/>View</span></a></li><li><ul><li><a href="#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="#edit-an-existing-geometry"><span>Edit an <wbr/>Existing <wbr/>Geometry</span></a></li><li><a href="#unsubscribe-from-an-event"><span>Unsubscribe <wbr/>From an <wbr/>Event</span></a></li><li><a href="#create-a-new-geometry"><span>Create a <wbr/>New <wbr/>Geometry</span></a></li><li><ul><li><a href="#additional-background-layers"><span>Additional <wbr/>Background <wbr/>Layers</span></a></li></ul></li><li><a href="#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="#highlight-an-item-in-the-navigator"><span>Highlight an <wbr/>Item in the <wbr/>Navigator</span></a></li><li><ul><li><a href="#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="#expand-the-navigator"><span>Expand the <wbr/>Navigator</span></a></li></ul></li><li><a href="#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="#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="#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="#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="#download-data-from-a-workbook-view"><span>Download <wbr/>Data <wbr/>From a <wbr/>Workbook <wbr/>View</span></a></li><li><a href="#reload-the-views-of-a-worksheet"><span>Reload the <wbr/>Views of a <wbr/>Worksheet</span></a></li><li><a href="#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="#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="#the-development-sandbox"><span>The <wbr/>Development <wbr/>Sandbox</span></a><ul><li><a href="#the-sandbox-ui"><span>The <wbr/>Sandbox UI</span></a></li><li><a href="#customize-the-cadenza-url"><span>Customize the <wbr/>Cadenza URL</span></a></li></ul><a href="#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 id="tsd-sidebar-links" class="tsd-navigation"><a href="https://github.com/DisyInformationssysteme/cadenza.js" class="tsd-nav-link">Cadenza JS on GitHub</a></nav><nav class="tsd-navigation"><a href="modules.html">Cadenza JS - v10.2.10</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><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>
|