@disy/cadenza.js 10.5.4 → 10.6.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 +19 -0
- package/apidoc/assets/navigation.js +1 -1
- package/apidoc/assets/search.js +1 -1
- package/apidoc/classes/AbortError.html +3 -3
- package/apidoc/classes/CadenzaClient.html +71 -27
- package/apidoc/classes/CadenzaError.html +5 -5
- package/apidoc/functions/cadenza.html +4 -4
- package/apidoc/index.html +21 -21
- package/apidoc/interfaces/AreaIntersectionsResult.html +4 -4
- package/apidoc/interfaces/CadenzaClientOptions.html +6 -6
- package/apidoc/interfaces/CadenzaEvent.html +4 -4
- package/apidoc/interfaces/CommonEditGeometryOptions.html +13 -11
- package/apidoc/interfaces/Distance.html +2 -2
- package/apidoc/interfaces/ExternalLinkKey.html +4 -4
- package/apidoc/interfaces/Feature.html +9 -9
- package/apidoc/interfaces/FeatureCollection.html +4 -4
- package/apidoc/interfaces/Geometry.html +4 -4
- package/apidoc/interfaces/GeometryExtentStrategy.html +4 -4
- package/apidoc/interfaces/LayerDataExtentStrategy.html +4 -4
- package/apidoc/interfaces/LayerDefinition.html +4 -4
- package/apidoc/interfaces/LocationFinderExtentStrategy.html +4 -4
- package/apidoc/interfaces/PageSource.html +3 -3
- package/apidoc/interfaces/ProblemDetails.html +6 -6
- package/apidoc/interfaces/SnappingOptions.html +3 -3
- package/apidoc/interfaces/SpatialFilterValue.html +4 -4
- package/apidoc/interfaces/StaticExtentStrategy.html +4 -4
- package/apidoc/modules.html +1 -1
- package/apidoc/types/CadenzaActionEvent.html +2 -2
- package/apidoc/types/CadenzaChangeExtentEvent.html +3 -0
- package/apidoc/types/CadenzaChangeSelectionEvent.html +2 -2
- package/apidoc/types/CadenzaDrillThroughEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryCancelEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryCreateEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryDeleteEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryEditEvent.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/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 +2 -2
- package/apidoc/types/Extent.html +2 -2
- package/apidoc/types/ExtentStrategy.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/Layout.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/Polygon.html +1 -1
- package/apidoc/types/SpatialRelation.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/WorksheetPlaceholders.html +2 -2
- package/cadenza.d.ts +43 -16
- package/cadenza.js +88 -24
- package/package.json +3 -5
- package/sandbox.html +15 -4
|
@@ -1,4 +1,4 @@
|
|
|
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>CadenzaClient | Cadenza JS - v10.
|
|
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>CadenzaClient | Cadenza JS - v10.6.0</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.6.0</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"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Cadenza JS</a></li><li><a href="CadenzaClient.html">CadenzaClient</a></li></ul><h1>Class CadenzaClient</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p><em>Notes:</em></p>
|
|
2
2
|
<ul>
|
|
3
3
|
<li>Most public methods are tagged with one of these modifiers:
|
|
4
4
|
<ul>
|
|
@@ -13,9 +13,10 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
|
|
|
13
13
|
<li>If there's another error, the result Promise is rejected with a <a href="CadenzaError.html" class="tsd-kind-class">CadenzaError</a>.</li>
|
|
14
14
|
<li>For methods that support the <code>hideMainHeaderAndFooter</code> and <code>hideWorkbookToolBar</code> parameters - the parameters cannot override the configuration of an embedding target.</li>
|
|
15
15
|
</ul>
|
|
16
|
-
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
16
|
+
</div><div class="tsd-comment tsd-typography"></div></section><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L289">src/cadenza.js:289</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-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" aria-hidden="true"><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">Accessors</h3><div class="tsd-index-list"><a href="CadenzaClient.html#baseurl" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>base<wbr/>Url</span></a>
|
|
17
17
|
<a href="CadenzaClient.html#iframe" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>iframe</span></a>
|
|
18
|
-
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="CadenzaClient.html#
|
|
18
|
+
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><a href="CadenzaClient.html#addselection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Selection</span></a>
|
|
19
|
+
<a href="CadenzaClient.html#batchcreategeometry" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>batch<wbr/>Create<wbr/>Geometry</span></a>
|
|
19
20
|
<a href="CadenzaClient.html#batcheditgeometry" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>batch<wbr/>Edit<wbr/>Geometry</span></a>
|
|
20
21
|
<a href="CadenzaClient.html#closeme" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>close<wbr/>Me</span></a>
|
|
21
22
|
<a href="CadenzaClient.html#creategeometry" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Geometry</span></a>
|
|
@@ -29,18 +30,29 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
|
|
|
29
30
|
<a href="CadenzaClient.html#getdata" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Data</span></a>
|
|
30
31
|
<a href="CadenzaClient.html#on" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on</span></a>
|
|
31
32
|
<a href="CadenzaClient.html#reload" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reload</span></a>
|
|
33
|
+
<a href="CadenzaClient.html#removeselection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Selection</span></a>
|
|
32
34
|
<a href="CadenzaClient.html#selectobjects" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>select<wbr/>Objects</span></a>
|
|
33
35
|
<a href="CadenzaClient.html#setcustomvalidity" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Custom<wbr/>Validity</span></a>
|
|
36
|
+
<a href="CadenzaClient.html#setfilter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Filter</span></a>
|
|
37
|
+
<a href="CadenzaClient.html#setlayervisibility" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Layer<wbr/>Visibility</span></a>
|
|
38
|
+
<a href="CadenzaClient.html#setselection" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Selection</span></a>
|
|
34
39
|
<a href="CadenzaClient.html#show" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>show</span></a>
|
|
35
40
|
<a href="CadenzaClient.html#showmap" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>show<wbr/>Map</span></a>
|
|
36
41
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Accessors</h2></summary><section><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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature" id="baseurl-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">baseUrl</span><span class="tsd-signature-symbol">()</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-description"><div class="tsd-comment tsd-typography"><p>The base URL of the Cadenza server this client is requesting</p>
|
|
37
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
38
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">HTMLIFrameElement</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
42
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">string</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L353">src/cadenza.js:353</a></li></ul></aside></div></li></ul></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" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class=""><div class="tsd-signature" id="iframe-1"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">iframe</span><span class="tsd-signature-symbol">()</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">HTMLIFrameElement</span></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>The iframe this client is using for embedding Cadenza.</p>
|
|
43
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">HTMLIFrameElement</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L358">src/cadenza.js:358</a></li></ul></aside></div></li></ul></section></section></details><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><h2><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg> Methods</h2></summary><section><section class="tsd-panel tsd-member"><a id="addselection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>add<wbr/>Selection</span><a href="#addselection" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="addselection-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">addSelection</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">layer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/WorkbookLayerPath.html" class="tsd-signature-type tsd-kind-type-alias">WorkbookLayerPath</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">values</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">extentStrategy</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/GeometryExtentStrategy.html" class="tsd-signature-type tsd-kind-interface">GeometryExtentStrategy</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#addselection-1" 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></div><div class="tsd-description"><code class="tsd-tag">Post Message</code><div class="tsd-comment tsd-typography"><p>Add to the selection in the currently shown workbook map view.</p>
|
|
44
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">layer</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/WorkbookLayerPath.html" class="tsd-signature-type tsd-kind-type-alias">WorkbookLayerPath</a></span><div class="tsd-comment tsd-typography"><p>The data view layer to change the selection in</p>
|
|
45
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">values</span>: <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The IDs of the objects to select</p>
|
|
46
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">extentStrategy</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/GeometryExtentStrategy.html" class="tsd-signature-type tsd-kind-interface">GeometryExtentStrategy</a> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">extentStrategy</span><span class="tsd-signature-symbol">?: </span><a href="../interfaces/GeometryExtentStrategy.html" class="tsd-signature-type tsd-kind-interface">GeometryExtentStrategy</a></h5><div class="tsd-comment tsd-typography"><p>Strategy to define the new map extent</p>
|
|
47
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>A <code>Promise</code> for when the selection was changed.</p>
|
|
48
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L655">src/cadenza.js:655</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="batchcreategeometry" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>batch<wbr/>Create<wbr/>Geometry</span><a href="#batchcreategeometry" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="batchcreategeometry-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">batchCreateGeometry</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">backgroundMapView</span><span class="tsd-signature-symbol">:</span> <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">geometryType</span><span class="tsd-signature-symbol">:</span> <a href="../types/GeometryType.html" class="tsd-signature-type tsd-kind-type-alias">GeometryType</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/CommonEditGeometryOptions.html" class="tsd-signature-type tsd-kind-interface">CommonEditGeometryOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#batchcreategeometry-1" 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></div><div class="tsd-description"><code class="tsd-tag">Embed</code><div class="tsd-comment tsd-typography"><p>Create multiple geometries.</p>
|
|
39
49
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">backgroundMapView</span>: <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a></span><div class="tsd-comment tsd-typography"><p>The workbook map view in the background</p>
|
|
40
50
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">geometryType</span>: <a href="../types/GeometryType.html" class="tsd-signature-type tsd-kind-type-alias">GeometryType</a></span><div class="tsd-comment tsd-typography"><p>The type of geometries to create</p>
|
|
41
51
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">__namedParameters</span>: <a href="../interfaces/CommonEditGeometryOptions.html" class="tsd-signature-type tsd-kind-interface">CommonEditGeometryOptions</a></span></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>A <code>Promise</code> for when the iframe is loaded</p>
|
|
42
52
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws" class="tsd-anchor"></a>Throws<a href="#throws" 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>For invalid arguments</p>
|
|
43
53
|
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link"><a id="fires" class="tsd-anchor"></a>Fires<a href="#fires" 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><ul>
|
|
54
|
+
<li><a href="../types/CadenzaChangeExtentEvent.html" class="tsd-kind-type-alias">CadenzaChangeExtentEvent</a></li>
|
|
55
|
+
<li><a href="../types/CadenzaChangeSelectionEvent.html" class="tsd-kind-type-alias">CadenzaChangeSelectionEvent</a></li>
|
|
44
56
|
<li><a href="../types/CadenzaEditGeometryUpdateEvent.html" class="tsd-kind-type-alias">CadenzaEditGeometryUpdateEvent</a></li>
|
|
45
57
|
<li><a href="../types/CadenzaEditGeometryOkEvent.html" class="tsd-kind-type-alias">CadenzaEditGeometryOkEvent</a></li>
|
|
46
58
|
<li><a href="../types/CadenzaEditGeometryCreateEvent.html" class="tsd-kind-type-alias">CadenzaEditGeometryCreateEvent</a></li>
|
|
@@ -48,12 +60,14 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
|
|
|
48
60
|
<li><a href="../types/CadenzaEditGeometryDeleteEvent.html" class="tsd-kind-type-alias">CadenzaEditGeometryDeleteEvent</a></li>
|
|
49
61
|
<li><a href="../types/CadenzaEditGeometryCancelEvent.html" class="tsd-kind-type-alias">CadenzaEditGeometryCancelEvent</a></li>
|
|
50
62
|
</ul>
|
|
51
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
63
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L822">src/cadenza.js:822</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="batcheditgeometry" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>batch<wbr/>Edit<wbr/>Geometry</span><a href="#batcheditgeometry" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="batcheditgeometry-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">batchEditGeometry</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">backgroundMapView</span><span class="tsd-signature-symbol">:</span> <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">features</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/FeatureCollection.html" class="tsd-signature-type tsd-kind-interface">FeatureCollection</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/CommonEditGeometryOptions.html" class="tsd-signature-type tsd-kind-interface">CommonEditGeometryOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#batcheditgeometry-1" 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></div><div class="tsd-description"><code class="tsd-tag">Embed</code><div class="tsd-comment tsd-typography"><p>Edit multiple geometries.</p>
|
|
52
64
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">backgroundMapView</span>: <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a></span><div class="tsd-comment tsd-typography"><p>The workbook map view in the background</p>
|
|
53
65
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">features</span>: <a href="../interfaces/FeatureCollection.html" class="tsd-signature-type tsd-kind-interface">FeatureCollection</a></span><div class="tsd-comment tsd-typography"><p>The features to edit. The last feature in this collection is directly set up for editing.</p>
|
|
54
66
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">__namedParameters</span>: <a href="../interfaces/CommonEditGeometryOptions.html" class="tsd-signature-type tsd-kind-interface">CommonEditGeometryOptions</a></span></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>A <code>Promise</code> for when the iframe is loaded</p>
|
|
55
67
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-1" class="tsd-anchor"></a>Throws<a href="#throws-1" 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>For invalid arguments</p>
|
|
56
68
|
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link"><a id="fires-1" class="tsd-anchor"></a>Fires<a href="#fires-1" 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><ul>
|
|
69
|
+
<li><a href="../types/CadenzaChangeExtentEvent.html" class="tsd-kind-type-alias">CadenzaChangeExtentEvent</a></li>
|
|
70
|
+
<li><a href="../types/CadenzaChangeSelectionEvent.html" class="tsd-kind-type-alias">CadenzaChangeSelectionEvent</a></li>
|
|
57
71
|
<li><a href="../types/CadenzaEditGeometryUpdateEvent.html" class="tsd-kind-type-alias">CadenzaEditGeometryUpdateEvent</a></li>
|
|
58
72
|
<li><a href="../types/CadenzaEditGeometryOkEvent.html" class="tsd-kind-type-alias">CadenzaEditGeometryOkEvent</a></li>
|
|
59
73
|
<li><a href="../types/CadenzaEditGeometryCreateEvent.html" class="tsd-kind-type-alias">CadenzaEditGeometryCreateEvent</a></li>
|
|
@@ -61,21 +75,23 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
|
|
|
61
75
|
<li><a href="../types/CadenzaEditGeometryDeleteEvent.html" class="tsd-kind-type-alias">CadenzaEditGeometryDeleteEvent</a></li>
|
|
62
76
|
<li><a href="../types/CadenzaEditGeometryCancelEvent.html" class="tsd-kind-type-alias">CadenzaEditGeometryCancelEvent</a></li>
|
|
63
77
|
</ul>
|
|
64
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
65
|
-
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
78
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L883">src/cadenza.js:883</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="closeme" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>close<wbr/>Me</span><a href="#closeme" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="closeme-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">closeMe</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#closeme-1" 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></div><div class="tsd-description"><code class="tsd-tag">Post Message Parent</code><div class="tsd-comment tsd-typography"><p>Sends a message to parent Cadenza window to close the window containing this application</p>
|
|
79
|
+
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L478">src/cadenza.js:478</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="creategeometry" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>create<wbr/>Geometry</span><a href="#creategeometry" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="creategeometry-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createGeometry</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">backgroundMapView</span><span class="tsd-signature-symbol">:</span> <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">geometryType</span><span class="tsd-signature-symbol">:</span> <a href="../types/GeometryType.html" class="tsd-signature-type tsd-kind-type-alias">GeometryType</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/CommonEditGeometryOptions.html" class="tsd-signature-type tsd-kind-interface">CommonEditGeometryOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#creategeometry-1" 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></div><div class="tsd-description"><code class="tsd-tag">Embed</code><div class="tsd-comment tsd-typography"><p>Create a geometry.</p>
|
|
66
80
|
<p><em>Note:</em> Under the hood, creating a geometry is similar to editing a geometry.
|
|
67
81
|
That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
68
82
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">backgroundMapView</span>: <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a></span><div class="tsd-comment tsd-typography"><p>The workbook map view in the background</p>
|
|
69
83
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">geometryType</span>: <a href="../types/GeometryType.html" class="tsd-signature-type tsd-kind-type-alias">GeometryType</a></span><div class="tsd-comment tsd-typography"><p>The geometry type</p>
|
|
70
84
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">__namedParameters</span>: <a href="../interfaces/CommonEditGeometryOptions.html" class="tsd-signature-type tsd-kind-interface">CommonEditGeometryOptions</a></span></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-2" class="tsd-anchor"></a>Throws<a href="#throws-2" 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>For invalid arguments</p>
|
|
71
85
|
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link"><a id="fires-2" class="tsd-anchor"></a>Fires<a href="#fires-2" 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><ul>
|
|
86
|
+
<li><a href="../types/CadenzaChangeExtentEvent.html" class="tsd-kind-type-alias">CadenzaChangeExtentEvent</a></li>
|
|
87
|
+
<li><a href="../types/CadenzaChangeSelectionEvent.html" class="tsd-kind-type-alias">CadenzaChangeSelectionEvent</a></li>
|
|
72
88
|
<li><a href="../types/CadenzaEditGeometryUpdateEvent.html" class="tsd-kind-type-alias">CadenzaEditGeometryUpdateEvent</a></li>
|
|
73
89
|
<li><a href="../types/CadenzaEditGeometryOkEvent.html" class="tsd-kind-type-alias">CadenzaEditGeometryOkEvent</a></li>
|
|
74
90
|
<li><a href="../types/CadenzaEditGeometryCancelEvent.html" class="tsd-kind-type-alias">CadenzaEditGeometryCancelEvent</a></li>
|
|
75
91
|
</ul>
|
|
76
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
92
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L703">src/cadenza.js:703</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="destroy" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>destroy</span><a href="#destroy" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="destroy-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">destroy</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#destroy-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Remove all subscriptions.</p>
|
|
77
93
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-see"><h4 class="tsd-anchor-link"><a id="see" class="tsd-anchor"></a>See<a href="#see" 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><a href="CadenzaClient.html#on" class="tsd-kind-method">CadenzaClient#on</a></p>
|
|
78
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
94
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L1258">src/cadenza.js:1258</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="downloaddata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>download<wbr/>Data</span><a href="#downloaddata" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="downloaddata-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">downloadData</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">:</span> <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">dataType</span><span class="tsd-signature-symbol">:</span> <a href="../types/DataType.html" class="tsd-signature-type tsd-kind-type-alias">DataType</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">fileName</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?:</span> <a href="../types/FilterVariables.html" class="tsd-signature-type tsd-kind-type-alias">FilterVariables</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">parts</span><span class="tsd-signature-symbol">?:</span> <a href="../types/TablePart.html" class="tsd-signature-type tsd-kind-type-alias">TablePart</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#downloaddata-1" 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></div><div class="tsd-description"><code class="tsd-tag">Server</code><div class="tsd-comment tsd-typography"><p>Download data from a workbook view.</p>
|
|
79
95
|
<p><em>Note:</em> The file name, if not provided, is generated from the name of the workbook view and the current date.</p>
|
|
80
96
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">source</span>: <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a></span><div class="tsd-comment tsd-typography"><p>The workbook view to fetch data from.</p>
|
|
81
97
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">dataType</span>: <a href="../types/DataType.html" class="tsd-signature-type tsd-kind-type-alias">DataType</a></span><div class="tsd-comment tsd-typography"><p>The data type you want to get back from the server.
|
|
@@ -87,19 +103,21 @@ of "JasperReports report".</p>
|
|
|
87
103
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?: </span><a href="../types/FilterVariables.html" class="tsd-signature-type tsd-kind-type-alias">FilterVariables</a></h5><div class="tsd-comment tsd-typography"><p>Filter variables</p>
|
|
88
104
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">parts</span><span class="tsd-signature-symbol">?: </span><a href="../types/TablePart.html" class="tsd-signature-type tsd-kind-type-alias">TablePart</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>Table parts to export; If not specified, all parts are exported.</p>
|
|
89
105
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-3" class="tsd-anchor"></a>Throws<a href="#throws-3" 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>For invalid arguments</p>
|
|
90
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
106
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L1472">src/cadenza.js:1472</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="editgeometry" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>edit<wbr/>Geometry</span><a href="#editgeometry" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="editgeometry-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">editGeometry</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">backgroundMapView</span><span class="tsd-signature-symbol">:</span> <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">geometry</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Geometry.html" class="tsd-signature-type tsd-kind-interface">Geometry</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/CommonEditGeometryOptions.html" class="tsd-signature-type tsd-kind-interface">CommonEditGeometryOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#editgeometry-1" 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></div><div class="tsd-description"><code class="tsd-tag">Embed</code><div class="tsd-comment tsd-typography"><p>Edit a geometry.</p>
|
|
91
107
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">backgroundMapView</span>: <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a></span><div class="tsd-comment tsd-typography"><p>The workbook map view in the background</p>
|
|
92
108
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">geometry</span>: <a href="../interfaces/Geometry.html" class="tsd-signature-type tsd-kind-interface">Geometry</a></span><div class="tsd-comment tsd-typography"><p>The geometry to edit</p>
|
|
93
109
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">__namedParameters</span>: <a href="../interfaces/CommonEditGeometryOptions.html" class="tsd-signature-type tsd-kind-interface">CommonEditGeometryOptions</a></span></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>A <code>Promise</code> for when the iframe is loaded</p>
|
|
94
110
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-4" class="tsd-anchor"></a>Throws<a href="#throws-4" 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>For invalid arguments</p>
|
|
95
111
|
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link"><a id="fires-3" class="tsd-anchor"></a>Fires<a href="#fires-3" 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><ul>
|
|
112
|
+
<li><a href="../types/CadenzaChangeExtentEvent.html" class="tsd-kind-type-alias">CadenzaChangeExtentEvent</a></li>
|
|
113
|
+
<li><a href="../types/CadenzaChangeSelectionEvent.html" class="tsd-kind-type-alias">CadenzaChangeSelectionEvent</a></li>
|
|
96
114
|
<li><a href="../types/CadenzaEditGeometryUpdateEvent.html" class="tsd-kind-type-alias">CadenzaEditGeometryUpdateEvent</a></li>
|
|
97
115
|
<li><a href="../types/CadenzaEditGeometryOkEvent.html" class="tsd-kind-type-alias">CadenzaEditGeometryOkEvent</a></li>
|
|
98
116
|
<li><a href="../types/CadenzaEditGeometryCancelEvent.html" class="tsd-kind-type-alias">CadenzaEditGeometryCancelEvent</a></li>
|
|
99
117
|
</ul>
|
|
100
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
118
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L759">src/cadenza.js:759</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="expandnavigator" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>expand<wbr/>Navigator</span><a href="#expandnavigator" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="expandnavigator-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">expandNavigator</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">expanded</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#expandnavigator-1" 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></div><div class="tsd-description"><code class="tsd-tag">Post Message</code><div class="tsd-comment tsd-typography"><p>Expand/collapse the navigator.</p>
|
|
101
119
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">expanded</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>The expansion state of the navigator</p>
|
|
102
|
-
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = true</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
120
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = true</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L567">src/cadenza.js:567</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="fetchareaintersections" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>fetch<wbr/>Area<wbr/>Intersections</span><a href="#fetchareaintersections" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="fetchareaintersections-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetchAreaIntersections</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">:</span> <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">layerPath</span><span class="tsd-signature-symbol">:</span> (<span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/WorkbookLayerPath.html" class="tsd-signature-type tsd-kind-type-alias">WorkbookLayerPath</a>)<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">geometry</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Geometry.html" class="tsd-signature-type tsd-kind-interface">Geometry</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">buffer</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Distance.html" class="tsd-signature-type tsd-kind-interface">Distance</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">includeGeometryValidationReport</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">useAutoCorrection</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">useMapSrs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AreaIntersectionsResult.html" class="tsd-signature-type tsd-kind-interface">AreaIntersectionsResult</a> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/ProblemDetails.html" class="tsd-signature-type tsd-kind-interface">ProblemDetails</a><span class="tsd-signature-symbol">></span><a href="#fetchareaintersections-1" 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></div><div class="tsd-description"><code class="tsd-tag">Server</code><div class="tsd-comment tsd-typography"><p>Fetch the intersection areas from a workbook map view layer in JSON format for a given area.</p>
|
|
103
121
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">source</span>: <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a></span><div class="tsd-comment tsd-typography"><p>The workbook view to fetch object info from.</p>
|
|
104
122
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">layerPath</span>: (<span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/WorkbookLayerPath.html" class="tsd-signature-type tsd-kind-type-alias">WorkbookLayerPath</a>)<span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Layer path to identify the layer
|
|
105
123
|
(identified using layer paths or print names)</p>
|
|
@@ -111,7 +129,7 @@ of "JasperReports report".</p>
|
|
|
111
129
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">useAutoCorrection</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Enables the automatic correction of invalid geometries</p>
|
|
112
130
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">useMapSrs</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>The intersection geometry and the result geometries are in the map's SRS (otherwise EPSG:4326 is assumed)</p>
|
|
113
131
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/AreaIntersectionsResult.html" class="tsd-signature-type tsd-kind-interface">AreaIntersectionsResult</a> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/ProblemDetails.html" class="tsd-signature-type tsd-kind-interface">ProblemDetails</a><span class="tsd-signature-symbol">></span></h4><p>A <code>Promise</code> for the fetch response</p>
|
|
114
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
132
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L1384">src/cadenza.js:1384</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="fetchdata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>fetch<wbr/>Data</span><a href="#fetchdata" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="fetchdata-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetchData</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">:</span> <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">dataType</span><span class="tsd-signature-symbol">:</span> <a href="../types/DataType.html" class="tsd-signature-type tsd-kind-type-alias">DataType</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?:</span> <a href="../types/FilterVariables.html" class="tsd-signature-type tsd-kind-type-alias">FilterVariables</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">parts</span><span class="tsd-signature-symbol">?:</span> <a href="../types/TablePart.html" class="tsd-signature-type tsd-kind-type-alias">TablePart</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span><a href="#fetchdata-1" 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></div><div class="tsd-description"><code class="tsd-tag">Server</code><div class="tsd-comment tsd-typography"><p>Fetch data from a workbook view.</p>
|
|
115
133
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">source</span>: <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a></span><div class="tsd-comment tsd-typography"><p>The workbook view to fetch data from.</p>
|
|
116
134
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">dataType</span>: <a href="../types/DataType.html" class="tsd-signature-type tsd-kind-type-alias">DataType</a></span><div class="tsd-comment tsd-typography"><p>The data type you want to get back from the server.
|
|
117
135
|
Currently, <code>"csv"</code>, <code>"excel"</code> and <code>"json"</code> are supported for embedding targets of type view with a view type of
|
|
@@ -123,7 +141,7 @@ of "JasperReports report".</p>
|
|
|
123
141
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AbortSignal</span></h5><div class="tsd-comment tsd-typography"><p>A signal to abort the data fetching</p>
|
|
124
142
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">Response</span><span class="tsd-signature-symbol">></span></h4><p>A <code>Promise</code> for the fetch response</p>
|
|
125
143
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-5" class="tsd-anchor"></a>Throws<a href="#throws-5" 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>For invalid arguments</p>
|
|
126
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
144
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L1323">src/cadenza.js:1323</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="fetchobjectinfo" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>fetch<wbr/>Object<wbr/>Info</span><a href="#fetchobjectinfo" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="fetchobjectinfo-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">fetchObjectInfo</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">:</span> <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">layerPath</span><span class="tsd-signature-symbol">:</span> (<span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/WorkbookLayerPath.html" class="tsd-signature-type tsd-kind-type-alias">WorkbookLayerPath</a>)<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">objectIds</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?:</span> <a href="../types/FilterVariables.html" class="tsd-signature-type tsd-kind-type-alias">FilterVariables</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">fullGeometries</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">useMapSrs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/FeatureCollection.html" class="tsd-signature-type tsd-kind-interface">FeatureCollection</a><span class="tsd-signature-symbol">></span><a href="#fetchobjectinfo-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Fetch object info from a workbook map view.</p>
|
|
127
145
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">source</span>: <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a></span><div class="tsd-comment tsd-typography"><p>The workbook view to fetch object info from.</p>
|
|
128
146
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">layerPath</span>: (<span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/WorkbookLayerPath.html" class="tsd-signature-type tsd-kind-type-alias">WorkbookLayerPath</a>)<span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>Layer path to identify the layer
|
|
129
147
|
(identified using layer paths or print names)</p>
|
|
@@ -135,23 +153,28 @@ of "JasperReports report".</p>
|
|
|
135
153
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">useMapSrs</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Use the map SRS instead of WGS84</p>
|
|
136
154
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/FeatureCollection.html" class="tsd-signature-type tsd-kind-interface">FeatureCollection</a><span class="tsd-signature-symbol">></span></h4><p>A <code>Promise</code> for the fetch response</p>
|
|
137
155
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-6" class="tsd-anchor"></a>Throws<a href="#throws-6" 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>For invalid arguments</p>
|
|
138
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
156
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L1345">src/cadenza.js:1345</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="getdata" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Data</span><a href="#getdata" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="getdata-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getData</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CadenzaClient.html#getdatat">T</a> <span class="tsd-signature-keyword">extends</span> <a href="../types/DataType.html" class="tsd-signature-type tsd-kind-type-alias">DataType</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">dataType</span><span class="tsd-signature-symbol">:</span> <a href="../types/DataType.html" class="tsd-signature-type tsd-kind-type-alias">DataType</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">height</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">withScale</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CadenzaClient.html#getdatat">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">"png"</span> <span class="tsd-signature-symbol">?</span> <span class="tsd-signature-type">Blob</span> <span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></span><a href="#getdata-1" 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></div><div class="tsd-description"><code class="tsd-tag">Post Message</code><div class="tsd-comment tsd-typography"><p>Get data from the currently shown workbook view.</p>
|
|
139
157
|
<p>Currently, only map views are supported.</p>
|
|
140
158
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="getdatat" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">T</span><span class="tsd-signature-keyword"> extends </span><a href="../types/DataType.html" class="tsd-signature-type tsd-kind-type-alias">DataType</a></span><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">dataType</span>: <a href="../types/DataType.html" class="tsd-signature-type tsd-kind-type-alias">DataType</a></span><div class="tsd-comment tsd-typography"><p>The requested data type. Currently, only <code>"png"</code> is</p>
|
|
141
159
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">height</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">withScale</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Options</p>
|
|
142
160
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">height</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The height of the resulting map image in px.</p>
|
|
143
161
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">width</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The width of the resulting map image in px.</p>
|
|
144
162
|
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">withScale</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>Whether to show the scale line and the scale on the map image.</p>
|
|
145
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CadenzaClient.html#getdatat">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">"png"</span> <span class="tsd-signature-symbol">?</span> <span class="tsd-signature-type">Blob</span> <span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
163
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CadenzaClient.html#getdatat">T</a> <span class="tsd-signature-keyword">extends</span> <span class="tsd-signature-type">"png"</span> <span class="tsd-signature-symbol">?</span> <span class="tsd-signature-type">Blob</span> <span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L586">src/cadenza.js:586</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="on" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>on</span><a href="#on" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="on-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">on</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CadenzaClient.html#ontype">TYPE</a> <span class="tsd-signature-keyword">extends</span> <a href="../types/CadenzaEventType.html" class="tsd-signature-type tsd-kind-type-alias">CadenzaEventType</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">:</span> <a class="tsd-signature-type tsd-kind-type-parameter" href="CadenzaClient.html#ontype">TYPE</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">subscriber</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/CadenzaEvent.html" class="tsd-signature-type tsd-kind-interface">CadenzaEvent</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CadenzaClient.html#ontype">TYPE</a><span class="tsd-signature-symbol">,</span> <a href="../types/CadenzaEventByType.html" class="tsd-signature-type tsd-kind-type-alias">CadenzaEventByType</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CadenzaClient.html#ontype">TYPE</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"detail"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span><a href="#on-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Subscribe to a <code>postMessage()</code> event.</p>
|
|
146
164
|
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="ontype" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">TYPE</span><span class="tsd-signature-keyword"> extends </span><a href="../types/CadenzaEventType.html" class="tsd-signature-type tsd-kind-type-alias">CadenzaEventType</a></span><div class="tsd-comment tsd-typography"></div></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">type</span>: <a class="tsd-signature-type tsd-kind-type-parameter" href="CadenzaClient.html#ontype">TYPE</a></span><div class="tsd-comment tsd-typography"><p>The event type</p>
|
|
147
165
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">subscriber</span>: <span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/CadenzaEvent.html" class="tsd-signature-type tsd-kind-interface">CadenzaEvent</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CadenzaClient.html#ontype">TYPE</a><span class="tsd-signature-symbol">,</span> <a href="../types/CadenzaEventByType.html" class="tsd-signature-type tsd-kind-type-alias">CadenzaEventByType</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="CadenzaClient.html#ontype">TYPE</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">"detail"</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></span><div class="tsd-comment tsd-typography"><p>The subscriber function</p>
|
|
148
166
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></h4><p>An unsubscribe function</p>
|
|
149
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
167
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L1185">src/cadenza.js:1185</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="reload" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>reload</span><a href="#reload" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="reload-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">reload</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">invalidateCaches</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#reload-1" 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></div><div class="tsd-description"><code class="tsd-tag">Post Message</code><div class="tsd-comment tsd-typography"><p>Reload the views of a worksheet.</p>
|
|
150
168
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">invalidateCaches</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Options</p>
|
|
151
169
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">invalidateCaches</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><p>When true, caches will be invalidated for objecttypes used
|
|
152
170
|
in the worksheet</p>
|
|
153
171
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>A <code>Promise</code> which resolves when the views of the worksheet have finished reloading</p>
|
|
154
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
172
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L469">src/cadenza.js:469</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="removeselection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>remove<wbr/>Selection</span><a href="#removeselection" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="removeselection-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">removeSelection</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">layer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/WorkbookLayerPath.html" class="tsd-signature-type tsd-kind-type-alias">WorkbookLayerPath</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">values</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">extentStrategy</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/GeometryExtentStrategy.html" class="tsd-signature-type tsd-kind-interface">GeometryExtentStrategy</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#removeselection-1" 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></div><div class="tsd-description"><code class="tsd-tag">Post Message</code><div class="tsd-comment tsd-typography"><p>Remove from the selection in the currently shown workbook map view.</p>
|
|
173
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">layer</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/WorkbookLayerPath.html" class="tsd-signature-type tsd-kind-type-alias">WorkbookLayerPath</a></span><div class="tsd-comment tsd-typography"><p>The data view layer to change the selection in</p>
|
|
174
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">values</span>: <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The IDs of the objects to unselect</p>
|
|
175
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">extentStrategy</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/GeometryExtentStrategy.html" class="tsd-signature-type tsd-kind-interface">GeometryExtentStrategy</a> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">extentStrategy</span><span class="tsd-signature-symbol">?: </span><a href="../interfaces/GeometryExtentStrategy.html" class="tsd-signature-type tsd-kind-interface">GeometryExtentStrategy</a></h5><div class="tsd-comment tsd-typography"><p>Strategy to define the new map extent</p>
|
|
176
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>A <code>Promise</code> for when the selection was changed.</p>
|
|
177
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L675">src/cadenza.js:675</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="selectobjects" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>select<wbr/>Objects</span><a href="#selectobjects" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="selectobjects-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">selectObjects</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">backgroundMapView</span><span class="tsd-signature-symbol">:</span> <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">disabledUiFeatures</span><span class="tsd-signature-symbol">?:</span> <a href="../types/UiFeature.html" class="tsd-signature-type tsd-kind-type-alias">UiFeature</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">extentStrategy</span><span class="tsd-signature-symbol">?:</span> <a href="../types/ExtentStrategy.html" class="tsd-signature-type tsd-kind-type-alias">ExtentStrategy</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?:</span> <a href="../types/FilterVariables.html" class="tsd-signature-type tsd-kind-type-alias">FilterVariables</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">layers</span><span class="tsd-signature-symbol">?:</span> (<span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/WorkbookLayerPath.html" class="tsd-signature-type tsd-kind-type-alias">WorkbookLayerPath</a>)<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">operationMode</span><span class="tsd-signature-symbol">?:</span> <a href="../types/OperationMode.html" class="tsd-signature-type tsd-kind-type-alias">OperationMode</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">useMapSrs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#selectobjects-1" 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></div><div class="tsd-description"><code class="tsd-tag">Embed</code><div class="tsd-comment tsd-typography"><p>Select objects in a workbook map.</p>
|
|
155
178
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">backgroundMapView</span>: <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a></span><div class="tsd-comment tsd-typography"><p>The workbook map view</p>
|
|
156
179
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">disabledUiFeatures</span><span class="tsd-signature-symbol">?:</span> <a href="../types/UiFeature.html" class="tsd-signature-type tsd-kind-type-alias">UiFeature</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">extentStrategy</span><span class="tsd-signature-symbol">?:</span> <a href="../types/ExtentStrategy.html" class="tsd-signature-type tsd-kind-type-alias">ExtentStrategy</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?:</span> <a href="../types/FilterVariables.html" class="tsd-signature-type tsd-kind-type-alias">FilterVariables</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">layers</span><span class="tsd-signature-symbol">?:</span> (<span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/WorkbookLayerPath.html" class="tsd-signature-type tsd-kind-type-alias">WorkbookLayerPath</a>)<span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">operationMode</span><span class="tsd-signature-symbol">?:</span> <a href="../types/OperationMode.html" class="tsd-signature-type tsd-kind-type-alias">OperationMode</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">useMapSrs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Options</p>
|
|
157
180
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">disabledUiFeatures</span><span class="tsd-signature-symbol">?: </span><a href="../types/UiFeature.html" class="tsd-signature-type tsd-kind-type-alias">UiFeature</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>Cadenza UI features to disable</p>
|
|
@@ -169,14 +192,33 @@ in the worksheet</p>
|
|
|
169
192
|
<li><a href="../types/CadenzaSelectObjectsOkEvent.html" class="tsd-kind-type-alias">CadenzaSelectObjectsOkEvent</a></li>
|
|
170
193
|
<li><a href="../types/CadenzaSelectObjectsCancelEvent.html" class="tsd-kind-type-alias">CadenzaSelectObjectsCancelEvent</a></li>
|
|
171
194
|
</ul>
|
|
172
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
195
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L1042">src/cadenza.js:1042</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setcustomvalidity" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Custom<wbr/>Validity</span><a href="#setcustomvalidity" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="setcustomvalidity-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setCustomValidity</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">message</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">type</span><span class="tsd-signature-symbol">?:</span> <a href="../types/CustomValidityType.html" class="tsd-signature-type tsd-kind-type-alias">CustomValidityType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span><a href="#setcustomvalidity-1" 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></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Set the custom validation status of the geometry editor dialog ( <a href="CadenzaClient.html#creategeometry" class="tsd-kind-method">createGeometry</a>, <a href="CadenzaClient.html#editgeometry" class="tsd-kind-method">editGeometry</a>, <a href="CadenzaClient.html#batchcreategeometry" class="tsd-kind-method">batchCreateGeometry</a>, <a href="CadenzaClient.html#batcheditgeometry" class="tsd-kind-method">batchEditGeometry</a> )
|
|
196
|
+
or the <a href="CadenzaClient.html#selectobjects" class="tsd-kind-method">selectObjects</a> dialog in addition to the default validation status (including errors and warnings).</p>
|
|
197
|
+
<p>Behavior:</p>
|
|
198
|
+
<ul>
|
|
199
|
+
<li>When the custom validation status is of type 'error', the dialog submission is blocked.</li>
|
|
200
|
+
<li>If a custom validation status is already set, it will be overwritten.</li>
|
|
201
|
+
<li>Passing '' (an empty string) as the message parameter resets the custom validation status, which means no custom validation status is displayed.</li>
|
|
202
|
+
</ul>
|
|
203
|
+
<p>If neither the geometry editor nor <a href="CadenzaClient.html#selectobjects" class="tsd-kind-method">selectObjects</a> is started, the method call has no effect.</p>
|
|
177
204
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">message</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The message to show in the dialog</p>
|
|
178
205
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">type</span>: <a href="../types/CustomValidityType.html" class="tsd-signature-type tsd-kind-type-alias">CustomValidityType</a><span class="tsd-signature-symbol"> = 'error'</span></span><div class="tsd-comment tsd-typography"><p>The type of message (defaults to 'error')</p>
|
|
179
|
-
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
206
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L1013">src/cadenza.js:1013</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setfilter" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Filter</span><a href="#setfilter" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="setfilter-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setFilter</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">filter</span><span class="tsd-signature-symbol">:</span> <a href="../types/FilterVariables.html" class="tsd-signature-type tsd-kind-type-alias">FilterVariables</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#setfilter-1" 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></div><div class="tsd-description"><code class="tsd-tag">Post Message</code><div class="tsd-comment tsd-typography"><p>Set filter variables in the currently shown workbook.</p>
|
|
207
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">filter</span>: <a href="../types/FilterVariables.html" class="tsd-signature-type tsd-kind-type-alias">FilterVariables</a></span><div class="tsd-comment tsd-typography"><p>The variable values</p>
|
|
208
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>A <code>Promise</code> for when the filter variables were set.</p>
|
|
209
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L599">src/cadenza.js:599</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setlayervisibility" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Layer<wbr/>Visibility</span><a href="#setlayervisibility" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="setlayervisibility-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setLayerVisibility</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">layer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/WorkbookLayerPath.html" class="tsd-signature-type tsd-kind-type-alias">WorkbookLayerPath</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">visible</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#setlayervisibility-1" 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></div><div class="tsd-description"><code class="tsd-tag">Post Message</code><div class="tsd-comment tsd-typography"><p>Set the visibility of a layer in the currently shown workbook map view.</p>
|
|
210
|
+
<p>When making a layer visible, its ancestors will be made visible, too.
|
|
211
|
+
When hiding a layer, the ancestors are not affected.</p>
|
|
212
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">layer</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/WorkbookLayerPath.html" class="tsd-signature-type tsd-kind-type-alias">WorkbookLayerPath</a></span><div class="tsd-comment tsd-typography"><p>The layer to show or hide
|
|
213
|
+
(identified using a layer path or a print name)</p>
|
|
214
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">visible</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>The visibility state of the layer</p>
|
|
215
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>A <code>Promise</code> for when the layer visibility was set.</p>
|
|
216
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L617">src/cadenza.js:617</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="setselection" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>set<wbr/>Selection</span><a href="#setselection" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="setselection-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">setSelection</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">layer</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/WorkbookLayerPath.html" class="tsd-signature-type tsd-kind-type-alias">WorkbookLayerPath</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">values</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">extentStrategy</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/GeometryExtentStrategy.html" class="tsd-signature-type tsd-kind-interface">GeometryExtentStrategy</a> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#setselection-1" 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></div><div class="tsd-description"><code class="tsd-tag">Post Message</code><div class="tsd-comment tsd-typography"><p>Set the selection in the currently shown workbook map view.</p>
|
|
217
|
+
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">layer</span>: <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <a href="../types/WorkbookLayerPath.html" class="tsd-signature-type tsd-kind-type-alias">WorkbookLayerPath</a></span><div class="tsd-comment tsd-typography"><p>The data view layer to set the selection in</p>
|
|
218
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">values</span>: <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>The IDs of the objects to select</p>
|
|
219
|
+
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">extentStrategy</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/GeometryExtentStrategy.html" class="tsd-signature-type tsd-kind-interface">GeometryExtentStrategy</a> <span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">extentStrategy</span><span class="tsd-signature-symbol">?: </span><a href="../interfaces/GeometryExtentStrategy.html" class="tsd-signature-type tsd-kind-interface">GeometryExtentStrategy</a></h5><div class="tsd-comment tsd-typography"><p>Strategy to define the new map extent</p>
|
|
220
|
+
</div><div class="tsd-comment tsd-typography"></div></li></ul></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>A <code>Promise</code> for when the selection was set.</p>
|
|
221
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L635">src/cadenza.js:635</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="show" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>show</span><a href="#show" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="show-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">show</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">:</span> <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/PageSource.html" class="tsd-signature-type tsd-kind-interface">PageSource</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">dataType</span><span class="tsd-signature-symbol">?:</span> <a href="../types/DataType.html" class="tsd-signature-type tsd-kind-type-alias">DataType</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">disabledUiFeatures</span><span class="tsd-signature-symbol">?:</span> <a href="../types/UiFeature.html" class="tsd-signature-type tsd-kind-type-alias">UiFeature</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">expandNavigator</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?:</span> <a href="../types/FilterVariables.html" class="tsd-signature-type tsd-kind-type-alias">FilterVariables</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">hideMainHeaderAndFooter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">hideWorkbookToolBar</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">highlightGlobalId</span><span class="tsd-signature-symbol">?:</span> <a href="../types/GlobalId.html" class="tsd-signature-type tsd-kind-type-alias">GlobalId</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">labelSet</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">layout</span><span class="tsd-signature-symbol">?:</span> <a href="../types/Layout.html" class="tsd-signature-type tsd-kind-type-alias">Layout</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">operationMode</span><span class="tsd-signature-symbol">?:</span> <a href="../types/OperationMode.html" class="tsd-signature-type tsd-kind-type-alias">OperationMode</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">worksheetPlaceholders</span><span class="tsd-signature-symbol">?:</span> <a href="../types/WorksheetPlaceholders.html" class="tsd-signature-type tsd-kind-type-alias">WorksheetPlaceholders</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#show-1" 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></div><div class="tsd-description"><code class="tsd-tag">Embed</code><div class="tsd-comment tsd-typography"><p>Show a page, workbook, worksheet or workbook view in an iframe.</p>
|
|
180
222
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">source</span>: <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/PageSource.html" class="tsd-signature-type tsd-kind-interface">PageSource</a></span><div class="tsd-comment tsd-typography"><p>The source to show</p>
|
|
181
223
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">dataType</span><span class="tsd-signature-symbol">?:</span> <a href="../types/DataType.html" class="tsd-signature-type tsd-kind-type-alias">DataType</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">disabledUiFeatures</span><span class="tsd-signature-symbol">?:</span> <a href="../types/UiFeature.html" class="tsd-signature-type tsd-kind-type-alias">UiFeature</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">expandNavigator</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?:</span> <a href="../types/FilterVariables.html" class="tsd-signature-type tsd-kind-type-alias">FilterVariables</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">hideMainHeaderAndFooter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">hideWorkbookToolBar</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">highlightGlobalId</span><span class="tsd-signature-symbol">?:</span> <a href="../types/GlobalId.html" class="tsd-signature-type tsd-kind-type-alias">GlobalId</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">labelSet</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">layout</span><span class="tsd-signature-symbol">?:</span> <a href="../types/Layout.html" class="tsd-signature-type tsd-kind-type-alias">Layout</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">operationMode</span><span class="tsd-signature-symbol">?:</span> <a href="../types/OperationMode.html" class="tsd-signature-type tsd-kind-type-alias">OperationMode</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">worksheetPlaceholders</span><span class="tsd-signature-symbol">?:</span> <a href="../types/WorksheetPlaceholders.html" class="tsd-signature-type tsd-kind-type-alias">WorksheetPlaceholders</a><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">dataType</span><span class="tsd-signature-symbol">?: </span><a href="../types/DataType.html" class="tsd-signature-type tsd-kind-type-alias">DataType</a></h5><div class="tsd-comment tsd-typography"><p>Set to 'pdf' for embedding targets of type report and of views with view
|
|
182
224
|
type of "JasperReports report" to show the generated report PDF directly (without any Cadenza headers or
|
|
@@ -198,7 +240,7 @@ footers).</p>
|
|
|
198
240
|
<li><a href="../types/CadenzaDrillThroughEvent.html" class="tsd-kind-type-alias">CadenzaDrillThroughEvent</a></li>
|
|
199
241
|
<li><a href="../types/CadenzaActionEvent.html" class="tsd-kind-type-alias">CadenzaActionEvent</a></li>
|
|
200
242
|
</ul>
|
|
201
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
243
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L416">src/cadenza.js:416</a></li></ul></aside></div></li></ul></section><section class="tsd-panel tsd-member"><a id="showmap" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>show<wbr/>Map</span><a href="#showmap" 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><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="showmap-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">showMap</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">mapView</span><span class="tsd-signature-symbol">:</span> <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">__namedParameters</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">additionalLayers</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/LayerDefinition.html" class="tsd-signature-type tsd-kind-interface">LayerDefinition</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">disabledUiFeatures</span><span class="tsd-signature-symbol">?:</span> <a href="../types/UiFeature.html" class="tsd-signature-type tsd-kind-type-alias">UiFeature</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">expandNavigator</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">extentStrategy</span><span class="tsd-signature-symbol">?:</span> <a href="../types/ExtentStrategy.html" class="tsd-signature-type tsd-kind-type-alias">ExtentStrategy</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?:</span> <a href="../types/FilterVariables.html" class="tsd-signature-type tsd-kind-type-alias">FilterVariables</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">geometry</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Geometry.html" class="tsd-signature-type tsd-kind-interface">Geometry</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">hideMainHeaderAndFooter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">hideWorkbookToolBar</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">highlightGlobalId</span><span class="tsd-signature-symbol">?:</span> <a href="../types/GlobalId.html" class="tsd-signature-type tsd-kind-type-alias">GlobalId</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">operationMode</span><span class="tsd-signature-symbol">?:</span> <a href="../types/OperationMode.html" class="tsd-signature-type tsd-kind-type-alias">OperationMode</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">useMapSrs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#showmap-1" 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></div><div class="tsd-description"><code class="tsd-tag">Embed</code><div class="tsd-comment tsd-typography"><p>Show a workbook map view in an iframe.</p>
|
|
202
244
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">mapView</span>: <a href="../types/EmbeddingTargetId.html" class="tsd-signature-type tsd-kind-type-alias">EmbeddingTargetId</a></span><div class="tsd-comment tsd-typography"><p>The workbook map view to show</p>
|
|
203
245
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">__namedParameters</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">additionalLayers</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/LayerDefinition.html" class="tsd-signature-type tsd-kind-interface">LayerDefinition</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">disabledUiFeatures</span><span class="tsd-signature-symbol">?:</span> <a href="../types/UiFeature.html" class="tsd-signature-type tsd-kind-type-alias">UiFeature</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">expandNavigator</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">extentStrategy</span><span class="tsd-signature-symbol">?:</span> <a href="../types/ExtentStrategy.html" class="tsd-signature-type tsd-kind-type-alias">ExtentStrategy</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?:</span> <a href="../types/FilterVariables.html" class="tsd-signature-type tsd-kind-type-alias">FilterVariables</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">geometry</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Geometry.html" class="tsd-signature-type tsd-kind-interface">Geometry</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">hideMainHeaderAndFooter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">hideWorkbookToolBar</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">highlightGlobalId</span><span class="tsd-signature-symbol">?:</span> <a href="../types/GlobalId.html" class="tsd-signature-type tsd-kind-type-alias">GlobalId</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">operationMode</span><span class="tsd-signature-symbol">?:</span> <a href="../types/OperationMode.html" class="tsd-signature-type tsd-kind-type-alias">OperationMode</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">AbortSignal</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">useMapSrs</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>Options</p>
|
|
204
246
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">additionalLayers</span><span class="tsd-signature-symbol">?: </span><a href="../interfaces/LayerDefinition.html" class="tsd-signature-type tsd-kind-interface">LayerDefinition</a><span class="tsd-signature-symbol">[]</span></h5><div class="tsd-comment tsd-typography"><p>Layer definitions to be imported and shown in the background, as a basis for the drawing. IMPORTANT: The Cadenza referenced with <code>cadenzaClient</code> must be configured to support the import of GeoJSON, and the (system) privileges of the corresponding user must also be set in such a way that the import of GeoJSON is possible.</p>
|
|
@@ -216,7 +258,9 @@ footers).</p>
|
|
|
216
258
|
</div><div class="tsd-comment tsd-typography"></div></li></ul></li><li><span><span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>A <code>Promise</code> for when the iframe is loaded</p>
|
|
217
259
|
<div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link"><a id="throws-9" class="tsd-anchor"></a>Throws<a href="#throws-9" 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>For invalid arguments</p>
|
|
218
260
|
</div><div class="tsd-tag-fires"><h4 class="tsd-anchor-link"><a id="fires-6" class="tsd-anchor"></a>Fires<a href="#fires-6" 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><ul>
|
|
261
|
+
<li><a href="../types/CadenzaChangeExtentEvent.html" class="tsd-kind-type-alias">CadenzaChangeExtentEvent</a></li>
|
|
262
|
+
<li><a href="../types/CadenzaChangeSelectionEvent.html" class="tsd-kind-type-alias">CadenzaChangeSelectionEvent</a></li>
|
|
219
263
|
<li><a href="../types/CadenzaDrillThroughEvent.html" class="tsd-kind-type-alias">CadenzaDrillThroughEvent</a></li>
|
|
220
264
|
<li><a href="../types/CadenzaActionEvent.html" class="tsd-kind-type-alias">CadenzaActionEvent</a></li>
|
|
221
265
|
</ul>
|
|
222
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
266
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L510">src/cadenza.js:510</a></li></ul></aside></div></li></ul></section></section></details></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"><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary><div><a href="#baseurl" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>base<wbr/>Url</span></a><a href="#iframe" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>iframe</span></a></div></details><details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary><div><a href="#addselection" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>add<wbr/>Selection</span></a><a href="#batchcreategeometry" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>batch<wbr/>Create<wbr/>Geometry</span></a><a href="#batcheditgeometry" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>batch<wbr/>Edit<wbr/>Geometry</span></a><a href="#closeme" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>close<wbr/>Me</span></a><a href="#creategeometry" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>create<wbr/>Geometry</span></a><a href="#destroy" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>destroy</span></a><a href="#downloaddata" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>download<wbr/>Data</span></a><a href="#editgeometry" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>edit<wbr/>Geometry</span></a><a href="#expandnavigator" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>expand<wbr/>Navigator</span></a><a href="#fetchareaintersections" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch<wbr/>Area<wbr/>Intersections</span></a><a href="#fetchdata" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch<wbr/>Data</span></a><a href="#fetchobjectinfo" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>fetch<wbr/>Object<wbr/>Info</span></a><a href="#getdata" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>get<wbr/>Data</span></a><a href="#on" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>on</span></a><a href="#reload" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>reload</span></a><a href="#removeselection" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>remove<wbr/>Selection</span></a><a href="#selectobjects" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>select<wbr/>Objects</span></a><a href="#setcustomvalidity" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Custom<wbr/>Validity</span></a><a href="#setfilter" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Filter</span></a><a href="#setlayervisibility" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Layer<wbr/>Visibility</span></a><a href="#setselection" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>set<wbr/>Selection</span></a><a href="#show" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>show</span></a><a href="#showmap" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>show<wbr/>Map</span></a></div></details></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.6.0</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>
|