@disy/cadenza.js 2.10.0 → 2.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/README.md +1 -0
- package/apidoc/assets/highlight.css +14 -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 +52 -29
- package/apidoc/classes/CadenzaError.html +5 -5
- package/apidoc/functions/cadenza.html +3 -3
- package/apidoc/index.html +27 -19
- package/apidoc/interfaces/CadenzaClientOptions.html +5 -5
- package/apidoc/interfaces/CadenzaEvent.html +4 -4
- package/apidoc/interfaces/Distance.html +3 -0
- package/apidoc/interfaces/ExternalLinkKey.html +5 -5
- package/apidoc/interfaces/Feature.html +12 -0
- package/apidoc/interfaces/FeatureCollection.html +4 -0
- package/apidoc/interfaces/Geometry.html +3 -3
- package/apidoc/interfaces/GeometryZoomTarget.html +4 -0
- package/apidoc/interfaces/PageSource.html +3 -3
- package/apidoc/modules.html +8 -2
- package/apidoc/types/CadenzaChangeSelectionEvent.html +2 -2
- package/apidoc/types/CadenzaDrillThroughEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryCancelEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryOkEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryUpdateEvent.html +2 -2
- package/apidoc/types/CadenzaErrorEvent.html +2 -2
- package/apidoc/types/CadenzaEventByType.html +1 -1
- package/apidoc/types/CadenzaEventType.html +2 -2
- package/apidoc/types/CadenzaObjectInfoEvent.html +2 -2
- package/apidoc/types/CadenzaSelectObjectsCancelEvent.html +2 -2
- package/apidoc/types/CadenzaSelectObjectsOkEvent.html +2 -2
- package/apidoc/types/DataType.html +2 -2
- package/apidoc/types/EmbeddingTargetId.html +2 -2
- package/apidoc/types/Extent.html +2 -2
- package/apidoc/types/FilterVariables.html +2 -2
- package/apidoc/types/GeometryType.html +2 -2
- package/apidoc/types/GlobalId.html +2 -2
- package/apidoc/types/LengthUnit.html +1 -0
- package/apidoc/types/OpaqueString.html +3 -3
- package/apidoc/types/OperationMode.html +2 -2
- package/apidoc/types/TablePart.html +2 -2
- package/apidoc/types/UiFeature.html +2 -2
- package/apidoc/types/WorkbookLayerPath.html +2 -2
- package/apidoc/types/ZoomTarget.html +2 -0
- package/cadenza.d.ts +145 -28
- package/cadenza.js +163 -38
- package/package.json +1 -1
- package/sandbox.cjs +2 -2
- package/sandbox.html +102 -18
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TablePart | Cadenza JS</title><meta name="description" content="Documentation for Cadenza JS"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/DisyInformationssysteme/cadenza.js">Cadenza JS on GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Cadenza JS</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Cadenza JS</a></li><li><a href="TablePart.html">TablePart</a></li></ul><h1>Type alias TablePart</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Table<wbr/>Part</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"columns"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"values"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"totals"</span></div><div class="tsd-comment tsd-typography"><p>A part of a table to export</p>
|
|
2
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TablePart | Cadenza JS - v2.11.0</title><meta name="description" content="Documentation for Cadenza JS"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/DisyInformationssysteme/cadenza.js">Cadenza JS on GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Cadenza JS - v2.11.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><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="TablePart.html">TablePart</a></li></ul><h1>Type alias TablePart</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Table<wbr/>Part</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"columns"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"values"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"totals"</span></div><div class="tsd-comment tsd-typography"><p>A part of a table to export</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/ed18e9cab078e4368378cc08c33c2040d63fcf35/src/cadenza.js#L144">src/cadenza.js:144</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Cadenza JS - v2.11.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>UiFeature | Cadenza JS</title><meta name="description" content="Documentation for Cadenza JS"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/DisyInformationssysteme/cadenza.js">Cadenza JS on GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Cadenza JS</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Cadenza JS</a></li><li><a href="UiFeature.html">UiFeature</a></li></ul><h1>Type alias UiFeature</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Ui<wbr/>Feature</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"workbook-design"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"workbook-view-management"</span></div><div class="tsd-comment tsd-typography"><p>The name of a Cadenza UI feature</p>
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>UiFeature | Cadenza JS - v2.11.0</title><meta name="description" content="Documentation for Cadenza JS"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/DisyInformationssysteme/cadenza.js">Cadenza JS on GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Cadenza JS - v2.11.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><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="UiFeature.html">UiFeature</a></li></ul><h1>Type alias UiFeature</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Ui<wbr/>Feature</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"workbook-design"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"workbook-view-management"</span></div><div class="tsd-comment tsd-typography"><p>The name of a Cadenza UI feature</p>
|
|
2
2
|
<p><em>Note:</em> Supported features are:</p>
|
|
3
3
|
<ul>
|
|
4
4
|
<li><code>"workbook-design"</code> - The workbook designer</li>
|
|
5
5
|
<li><code>"workbook-view-management"</code> - Add/Edit/Remove workbook views (Is included in 'workbook-design'.)</li>
|
|
6
6
|
</ul>
|
|
7
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
7
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/ed18e9cab078e4368378cc08c33c2040d63fcf35/src/cadenza.js#L104">src/cadenza.js:104</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Cadenza JS - v2.11.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkbookLayerPath | Cadenza JS</title><meta name="description" content="Documentation for Cadenza JS"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/DisyInformationssysteme/cadenza.js">Cadenza JS on GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Cadenza JS</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Cadenza JS</a></li><li><a href="WorkbookLayerPath.html">WorkbookLayerPath</a></li></ul><h1>Type alias WorkbookLayerPath</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Workbook<wbr/>Layer<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Identifies a layer within a workbook map view
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkbookLayerPath | Cadenza JS - v2.11.0</title><meta name="description" content="Documentation for Cadenza JS"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/DisyInformationssysteme/cadenza.js">Cadenza JS on GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Cadenza JS - v2.11.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><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="WorkbookLayerPath.html">WorkbookLayerPath</a></li></ul><h1>Type alias WorkbookLayerPath</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Workbook<wbr/>Layer<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Identifies a layer within a workbook map view
|
|
2
2
|
using the print names of the layer and - if the layer is grouped - its ancestors</p>
|
|
3
|
-
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
3
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/ed18e9cab078e4368378cc08c33c2040d63fcf35/src/cadenza.js#L93">src/cadenza.js:93</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Cadenza JS - v2.11.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZoomTarget | Cadenza JS - v2.11.0</title><meta name="description" content="Documentation for Cadenza JS"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/DisyInformationssysteme/cadenza.js">Cadenza JS on GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Cadenza JS - v2.11.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><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="ZoomTarget.html">ZoomTarget</a></li></ul><h1>Type alias ZoomTarget</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Zoom<wbr/>Target</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/GeometryZoomTarget.html" class="tsd-signature-type tsd-kind-interface">GeometryZoomTarget</a></div><div class="tsd-comment tsd-typography"><p>An object describing a target to zoom to</p>
|
|
2
|
+
</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/ed18e9cab078e4368378cc08c33c2040d63fcf35/src/cadenza.js#L132">src/cadenza.js:132</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-index-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><h4 class="uppercase">Member Visibility</h4><form><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-private" name="private"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Private</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></form></div><div class="tsd-theme-toggle"><h4 class="uppercase">Theme</h4><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1"></use></svg><span>Cadenza JS - v2.11.0</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
package/cadenza.d.ts
CHANGED
|
@@ -21,6 +21,11 @@ export function cadenza(options?: CadenzaClientOptions | undefined): CadenzaClie
|
|
|
21
21
|
export function cadenza(baseUrl: string, options?: CadenzaClientOptions | undefined): CadenzaClient;
|
|
22
22
|
/**
|
|
23
23
|
* _Notes:_
|
|
24
|
+
* * Most public methods are tagged with one of these modifiers:
|
|
25
|
+
* * `Embed`: The method embeds Cadenza in the given iframe.
|
|
26
|
+
* * `Post Message`: The method communicates with an embedded or parent/opener Cadenza via postMessage.
|
|
27
|
+
* * `Post Message Parent`: The method communicates with a parent/opener Cadenza via postMessage.
|
|
28
|
+
* * `Server`: The method communicates with the Cadenza server via HTTP.
|
|
24
29
|
* * Most public methods can be aborted using an [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal).
|
|
25
30
|
* When aborted, the result Promise is rejected with an {@link AbortError}.
|
|
26
31
|
* * If there's another error, the result Promise is rejected with a {@link CadenzaError}.
|
|
@@ -57,6 +62,7 @@ export class CadenzaClient {
|
|
|
57
62
|
* @return {Promise<void>} A `Promise` for when the iframe is loaded
|
|
58
63
|
* @throws For invalid arguments
|
|
59
64
|
* @fires {@link CadenzaDrillThroughEvent}
|
|
65
|
+
* @embed
|
|
60
66
|
*/
|
|
61
67
|
show(source: PageSource | EmbeddingTargetId, { dataType, disabledUiFeatures, expandNavigator, filter, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, labelSet, operationMode, signal, }?: {
|
|
62
68
|
dataType?: DataType | undefined;
|
|
@@ -70,6 +76,21 @@ export class CadenzaClient {
|
|
|
70
76
|
operationMode?: OperationMode | undefined;
|
|
71
77
|
signal?: AbortSignal | undefined;
|
|
72
78
|
} | undefined, ...args: any[]): Promise<void>;
|
|
79
|
+
/**
|
|
80
|
+
* Reload the views of a worksheet.
|
|
81
|
+
* @param {object} [options] - Options
|
|
82
|
+
* @param {boolean} [options.invalidateCaches] - When true, caches will be invalidated for objecttypes used
|
|
83
|
+
* in the worksheet
|
|
84
|
+
* @postMessage
|
|
85
|
+
*/
|
|
86
|
+
reload({ invalidateCaches }?: {
|
|
87
|
+
invalidateCaches?: boolean | undefined;
|
|
88
|
+
} | undefined, ...args: any[]): void;
|
|
89
|
+
/**
|
|
90
|
+
* Sends a message to parent Cadenza window to close the window containing this application
|
|
91
|
+
* @postMessageParent
|
|
92
|
+
*/
|
|
93
|
+
closeMe(): void;
|
|
73
94
|
/**
|
|
74
95
|
* Show a workbook map view in an iframe.
|
|
75
96
|
*
|
|
@@ -86,12 +107,14 @@ export class CadenzaClient {
|
|
|
86
107
|
* @param {Extent} [options.mapExtent] - A map extent to set
|
|
87
108
|
* @param {OperationMode} [options.operationMode] - The mode in which a workbook should be operated
|
|
88
109
|
* @param {boolean} [options.useMapSrs] - Whether the geometry and the extent are in the map's SRS (otherwise EPSG:4326 is assumed)
|
|
110
|
+
* @param {ZoomTarget} [options.zoomTarget] - A target Cadenza should zoom to
|
|
89
111
|
* @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
|
|
90
112
|
* @return {Promise<void>} A `Promise` for when the iframe is loaded
|
|
91
113
|
* @throws For invalid arguments
|
|
92
114
|
* @fires {@link CadenzaDrillThroughEvent}
|
|
115
|
+
* @embed
|
|
93
116
|
*/
|
|
94
|
-
showMap(mapView: EmbeddingTargetId, { disabledUiFeatures, expandNavigator, filter, geometry, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, locationFinder, mapExtent, operationMode, useMapSrs, signal, }?: {
|
|
117
|
+
showMap(mapView: EmbeddingTargetId, { disabledUiFeatures, expandNavigator, filter, geometry, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, locationFinder, mapExtent, operationMode, useMapSrs, zoomTarget, signal, }?: {
|
|
95
118
|
disabledUiFeatures?: UiFeature[] | undefined;
|
|
96
119
|
expandNavigator?: boolean | undefined;
|
|
97
120
|
filter?: FilterVariables | undefined;
|
|
@@ -103,12 +126,14 @@ export class CadenzaClient {
|
|
|
103
126
|
mapExtent?: Extent | undefined;
|
|
104
127
|
operationMode?: OperationMode | undefined;
|
|
105
128
|
useMapSrs?: boolean | undefined;
|
|
129
|
+
zoomTarget?: GeometryZoomTarget | undefined;
|
|
106
130
|
signal?: AbortSignal | undefined;
|
|
107
131
|
} | undefined, ...args: any[]): Promise<void>;
|
|
108
132
|
/**
|
|
109
133
|
* Expand/collapse the navigator.
|
|
110
134
|
*
|
|
111
135
|
* @param {boolean} expanded - The expansion state of the navigator
|
|
136
|
+
* @postMessage
|
|
112
137
|
*/
|
|
113
138
|
expandNavigator(expanded?: boolean, ...args: any[]): void;
|
|
114
139
|
/**
|
|
@@ -120,6 +145,7 @@ export class CadenzaClient {
|
|
|
120
145
|
* @template {DataType} T
|
|
121
146
|
* @param {T} dataType - The requested data type. Currently, only `"png"` is supported.
|
|
122
147
|
* @return {Promise<T extends 'png' ? Blob : never>}
|
|
148
|
+
* @postMessage
|
|
123
149
|
*/
|
|
124
150
|
getData<T extends DataType>(dataType: T, ...args: any[]): Promise<T extends "png" ? Blob : never>;
|
|
125
151
|
/**
|
|
@@ -128,6 +154,7 @@ export class CadenzaClient {
|
|
|
128
154
|
* @hidden
|
|
129
155
|
* @param {FilterVariables} filter - The variable values
|
|
130
156
|
* @return {Promise<void>} A `Promise` for when the filter variables were set.
|
|
157
|
+
* @postMessage
|
|
131
158
|
*/
|
|
132
159
|
setFilter(filter: FilterVariables, ...args: any[]): Promise<void>;
|
|
133
160
|
/**
|
|
@@ -141,6 +168,7 @@ export class CadenzaClient {
|
|
|
141
168
|
* (identified using a layer path or a print name)
|
|
142
169
|
* @param {boolean} visible - The visibility state of the layer
|
|
143
170
|
* @return {Promise<void>} A `Promise` for when the layer visibility was set.
|
|
171
|
+
* @postMessage
|
|
144
172
|
*/
|
|
145
173
|
setLayerVisibility(layer: WorkbookLayerPath | string, visible: boolean, ...args: any[]): Promise<void>;
|
|
146
174
|
/**
|
|
@@ -148,28 +176,31 @@ export class CadenzaClient {
|
|
|
148
176
|
*
|
|
149
177
|
* @hidden
|
|
150
178
|
* @param {WorkbookLayerPath | string} layer - The data view layer to set the selection in
|
|
151
|
-
* @param {unknown[]} values - The IDs of the objects to select
|
|
179
|
+
* @param {unknown[][]} values - The IDs of the objects to select
|
|
152
180
|
* @return {Promise<void>} A `Promise` for when the selection was set.
|
|
181
|
+
* @postMessage
|
|
153
182
|
*/
|
|
154
|
-
setSelection(layer: WorkbookLayerPath | string, values: unknown[], ...args: any[]): Promise<void>;
|
|
183
|
+
setSelection(layer: WorkbookLayerPath | string, values: unknown[][], ...args: any[]): Promise<void>;
|
|
155
184
|
/**
|
|
156
185
|
* Add to the selection in the currently shown workbook map view.
|
|
157
186
|
*
|
|
158
187
|
* @hidden
|
|
159
188
|
* @param {WorkbookLayerPath | string} layer - The data view layer to change the selection in
|
|
160
|
-
* @param {unknown[]} values - The IDs of the objects to select
|
|
189
|
+
* @param {unknown[][]} values - The IDs of the objects to select
|
|
161
190
|
* @return {Promise<void>} A `Promise` for when the selection was changed.
|
|
191
|
+
* @postMessage
|
|
162
192
|
*/
|
|
163
|
-
addSelection(layer: WorkbookLayerPath | string, values: unknown[], ...args: any[]): Promise<void>;
|
|
193
|
+
addSelection(layer: WorkbookLayerPath | string, values: unknown[][], ...args: any[]): Promise<void>;
|
|
164
194
|
/**
|
|
165
195
|
* Remove from the selection in the currently shown workbook map view.
|
|
166
196
|
*
|
|
167
197
|
* @hidden
|
|
168
198
|
* @param {WorkbookLayerPath | string} layer - The data view layer to change the selection in
|
|
169
|
-
* @param {unknown[]} values - The IDs of the objects to unselect
|
|
199
|
+
* @param {unknown[][]} values - The IDs of the objects to unselect
|
|
170
200
|
* @return {Promise<void>} A `Promise` for when the selection was changed.
|
|
201
|
+
* @postMessage
|
|
171
202
|
*/
|
|
172
|
-
removeSelection(layer: WorkbookLayerPath | string, values: unknown[], ...args: any[]): Promise<void>;
|
|
203
|
+
removeSelection(layer: WorkbookLayerPath | string, values: unknown[][], ...args: any[]): Promise<void>;
|
|
173
204
|
/**
|
|
174
205
|
* Create a geometry.
|
|
175
206
|
*
|
|
@@ -191,6 +222,7 @@ export class CadenzaClient {
|
|
|
191
222
|
* - {@link CadenzaEditGeometryUpdateEvent}
|
|
192
223
|
* - {@link CadenzaEditGeometryOkEvent}
|
|
193
224
|
* - {@link CadenzaEditGeometryCancelEvent}
|
|
225
|
+
* @embed
|
|
194
226
|
*/
|
|
195
227
|
createGeometry(backgroundMapView: EmbeddingTargetId, geometryType: GeometryType, { filter, locationFinder, mapExtent, minScale, useMapSrs, signal }?: {
|
|
196
228
|
filter?: FilterVariables | undefined;
|
|
@@ -211,6 +243,7 @@ export class CadenzaClient {
|
|
|
211
243
|
* @param {Extent} [options.mapExtent] - A map extent to set
|
|
212
244
|
* @param {number} [options.minScale] - The minimum scale where the user should work on. A warning is shown when the map is zoomed out above the threshold.
|
|
213
245
|
* @param {boolean} [options.useMapSrs] - Whether the geometry is in the map's SRS (otherwise EPSG:4326 is assumed)
|
|
246
|
+
* @param {ZoomTarget} [options.zoomTarget] - A target Cadenza should zoom to
|
|
214
247
|
* @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
|
|
215
248
|
* @return {Promise<void>} A `Promise` for when the iframe is loaded
|
|
216
249
|
* @throws For invalid arguments
|
|
@@ -218,13 +251,15 @@ export class CadenzaClient {
|
|
|
218
251
|
* - {@link CadenzaEditGeometryUpdateEvent}
|
|
219
252
|
* - {@link CadenzaEditGeometryOkEvent}
|
|
220
253
|
* - {@link CadenzaEditGeometryCancelEvent}
|
|
254
|
+
* @embed
|
|
221
255
|
*/
|
|
222
|
-
editGeometry(backgroundMapView: EmbeddingTargetId, geometry: Geometry, { filter, locationFinder, mapExtent, minScale, useMapSrs, signal }?: {
|
|
256
|
+
editGeometry(backgroundMapView: EmbeddingTargetId, geometry: Geometry, { filter, locationFinder, mapExtent, minScale, useMapSrs, zoomTarget, signal, }?: {
|
|
223
257
|
filter?: FilterVariables | undefined;
|
|
224
258
|
locationFinder?: string | undefined;
|
|
225
259
|
mapExtent?: Extent | undefined;
|
|
226
260
|
minScale?: number | undefined;
|
|
227
261
|
useMapSrs?: boolean | undefined;
|
|
262
|
+
zoomTarget?: GeometryZoomTarget | undefined;
|
|
228
263
|
signal?: AbortSignal | undefined;
|
|
229
264
|
} | undefined, ...args: any[]): Promise<void>;
|
|
230
265
|
/**
|
|
@@ -246,6 +281,7 @@ export class CadenzaClient {
|
|
|
246
281
|
* - {@link CadenzaObjectInfoEvent}
|
|
247
282
|
* - {@link CadenzaSelectObjectsOkEvent}
|
|
248
283
|
* - {@link CadenzaSelectObjectsCancelEvent}
|
|
284
|
+
* @embed
|
|
249
285
|
*/
|
|
250
286
|
selectObjects(backgroundMapView: EmbeddingTargetId, { filter, layers, locationFinder, mapExtent, useMapSrs, signal }?: {
|
|
251
287
|
filter?: FilterVariables | undefined;
|
|
@@ -274,54 +310,83 @@ export class CadenzaClient {
|
|
|
274
310
|
* Fetch data from a workbook view.
|
|
275
311
|
*
|
|
276
312
|
* @param {EmbeddingTargetId} source - The workbook view to fetch data from.
|
|
277
|
-
* Currently only table and indicator views are supported.
|
|
278
313
|
* @param {DataType} dataType - The data type you want to get back from the server.
|
|
279
|
-
* Currently, `"csv"`, `"excel"` and `"json"` are supported
|
|
314
|
+
* Currently, `"csv"`, `"excel"` and `"json"` are supported for table and indicator views
|
|
315
|
+
* and `"pdf"` for views of type "JasperReports report".
|
|
280
316
|
* @param {object} [options] - Options
|
|
281
317
|
* @param {FilterVariables} [options.filter] - Filter variables
|
|
282
318
|
* @param {TablePart[]} [options.parts] - Table parts to export; If not specified, all parts are exported.
|
|
283
319
|
* @param {AbortSignal} [options.signal] - A signal to abort the data fetching
|
|
284
320
|
* @return {Promise<Response>} A `Promise` for the fetch response
|
|
285
321
|
* @throws For invalid arguments
|
|
322
|
+
* @server
|
|
286
323
|
*/
|
|
287
324
|
fetchData(source: EmbeddingTargetId, dataType: DataType, { filter, parts, signal }?: {
|
|
288
325
|
filter?: FilterVariables | undefined;
|
|
289
326
|
parts?: TablePart[] | undefined;
|
|
290
327
|
signal?: AbortSignal | undefined;
|
|
291
328
|
} | undefined, ...args: any[]): Promise<Response>;
|
|
329
|
+
/**
|
|
330
|
+
* Fetch object info from a workbook map view.
|
|
331
|
+
*
|
|
332
|
+
* @param {EmbeddingTargetId} source - The workbook view to fetch object info from.
|
|
333
|
+
* @param {(WorkbookLayerPath | string)[]} layerPath - Layer path to identify the layer
|
|
334
|
+
* (identified using layer paths or print names)
|
|
335
|
+
* @param {unknown[][]} objectIds - The IDs of the objects to select
|
|
336
|
+
* @param {object} [options] - Options
|
|
337
|
+
* @param {FilterVariables} [options.filter] - Filter variables
|
|
338
|
+
* @param {AbortSignal} [options.signal] - A signal to abort the data fetching
|
|
339
|
+
* @param {Boolean} [options.useMapSrs] - Use the map SRS instead of WGS84
|
|
340
|
+
* @param {Boolean} [options.fullGeometries] - Return non-simplified geometries
|
|
341
|
+
* @return {Promise<FeatureCollection>} A `Promise` for the fetch response
|
|
342
|
+
* @throws For invalid arguments
|
|
343
|
+
*/
|
|
344
|
+
fetchObjectInfo(source: EmbeddingTargetId, layerPath: (WorkbookLayerPath | string)[], objectIds: unknown[][], { filter, signal, useMapSrs, fullGeometries }?: {
|
|
345
|
+
filter?: FilterVariables | undefined;
|
|
346
|
+
signal?: AbortSignal | undefined;
|
|
347
|
+
useMapSrs?: boolean | undefined;
|
|
348
|
+
fullGeometries?: boolean | undefined;
|
|
349
|
+
} | undefined, ...args: any[]): Promise<FeatureCollection>;
|
|
350
|
+
/**
|
|
351
|
+
* Fetch the intersection areas from a workbook map view layer in JSON format for a given area.
|
|
352
|
+
*
|
|
353
|
+
* @param {EmbeddingTargetId} source - The workbook view to fetch object info from.
|
|
354
|
+
* @param {(WorkbookLayerPath | string)[]} layerPath - Layer path to identify the layer
|
|
355
|
+
* (identified using layer paths or print names)
|
|
356
|
+
* @param {Geometry} geometry - The intersection geometry
|
|
357
|
+
* @param {object} [options] - Options
|
|
358
|
+
* @param {boolean} [options.useMapSrs] - The intersection geometry and the result geometries are in the map's SRS (otherwise EPSG:4326 is assumed)
|
|
359
|
+
* @param {Distance} [options.buffer] - Buffer size for geometry of the transition
|
|
360
|
+
* @param {AbortSignal} [options.signal] - A signal to abort the data fetching
|
|
361
|
+
* @return {Promise<FeatureCollection>} A `Promise` for the fetch response
|
|
362
|
+
* @server
|
|
363
|
+
*/
|
|
364
|
+
fetchAreaIntersections(source: EmbeddingTargetId, layerPath: (WorkbookLayerPath | string)[], geometry: Geometry, { useMapSrs, buffer, signal }?: {
|
|
365
|
+
useMapSrs?: boolean | undefined;
|
|
366
|
+
buffer?: Distance | undefined;
|
|
367
|
+
signal?: AbortSignal | undefined;
|
|
368
|
+
} | undefined, ...args: any[]): Promise<FeatureCollection>;
|
|
292
369
|
/**
|
|
293
370
|
* Download data from a workbook view.
|
|
294
371
|
*
|
|
295
372
|
* _Note:_ The file name, if not provided, is generated from the name of the workbook view and the current date.
|
|
296
373
|
*
|
|
297
|
-
* @param {EmbeddingTargetId} source - The workbook view to
|
|
298
|
-
* Currently only table and indicator views are supported.
|
|
374
|
+
* @param {EmbeddingTargetId} source - The workbook view to fetch data from.
|
|
299
375
|
* @param {DataType} dataType - The data type you want to get back from the server.
|
|
300
|
-
* Currently, `"csv"`, `"excel"` and `"json"` are supported
|
|
376
|
+
* Currently, `"csv"`, `"excel"` and `"json"` are supported for table and indicator views
|
|
377
|
+
* and `"pdf"` for views of type "JasperReports report".
|
|
301
378
|
* @param {object} [options] - Options
|
|
302
379
|
* @param {string} [options.fileName] - The file name to use; The file extension is appended by Cadenza.
|
|
303
380
|
* @param {FilterVariables} [options.filter] - Filter variables
|
|
304
381
|
* @param {TablePart[]} [options.parts] - Table parts to export; If not specified, all parts are exported.
|
|
305
382
|
* @throws For invalid arguments
|
|
383
|
+
* @server
|
|
306
384
|
*/
|
|
307
385
|
downloadData(source: EmbeddingTargetId, dataType: DataType, { fileName, filter, parts }?: {
|
|
308
386
|
fileName?: string | undefined;
|
|
309
387
|
filter?: FilterVariables | undefined;
|
|
310
388
|
parts?: TablePart[] | undefined;
|
|
311
389
|
} | undefined, ...args: any[]): void;
|
|
312
|
-
/**
|
|
313
|
-
* Reload the views of a worksheet.
|
|
314
|
-
* @param {object} [options] - Options
|
|
315
|
-
* @param {boolean} [options.invalidateCaches] - When true, caches will be invalidated for objecttypes used
|
|
316
|
-
* in the worksheet
|
|
317
|
-
*/
|
|
318
|
-
reload({ invalidateCaches }?: {
|
|
319
|
-
invalidateCaches?: boolean | undefined;
|
|
320
|
-
} | undefined, ...args: any[]): void;
|
|
321
|
-
/**
|
|
322
|
-
* Sends a message to parent Cadenza window to close the window containing this application
|
|
323
|
-
*/
|
|
324
|
-
closeMe(): void;
|
|
325
390
|
#private;
|
|
326
391
|
}
|
|
327
392
|
/**
|
|
@@ -426,7 +491,7 @@ export type CadenzaClientOptions = {
|
|
|
426
491
|
* The idea is to have a specific type e.g. for the {@link EmbeddingTargetId } instead of a plain `string`.
|
|
427
492
|
* You don't need to _actually_ add that `__type` property. In TS code, just use a
|
|
428
493
|
* [type assertion](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#type-assertions)
|
|
429
|
-
* (e.g. `cadenzaClient.show('
|
|
494
|
+
* (e.g. `cadenzaClient.show('<embeddingTargetId>' as EmbeddingTargetId)`).
|
|
430
495
|
*/
|
|
431
496
|
export type OpaqueString<T extends string> = string & {
|
|
432
497
|
__type: T;
|
|
@@ -452,7 +517,7 @@ export type GlobalId = OpaqueString<'GlobalId'>;
|
|
|
452
517
|
*
|
|
453
518
|
* You get the `repositoryName` and `externalLinkId` from the URL of the external link's page in the Cadenza management center:
|
|
454
519
|
* ```
|
|
455
|
-
*
|
|
520
|
+
* <baseUrl>/admin/repositories/<repositoryName>/external-links/<externalLinkId>?...
|
|
456
521
|
* ```
|
|
457
522
|
*/
|
|
458
523
|
export type ExternalLinkKey = {
|
|
@@ -491,6 +556,11 @@ export type OperationMode = 'normal' | 'simplified';
|
|
|
491
556
|
* * `"workbook-view-management"` - Add/Edit/Remove workbook views (Is included in 'workbook-design'.)
|
|
492
557
|
*/
|
|
493
558
|
export type UiFeature = 'workbook-design' | 'workbook-view-management';
|
|
559
|
+
export type Distance = {
|
|
560
|
+
value: number;
|
|
561
|
+
lengthUnit: LengthUnit;
|
|
562
|
+
};
|
|
563
|
+
export type LengthUnit = 'm' | 'km';
|
|
494
564
|
/**
|
|
495
565
|
* - A [GeoJSON](https://geojson.org/) geometry object
|
|
496
566
|
*/
|
|
@@ -510,6 +580,19 @@ export type GeometryType = 'Point' | 'MultiPoint' | 'LineString' | 'MultiLineStr
|
|
|
510
580
|
* - An array of numbers representing an extent: [minx, miny, maxx, maxy]
|
|
511
581
|
*/
|
|
512
582
|
export type Extent = [number, number, number, number];
|
|
583
|
+
/**
|
|
584
|
+
* - An object describing a target to zoom to
|
|
585
|
+
*/
|
|
586
|
+
export type ZoomTarget = GeometryZoomTarget;
|
|
587
|
+
/**
|
|
588
|
+
* - Instructs Cadenza to zoom to a provided {@Link Geometry}
|
|
589
|
+
*/
|
|
590
|
+
export type GeometryZoomTarget = {
|
|
591
|
+
/**
|
|
592
|
+
* The type of the zoom target
|
|
593
|
+
*/
|
|
594
|
+
type: 'geometry';
|
|
595
|
+
};
|
|
513
596
|
/**
|
|
514
597
|
* - A data type
|
|
515
598
|
*
|
|
@@ -529,6 +612,40 @@ export type TablePart = 'columns' | 'values' | 'totals';
|
|
|
529
612
|
* for Long variables, the API is currently limited to the Double value range.
|
|
530
613
|
*/
|
|
531
614
|
export type FilterVariables = Record<string, string | string[] | number | Date | null>;
|
|
615
|
+
/**
|
|
616
|
+
* - A adapted [GeoJSON](https://geojson.org/) feature object.
|
|
617
|
+
*/
|
|
618
|
+
export type Feature = {
|
|
619
|
+
/**
|
|
620
|
+
* - The id of the feature
|
|
621
|
+
*/
|
|
622
|
+
objectId: any[];
|
|
623
|
+
/**
|
|
624
|
+
* - The geometry
|
|
625
|
+
*/
|
|
626
|
+
geometry: Geometry;
|
|
627
|
+
/**
|
|
628
|
+
* - The formated properties
|
|
629
|
+
*/
|
|
630
|
+
properties: Record<string, string>;
|
|
631
|
+
/**
|
|
632
|
+
* - The area of a `Polygon` feature
|
|
633
|
+
*/
|
|
634
|
+
area?: number | undefined;
|
|
635
|
+
/**
|
|
636
|
+
* - The area of a `LineString` feature
|
|
637
|
+
*/
|
|
638
|
+
length?: number | undefined;
|
|
639
|
+
};
|
|
640
|
+
/**
|
|
641
|
+
* - A adapted [GeoJSON](https://geojson.org/) feature collection object
|
|
642
|
+
*/
|
|
643
|
+
export type FeatureCollection = {
|
|
644
|
+
/**
|
|
645
|
+
* - The features within this collection
|
|
646
|
+
*/
|
|
647
|
+
features: Feature[];
|
|
648
|
+
};
|
|
532
649
|
/**
|
|
533
650
|
* - An event type to subscribe to using {@link CadenzaClienton }
|
|
534
651
|
*/
|