@disy/cadenza.js 10.3.0 → 10.3.2
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 +8 -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 +23 -21
- package/apidoc/classes/CadenzaError.html +5 -5
- package/apidoc/functions/cadenza.html +4 -4
- package/apidoc/index.html +2 -2
- package/apidoc/interfaces/CadenzaClientOptions.html +5 -5
- package/apidoc/interfaces/CadenzaEvent.html +4 -4
- package/apidoc/interfaces/Distance.html +2 -2
- package/apidoc/interfaces/ExternalLinkKey.html +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/SnappingOptions.html +5 -0
- package/apidoc/interfaces/StaticExtentStrategy.html +4 -4
- package/apidoc/modules.html +1 -1
- package/apidoc/types/CadenzaActionEvent.html +2 -2
- package/apidoc/types/CadenzaChangeSelectionEvent.html +2 -2
- package/apidoc/types/CadenzaDrillThroughEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryCancelEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryOkEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryUpdateEvent.html +2 -2
- package/apidoc/types/CadenzaErrorEvent.html +2 -2
- package/apidoc/types/CadenzaEventByType.html +1 -1
- package/apidoc/types/CadenzaEventType.html +2 -2
- package/apidoc/types/CadenzaObjectInfoEvent.html +2 -2
- package/apidoc/types/CadenzaReloadEvent.html +2 -2
- package/apidoc/types/CadenzaSelectObjectsCancelEvent.html +2 -2
- package/apidoc/types/CadenzaSelectObjectsOkEvent.html +2 -2
- package/apidoc/types/Coordinate.html +2 -2
- package/apidoc/types/CustomValidityType.html +2 -2
- package/apidoc/types/DataType.html +2 -2
- package/apidoc/types/EmbeddingTargetId.html +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/LengthUnit.html +1 -1
- package/apidoc/types/OpaqueString.html +2 -2
- package/apidoc/types/OperationMode.html +2 -2
- package/apidoc/types/TablePart.html +2 -2
- package/apidoc/types/UiFeature.html +3 -2
- package/apidoc/types/WorkbookLayerPath.html +2 -2
- package/cadenza.d.ts +38 -23
- package/cadenza.js +40 -29
- package/package.json +1 -1
- package/sandbox.html +64 -21
|
@@ -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.3.
|
|
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.3.2</title><meta name="description" content="Documentation for Cadenza JS"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><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.3.2</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" 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>
|
|
@@ -18,7 +18,7 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
|
|
|
18
18
|
</ul>
|
|
19
19
|
</li>
|
|
20
20
|
</ul>
|
|
21
|
-
</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/
|
|
21
|
+
</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/037e35ae1a44ca6831ca9f8529a43366d8e6f89a/src/cadenza.js#L236">src/cadenza.js:236</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>
|
|
22
22
|
<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>
|
|
23
23
|
</div></section><section class="tsd-index-section"><h3 class="tsd-index-heading">Methods</h3><div class="tsd-index-list"><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>
|
|
24
24
|
<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>
|
|
@@ -36,14 +36,14 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
|
|
|
36
36
|
<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>
|
|
37
37
|
<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>
|
|
38
38
|
</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>
|
|
39
|
-
</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/
|
|
40
|
-
</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/
|
|
41
|
-
</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/
|
|
39
|
+
</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/037e35ae1a44ca6831ca9f8529a43366d8e6f89a/src/cadenza.js#L290">src/cadenza.js:290</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>
|
|
40
|
+
</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/037e35ae1a44ca6831ca9f8529a43366d8e6f89a/src/cadenza.js#L295">src/cadenza.js:295</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="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>
|
|
41
|
+
</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/037e35ae1a44ca6831ca9f8529a43366d8e6f89a/src/cadenza.js#L409">src/cadenza.js:409</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> <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">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">locationFinder</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">mapExtent</span><span class="tsd-signature-symbol">?:</span> <a href="../types/Extent.html" class="tsd-signature-type tsd-kind-type-alias">Extent</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">minScale</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">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">snapping</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/SnappingOptions.html" class="tsd-signature-type tsd-kind-interface">SnappingOptions</a><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="#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>
|
|
42
42
|
<p><em>Note:</em> Under the hood, creating a geometry is similar to editing a geometry.
|
|
43
43
|
That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
44
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">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>
|
|
45
45
|
</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>
|
|
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><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">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">locationFinder</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">mapExtent</span><span class="tsd-signature-symbol">?:</span> <a href="../types/Extent.html" class="tsd-signature-type tsd-kind-type-alias">Extent</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">minScale</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">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>
|
|
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><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">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">locationFinder</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">mapExtent</span><span class="tsd-signature-symbol">?:</span> <a href="../types/Extent.html" class="tsd-signature-type tsd-kind-type-alias">Extent</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">minScale</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">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">snapping</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/SnappingOptions.html" class="tsd-signature-type tsd-kind-interface">SnappingOptions</a><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>
|
|
47
47
|
</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.</p>
|
|
48
48
|
</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">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>
|
|
49
49
|
</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">extentStrategy</span><span class="tsd-signature-symbol">?: </span><a href="../types/ExtentStrategy.html" class="tsd-signature-type tsd-kind-type-alias">ExtentStrategy</a></h5><div class="tsd-comment tsd-typography"><p>Defines the initial map extent; If not given, Cadenza's default logic is used.</p>
|
|
@@ -53,6 +53,7 @@ That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
|
53
53
|
</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">minScale</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The minimum scale where the user should work on. A warning is shown when the map is zoomed out above the threshold.</p>
|
|
54
54
|
</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">operationMode</span><span class="tsd-signature-symbol">?: </span><a href="../types/OperationMode.html" class="tsd-signature-type tsd-kind-type-alias">OperationMode</a></h5><div class="tsd-comment tsd-typography"><p>The mode in which a workbook should be operated</p>
|
|
55
55
|
</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 iframe loading</p>
|
|
56
|
+
</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">snapping</span><span class="tsd-signature-symbol">?: </span><a href="../interfaces/SnappingOptions.html" class="tsd-signature-type tsd-kind-interface">SnappingOptions</a></h5><div class="tsd-comment tsd-typography"><p>Passing these options enables snapping</p>
|
|
56
57
|
</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>Whether the coordinates specified in other parameters are specified in the map's SRS and the created geometry should use the map's SRS (otherwise EPSG:4326 is assumed)</p>
|
|
57
58
|
</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>
|
|
58
59
|
<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>
|
|
@@ -61,9 +62,9 @@ That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
|
61
62
|
<li><a href="../types/CadenzaEditGeometryOkEvent.html" class="tsd-kind-type-alias">CadenzaEditGeometryOkEvent</a></li>
|
|
62
63
|
<li><a href="../types/CadenzaEditGeometryCancelEvent.html" class="tsd-kind-type-alias">CadenzaEditGeometryCancelEvent</a></li>
|
|
63
64
|
</ul>
|
|
64
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
65
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/037e35ae1a44ca6831ca9f8529a43366d8e6f89a/src/cadenza.js#L649">src/cadenza.js:649</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>
|
|
65
66
|
</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>
|
|
66
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
67
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/037e35ae1a44ca6831ca9f8529a43366d8e6f89a/src/cadenza.js#L1003">src/cadenza.js:1003</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>
|
|
67
68
|
<p><em>Note:</em> The file name, if not provided, is generated from the name of the workbook view and the current date.</p>
|
|
68
69
|
</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>
|
|
69
70
|
</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.
|
|
@@ -75,10 +76,10 @@ of "JasperReports report".</p>
|
|
|
75
76
|
</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>
|
|
76
77
|
</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>
|
|
77
78
|
</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-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>
|
|
78
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
79
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/037e35ae1a44ca6831ca9f8529a43366d8e6f89a/src/cadenza.js#L1197">src/cadenza.js:1197</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> <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">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">locationFinder</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">mapExtent</span><span class="tsd-signature-symbol">?:</span> <a href="../types/Extent.html" class="tsd-signature-type tsd-kind-type-alias">Extent</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">minScale</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">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">snapping</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/SnappingOptions.html" class="tsd-signature-type tsd-kind-interface">SnappingOptions</a><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="#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>
|
|
79
80
|
</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>
|
|
80
81
|
</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</p>
|
|
81
|
-
</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">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">locationFinder</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">mapExtent</span><span class="tsd-signature-symbol">?:</span> <a href="../types/Extent.html" class="tsd-signature-type tsd-kind-type-alias">Extent</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">minScale</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">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>
|
|
82
|
+
</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">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">locationFinder</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">mapExtent</span><span class="tsd-signature-symbol">?:</span> <a href="../types/Extent.html" class="tsd-signature-type tsd-kind-type-alias">Extent</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">minScale</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">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">snapping</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/SnappingOptions.html" class="tsd-signature-type tsd-kind-interface">SnappingOptions</a><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>
|
|
82
83
|
</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. Each is a layer definition, with name, type and content (a Geojson featureCollection).</p>
|
|
83
84
|
</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">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>
|
|
84
85
|
</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">extentStrategy</span><span class="tsd-signature-symbol">?: </span><a href="../types/ExtentStrategy.html" class="tsd-signature-type tsd-kind-type-alias">ExtentStrategy</a></h5><div class="tsd-comment tsd-typography"><p>Defines the initial map extent; If not given, Cadenza's default logic is used.</p>
|
|
@@ -88,6 +89,7 @@ of "JasperReports report".</p>
|
|
|
88
89
|
</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">minScale</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The minimum scale where the user should work on. A warning is shown when the map is zoomed out above the threshold.</p>
|
|
89
90
|
</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">operationMode</span><span class="tsd-signature-symbol">?: </span><a href="../types/OperationMode.html" class="tsd-signature-type tsd-kind-type-alias">OperationMode</a></h5><div class="tsd-comment tsd-typography"><p>The mode in which a workbook should be operated</p>
|
|
90
91
|
</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 iframe loading</p>
|
|
92
|
+
</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">snapping</span><span class="tsd-signature-symbol">?: </span><a href="../interfaces/SnappingOptions.html" class="tsd-signature-type tsd-kind-interface">SnappingOptions</a></h5><div class="tsd-comment tsd-typography"><p>Passing these options enables snapping</p>
|
|
91
93
|
</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>Whether the coordinates specified in other parameters are specified in the map's SRS (otherwise EPSG:4326 is assumed)</p>
|
|
92
94
|
</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>
|
|
93
95
|
<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>
|
|
@@ -96,9 +98,9 @@ of "JasperReports report".</p>
|
|
|
96
98
|
<li><a href="../types/CadenzaEditGeometryOkEvent.html" class="tsd-kind-type-alias">CadenzaEditGeometryOkEvent</a></li>
|
|
97
99
|
<li><a href="../types/CadenzaEditGeometryCancelEvent.html" class="tsd-kind-type-alias">CadenzaEditGeometryCancelEvent</a></li>
|
|
98
100
|
</ul>
|
|
99
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
101
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/037e35ae1a44ca6831ca9f8529a43366d8e6f89a/src/cadenza.js#L717">src/cadenza.js:717</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>
|
|
100
102
|
</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>
|
|
101
|
-
</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/
|
|
103
|
+
</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/037e35ae1a44ca6831ca9f8529a43366d8e6f89a/src/cadenza.js#L502">src/cadenza.js:502</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">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="#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>
|
|
102
104
|
</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>
|
|
103
105
|
</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
|
|
104
106
|
(identified using layer paths or print names)</p>
|
|
@@ -108,7 +110,7 @@ of "JasperReports report".</p>
|
|
|
108
110
|
</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>
|
|
109
111
|
</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>
|
|
110
112
|
</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>
|
|
111
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
113
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/037e35ae1a44ca6831ca9f8529a43366d8e6f89a/src/cadenza.js#L1127">src/cadenza.js:1127</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>
|
|
112
114
|
</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>
|
|
113
115
|
</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.
|
|
114
116
|
Currently, <code>"csv"</code>, <code>"excel"</code> and <code>"json"</code> are supported for embedding targets of type view with a view type of
|
|
@@ -120,7 +122,7 @@ of "JasperReports report".</p>
|
|
|
120
122
|
</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>
|
|
121
123
|
</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>
|
|
122
124
|
<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>
|
|
123
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
125
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/037e35ae1a44ca6831ca9f8529a43366d8e6f89a/src/cadenza.js#L1068">src/cadenza.js:1068</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>
|
|
124
126
|
</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>
|
|
125
127
|
</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
|
|
126
128
|
(identified using layer paths or print names)</p>
|
|
@@ -132,16 +134,16 @@ of "JasperReports report".</p>
|
|
|
132
134
|
</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>
|
|
133
135
|
</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>
|
|
134
136
|
<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>
|
|
135
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
137
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/037e35ae1a44ca6831ca9f8529a43366d8e6f89a/src/cadenza.js#L1090">src/cadenza.js:1090</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>
|
|
136
138
|
</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>
|
|
137
139
|
</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>
|
|
138
140
|
</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>
|
|
139
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
141
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/037e35ae1a44ca6831ca9f8529a43366d8e6f89a/src/cadenza.js#L945">src/cadenza.js:945</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>
|
|
140
142
|
</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>
|
|
141
143
|
</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
|
|
142
144
|
in the worksheet</p>
|
|
143
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><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>
|
|
144
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
146
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/037e35ae1a44ca6831ca9f8529a43366d8e6f89a/src/cadenza.js#L400">src/cadenza.js:400</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">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">locationFinder</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">mapExtent</span><span class="tsd-signature-symbol">?:</span> <a href="../types/Extent.html" class="tsd-signature-type tsd-kind-type-alias">Extent</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="#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>
|
|
145
147
|
</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>
|
|
146
148
|
</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">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">locationFinder</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">mapExtent</span><span class="tsd-signature-symbol">?:</span> <a href="../types/Extent.html" class="tsd-signature-type tsd-kind-type-alias">Extent</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>
|
|
147
149
|
</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">extentStrategy</span><span class="tsd-signature-symbol">?: </span><a href="../types/ExtentStrategy.html" class="tsd-signature-type tsd-kind-type-alias">ExtentStrategy</a></h5><div class="tsd-comment tsd-typography"><p>Defines the initial map extent; If not given, Cadenza's default logic is used.</p>
|
|
@@ -161,14 +163,14 @@ in the worksheet</p>
|
|
|
161
163
|
<li><a href="../types/CadenzaSelectObjectsOkEvent.html" class="tsd-kind-type-alias">CadenzaSelectObjectsOkEvent</a></li>
|
|
162
164
|
<li><a href="../types/CadenzaSelectObjectsCancelEvent.html" class="tsd-kind-type-alias">CadenzaSelectObjectsCancelEvent</a></li>
|
|
163
165
|
</ul>
|
|
164
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
166
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/037e35ae1a44ca6831ca9f8529a43366d8e6f89a/src/cadenza.js#L806">src/cadenza.js:806</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 custom validity state of the geometry editor in addition to the default validation state (including errors and
|
|
165
167
|
warnings). When set to error the dialog submission is blocked.
|
|
166
168
|
If there already is a custom state set it will override it.
|
|
167
169
|
Passing '' will reset the custom state to undefined, meaning no custom state is displayed.
|
|
168
170
|
If no geometry editing is started, the method call has no effect.</p>
|
|
169
171
|
</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>
|
|
170
172
|
</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>
|
|
171
|
-
</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/
|
|
173
|
+
</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/037e35ae1a44ca6831ca9f8529a43366d8e6f89a/src/cadenza.js#L775">src/cadenza.js:775</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">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-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>
|
|
172
174
|
</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>
|
|
173
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><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">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-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
|
|
174
176
|
type of "JasperReports report" to show the generated report PDF directly (without any Cadenza headers or
|
|
@@ -188,7 +190,7 @@ footers).</p>
|
|
|
188
190
|
<li><a href="../types/CadenzaDrillThroughEvent.html" class="tsd-kind-type-alias">CadenzaDrillThroughEvent</a></li>
|
|
189
191
|
<li><a href="../types/CadenzaActionEvent.html" class="tsd-kind-type-alias">CadenzaActionEvent</a></li>
|
|
190
192
|
</ul>
|
|
191
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
193
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/037e35ae1a44ca6831ca9f8529a43366d8e6f89a/src/cadenza.js#L351">src/cadenza.js:351</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">locationFinder</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">mapExtent</span><span class="tsd-signature-symbol">?:</span> <a href="../types/Extent.html" class="tsd-signature-type tsd-kind-type-alias">Extent</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>
|
|
192
194
|
</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>
|
|
193
195
|
</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">locationFinder</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">mapExtent</span><span class="tsd-signature-symbol">?:</span> <a href="../types/Extent.html" class="tsd-signature-type tsd-kind-type-alias">Extent</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>
|
|
194
196
|
</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.</p>
|
|
@@ -211,4 +213,4 @@ footers).</p>
|
|
|
211
213
|
<li><a href="../types/CadenzaDrillThroughEvent.html" class="tsd-kind-type-alias">CadenzaDrillThroughEvent</a></li>
|
|
212
214
|
<li><a href="../types/CadenzaActionEvent.html" class="tsd-kind-type-alias">CadenzaActionEvent</a></li>
|
|
213
215
|
</ul>
|
|
214
|
-
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
216
|
+
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/037e35ae1a44ca6831ca9f8529a43366d8e6f89a/src/cadenza.js#L441">src/cadenza.js:441</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="#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="#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="#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="#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.3.2</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>
|