@disy/cadenza.js 10.4.4 → 10.4.6
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 +18 -0
- package/apidoc/assets/highlight.css +16 -2
- 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 +26 -25
- package/apidoc/classes/CadenzaError.html +5 -5
- package/apidoc/functions/cadenza.html +4 -4
- package/apidoc/index.html +8 -3
- package/apidoc/interfaces/AreaIntersectionsResult.html +6 -0
- package/apidoc/interfaces/CadenzaClientOptions.html +11 -6
- package/apidoc/interfaces/CadenzaEvent.html +4 -4
- package/apidoc/interfaces/CommonEditGeometryOptions.html +11 -11
- package/apidoc/interfaces/Distance.html +2 -2
- package/apidoc/interfaces/ExternalLinkKey.html +5 -5
- package/apidoc/interfaces/Feature.html +9 -9
- package/apidoc/interfaces/FeatureCollection.html +4 -4
- package/apidoc/interfaces/Geometry.html +4 -4
- package/apidoc/interfaces/GeometryExtentStrategy.html +4 -4
- package/apidoc/interfaces/LayerDataExtentStrategy.html +4 -4
- package/apidoc/interfaces/LayerDefinition.html +4 -4
- package/apidoc/interfaces/LocationFinderExtentStrategy.html +4 -4
- package/apidoc/interfaces/PageSource.html +3 -3
- package/apidoc/interfaces/ProblemDetails.html +10 -0
- package/apidoc/interfaces/SnappingOptions.html +3 -3
- package/apidoc/interfaces/SpatialFilterValue.html +4 -4
- package/apidoc/interfaces/StaticExtentStrategy.html +4 -4
- package/apidoc/modules.html +1 -1
- package/apidoc/types/CadenzaActionEvent.html +2 -2
- package/apidoc/types/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/CadenzaReloadEvent.html +2 -2
- package/apidoc/types/CadenzaSelectObjectsCancelEvent.html +2 -2
- package/apidoc/types/CadenzaSelectObjectsOkEvent.html +2 -2
- package/apidoc/types/Coordinate.html +2 -2
- package/apidoc/types/CustomValidityType.html +2 -2
- package/apidoc/types/DataType.html +2 -2
- package/apidoc/types/EmbeddingTargetId.html +2 -2
- package/apidoc/types/Extent.html +2 -2
- package/apidoc/types/ExtentStrategy.html +2 -2
- package/apidoc/types/FilterVariables.html +2 -2
- package/apidoc/types/GeometryType.html +2 -2
- package/apidoc/types/GlobalId.html +2 -2
- package/apidoc/types/Layout.html +2 -2
- package/apidoc/types/LengthUnit.html +1 -1
- package/apidoc/types/OpaqueString.html +2 -2
- package/apidoc/types/OperationMode.html +2 -2
- package/apidoc/types/Polygon.html +1 -1
- package/apidoc/types/SpatialRelation.html +2 -2
- package/apidoc/types/TablePart.html +2 -2
- package/apidoc/types/UiFeature.html +2 -2
- package/apidoc/types/WorkbookLayerPath.html +2 -2
- package/cadenza.d.ts +55 -24
- package/cadenza.js +36 -10
- package/package.json +1 -1
- package/sandbox.html +24 -6
- package/apidoc/types/CadenzaObjectInfoEvent.html +0 -2
|
@@ -1 +1 @@
|
|
|
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>Polygon | Cadenza JS - v10.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>Polygon | Cadenza JS - v10.4.6</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.4.6</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="Polygon.html">Polygon</a></li></ul><h1>Type Alias Polygon</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Polygon</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Geometry.html" class="tsd-signature-type tsd-kind-interface">Geometry</a></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/bba262b6d2301fcd0505fea44239d9ae9eddd613/src/cadenza.js#L222">src/cadenza.js:222</a></li></ul></aside></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></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.4.6</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>
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SpatialRelation | Cadenza JS - v10.4.
|
|
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" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SpatialRelation | Cadenza JS - v10.4.6</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.4.6</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="SpatialRelation.html">SpatialRelation</a></li></ul><h1>Type Alias SpatialRelation</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">SpatialRelation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"overlaps"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"notOverlaps"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"contains"</span></div><div class="tsd-comment tsd-typography"><p>Defines how geometries interact</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/bba262b6d2301fcd0505fea44239d9ae9eddd613/src/cadenza.js#L220">src/cadenza.js:220</a></li></ul></aside></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></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.4.6</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>
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TablePart | Cadenza JS - v10.4.
|
|
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" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>TablePart | Cadenza JS - v10.4.6</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.4.6</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="TablePart.html">TablePart</a></li></ul><h1>Type Alias TablePart</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">TablePart</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/bba262b6d2301fcd0505fea44239d9ae9eddd613/src/cadenza.js#L205">src/cadenza.js:205</a></li></ul></aside></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></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.4.6</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>
|
|
@@ -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>UiFeature | Cadenza JS - v10.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>UiFeature | Cadenza JS - v10.4.6</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.4.6</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="UiFeature.html">UiFeature</a></li></ul><h1>Type Alias UiFeature</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">UiFeature</span><span class="tsd-signature-symbol">:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"workbook-design"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"workbook-map-add-layer"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"workbook-view-management"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"embedded-dialog-footer-buttons"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"embedded-dialog-apply-button"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"embedded-dialog-cancel-button"</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>
|
|
@@ -8,4 +8,4 @@
|
|
|
8
8
|
<li><code>"embedded-dialog-apply-button"</code> - Apply button for Create/Edit Geometries and Select Objects dialogs</li>
|
|
9
9
|
<li><code>"embedded-dialog-cancel-button"</code> - Cancel button for Create/Edit Geometries and Select Objects dialogs</li>
|
|
10
10
|
</ul>
|
|
11
|
-
</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/
|
|
11
|
+
</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/bba262b6d2301fcd0505fea44239d9ae9eddd613/src/cadenza.js#L117">src/cadenza.js:117</a></li></ul></aside></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></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.4.6</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>
|
|
@@ -1,3 +1,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>WorkbookLayerPath | Cadenza JS - v10.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>WorkbookLayerPath | Cadenza JS - v10.4.6</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.4.6</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="WorkbookLayerPath.html">WorkbookLayerPath</a></li></ul><h1>Type Alias WorkbookLayerPath</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">WorkbookLayerPath</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/bba262b6d2301fcd0505fea44239d9ae9eddd613/src/cadenza.js#L106">src/cadenza.js:106</a></li></ul></aside></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></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.4.6</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>
|
package/cadenza.d.ts
CHANGED
|
@@ -317,7 +317,6 @@ export class CadenzaClient {
|
|
|
317
317
|
* @throws For invalid arguments
|
|
318
318
|
* @fires
|
|
319
319
|
* - {@link CadenzaChangeSelectionEvent}
|
|
320
|
-
* - {@link CadenzaObjectInfoEvent}
|
|
321
320
|
* - {@link CadenzaSelectObjectsOkEvent}
|
|
322
321
|
* - {@link CadenzaSelectObjectsCancelEvent}
|
|
323
322
|
* @embed
|
|
@@ -396,17 +395,21 @@ export class CadenzaClient {
|
|
|
396
395
|
* (identified using layer paths or print names)
|
|
397
396
|
* @param {Geometry} geometry - The intersection geometry
|
|
398
397
|
* @param {object} [__namedParameters] - Options
|
|
398
|
+
* @param {boolean} [__namedParameters.useAutoCorrection] - Enables the automatic correction of invalid geometries
|
|
399
399
|
* @param {Distance} [__namedParameters.buffer] - Buffer size for geometry of the transition
|
|
400
|
+
* @param {boolean} [__namedParameters.includeGeometryValidationReport] - Enables the list of corrected geometries, including error descriptions
|
|
400
401
|
* @param {AbortSignal} [__namedParameters.signal] - A signal to abort the data fetching
|
|
401
402
|
* @param {boolean} [__namedParameters.useMapSrs] - The intersection geometry and the result geometries are in the map's SRS (otherwise EPSG:4326 is assumed)
|
|
402
|
-
* @return {Promise<
|
|
403
|
+
* @return {Promise<AreaIntersectionsResult | ProblemDetails>} A `Promise` for the fetch response
|
|
403
404
|
* @server
|
|
404
405
|
*/
|
|
405
|
-
fetchAreaIntersections(source: EmbeddingTargetId, layerPath: (WorkbookLayerPath | string)[], geometry: Geometry, { buffer, signal, useMapSrs }?: {
|
|
406
|
+
fetchAreaIntersections(source: EmbeddingTargetId, layerPath: (WorkbookLayerPath | string)[], geometry: Geometry, { buffer, includeGeometryValidationReport, signal, useAutoCorrection, useMapSrs, }?: {
|
|
407
|
+
useAutoCorrection?: boolean | undefined;
|
|
406
408
|
buffer?: Distance | undefined;
|
|
409
|
+
includeGeometryValidationReport?: boolean | undefined;
|
|
407
410
|
signal?: AbortSignal | undefined;
|
|
408
411
|
useMapSrs?: boolean | undefined;
|
|
409
|
-
} | undefined, ...args: any[]): Promise<
|
|
412
|
+
} | undefined, ...args: any[]): Promise<AreaIntersectionsResult | ProblemDetails>;
|
|
410
413
|
/**
|
|
411
414
|
* Download data from a workbook view.
|
|
412
415
|
*
|
|
@@ -438,7 +441,6 @@ export class CadenzaClient {
|
|
|
438
441
|
* | 'editGeometry:ok'
|
|
439
442
|
* | 'editGeometry:update'
|
|
440
443
|
* | 'editGeometry:cancel'
|
|
441
|
-
* | 'objectInfo'
|
|
442
444
|
* | 'reload'
|
|
443
445
|
* | 'selectObjects:ok'
|
|
444
446
|
* | 'selectObjects:cancel'
|
|
@@ -452,7 +454,6 @@ export class CadenzaClient {
|
|
|
452
454
|
* : T extends 'editGeometry:update' ? CadenzaEditGeometryUpdateEvent
|
|
453
455
|
* : T extends 'editGeometry:ok' ? CadenzaEditGeometryOkEvent
|
|
454
456
|
* : T extends 'editGeometry:cancel' ? CadenzaEditGeometryCancelEvent
|
|
455
|
-
* : T extends 'objectInfo' ? CadenzaObjectInfoEvent
|
|
456
457
|
* : T extends 'reload' ? CadenzaReloadEvent
|
|
457
458
|
* : T extends 'selectObjects:ok' ? CadenzaSelectObjectsOkEvent
|
|
458
459
|
* : T extends 'selectObjects:cancel' ? CadenzaSelectObjectsCancelEvent
|
|
@@ -487,7 +488,6 @@ export class CadenzaClient {
|
|
|
487
488
|
/** @typedef {CadenzaEvent<'editGeometry:ok', FeatureCollection | Feature>} CadenzaEditGeometryOkEvent - When the user submitted the geometry. `FeatureCollection` if batch editing is enabled. */
|
|
488
489
|
/** @typedef {CadenzaEvent<'editGeometry:cancel'>} CadenzaEditGeometryCancelEvent - When the user cancelled the geometry editing. */
|
|
489
490
|
/** @typedef {CadenzaEvent<'error', {type: string, message?: string}>} CadenzaErrorEvent - An error event that is mapped to a {@link CadenzaError} */
|
|
490
|
-
/** @typedef {CadenzaEvent<'objectInfo', {layer: WorkbookLayerPath, objectInfos: {selectionIndex: number, elements: {attributePrintName: string, formattedValue: string}[]}}>} CadenzaObjectInfoEvent - When the user opened the object info flyout. */
|
|
491
491
|
/**
|
|
492
492
|
* @typedef {CadenzaEvent<'selectObjects:ok', undefined | {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaSelectObjectsOkEvent - When the user submitted the selection. `undefined` if no objects were selected.
|
|
493
493
|
*
|
|
@@ -537,7 +537,12 @@ export type CadenzaClientOptions = {
|
|
|
537
537
|
*/
|
|
538
538
|
webApplication?: ExternalLinkKey | undefined;
|
|
539
539
|
/**
|
|
540
|
-
* - Whether to enable debug logging
|
|
540
|
+
* - Whether to enable debug logging;
|
|
541
|
+
* It can also be enabled/disabled at runtime via the devtools console:
|
|
542
|
+
* ```js
|
|
543
|
+
* localStorage.setItem('cadenzajs.debug', 'true'); // or 'false'
|
|
544
|
+
* ```
|
|
545
|
+
* Then you need to reload the page.
|
|
541
546
|
*/
|
|
542
547
|
debug?: boolean | undefined;
|
|
543
548
|
/**
|
|
@@ -851,6 +856,40 @@ export type FeatureCollection = {
|
|
|
851
856
|
*/
|
|
852
857
|
features: Feature[];
|
|
853
858
|
};
|
|
859
|
+
/**
|
|
860
|
+
* - Result object of function fetchAreaIntersections
|
|
861
|
+
*/
|
|
862
|
+
export type AreaIntersectionsResult = {
|
|
863
|
+
/**
|
|
864
|
+
* - Results of the geometry intersection
|
|
865
|
+
*/
|
|
866
|
+
results: FeatureCollection;
|
|
867
|
+
/**
|
|
868
|
+
* - Optional listing of corrected geometries including error description
|
|
869
|
+
*/
|
|
870
|
+
errors: FeatureCollection;
|
|
871
|
+
};
|
|
872
|
+
/**
|
|
873
|
+
* - A adapted [JSOn] IETF RFC 9457 Problem Details for HTTP APIs object
|
|
874
|
+
*/
|
|
875
|
+
export type ProblemDetails = {
|
|
876
|
+
/**
|
|
877
|
+
* - http status message
|
|
878
|
+
*/
|
|
879
|
+
httpStatus: string;
|
|
880
|
+
/**
|
|
881
|
+
* - The primary identifier for the experienced problem type
|
|
882
|
+
*/
|
|
883
|
+
type: string;
|
|
884
|
+
/**
|
|
885
|
+
* - Short version of the type
|
|
886
|
+
*/
|
|
887
|
+
key: string;
|
|
888
|
+
/**
|
|
889
|
+
* - Summary of the problem
|
|
890
|
+
*/
|
|
891
|
+
title: string;
|
|
892
|
+
};
|
|
854
893
|
/**
|
|
855
894
|
* - The type of custom validity used for disclose on visual presentation and form submission behavior
|
|
856
895
|
*/
|
|
@@ -874,8 +913,8 @@ export type Layout = 'dashboard' | 'linear';
|
|
|
874
913
|
/**
|
|
875
914
|
* - An event type to subscribe to using {@link CadenzaClienton }
|
|
876
915
|
*/
|
|
877
|
-
export type CadenzaEventType = 'action' | 'change:selection' | 'drillThrough' | 'editGeometry:ok' | 'editGeometry:update' | 'editGeometry:cancel' | '
|
|
878
|
-
export type CadenzaEventByType<T extends CadenzaEventType> = T extends 'action' ? CadenzaActionEvent : T extends 'change:selection' ? CadenzaChangeSelectionEvent : T extends 'drillThrough' ? CadenzaDrillThroughEvent : T extends 'editGeometry:update' ? CadenzaEditGeometryUpdateEvent : T extends 'editGeometry:ok' ? CadenzaEditGeometryOkEvent : T extends 'editGeometry:cancel' ? CadenzaEditGeometryCancelEvent : T extends '
|
|
916
|
+
export type CadenzaEventType = 'action' | 'change:selection' | 'drillThrough' | 'editGeometry:ok' | 'editGeometry:update' | 'editGeometry:cancel' | 'reload' | 'selectObjects:ok' | 'selectObjects:cancel';
|
|
917
|
+
export type CadenzaEventByType<T extends CadenzaEventType> = T extends 'action' ? CadenzaActionEvent : T extends 'change:selection' ? CadenzaChangeSelectionEvent : T extends 'drillThrough' ? CadenzaDrillThroughEvent : T extends 'editGeometry:update' ? CadenzaEditGeometryUpdateEvent : T extends 'editGeometry:ok' ? CadenzaEditGeometryOkEvent : T extends 'editGeometry:cancel' ? CadenzaEditGeometryCancelEvent : T extends 'reload' ? CadenzaReloadEvent : T extends 'selectObjects:ok' ? CadenzaSelectObjectsOkEvent : T extends 'selectObjects:cancel' ? CadenzaSelectObjectsCancelEvent : never;
|
|
879
918
|
/**
|
|
880
919
|
* - A Cadenza `postMessage()` event
|
|
881
920
|
*/
|
|
@@ -936,19 +975,6 @@ export type CadenzaErrorEvent = CadenzaEvent<'error', {
|
|
|
936
975
|
type: string;
|
|
937
976
|
message?: string;
|
|
938
977
|
}>;
|
|
939
|
-
/**
|
|
940
|
-
* - When the user opened the object info flyout.
|
|
941
|
-
*/
|
|
942
|
-
export type CadenzaObjectInfoEvent = CadenzaEvent<'objectInfo', {
|
|
943
|
-
layer: string[];
|
|
944
|
-
objectInfos: {
|
|
945
|
-
selectionIndex: number;
|
|
946
|
-
elements: {
|
|
947
|
-
attributePrintName: string;
|
|
948
|
-
formattedValue: string;
|
|
949
|
-
}[];
|
|
950
|
-
};
|
|
951
|
-
}>;
|
|
952
978
|
/**
|
|
953
979
|
* - When the user submitted the selection. `undefined` if no objects were selected.
|
|
954
980
|
*
|
|
@@ -980,7 +1006,12 @@ export type CadenzaReloadEvent = CadenzaEvent<'reload'>;
|
|
|
980
1006
|
* [target origin](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage#targetorigin) when posting events.
|
|
981
1007
|
* This is required if Cadenza and your application are not running on the same origin.
|
|
982
1008
|
* Please ensure that the user has view privilege for that link!
|
|
983
|
-
* @property {boolean} [options.debug] - Whether to enable debug logging
|
|
1009
|
+
* @property {boolean} [options.debug] - Whether to enable debug logging;
|
|
1010
|
+
* It can also be enabled/disabled at runtime via the devtools console:
|
|
1011
|
+
* ```js
|
|
1012
|
+
* localStorage.setItem('cadenzajs.debug', 'true'); // or 'false'
|
|
1013
|
+
* ```
|
|
1014
|
+
* Then you need to reload the page.
|
|
984
1015
|
* @property {boolean} [options.skipGuest] - Whether a configured guest authenticator should be ignored
|
|
985
1016
|
*/
|
|
986
1017
|
declare const CADENZAJS_VERSION: "{{version}}";
|
package/cadenza.js
CHANGED
|
@@ -8,12 +8,17 @@
|
|
|
8
8
|
* [target origin](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage#targetorigin) when posting events.
|
|
9
9
|
* This is required if Cadenza and your application are not running on the same origin.
|
|
10
10
|
* Please ensure that the user has view privilege for that link!
|
|
11
|
-
* @property {boolean} [options.debug] - Whether to enable debug logging
|
|
11
|
+
* @property {boolean} [options.debug] - Whether to enable debug logging;
|
|
12
|
+
* It can also be enabled/disabled at runtime via the devtools console:
|
|
13
|
+
* ```js
|
|
14
|
+
* localStorage.setItem('cadenzajs.debug', 'true'); // or 'false'
|
|
15
|
+
* ```
|
|
16
|
+
* Then you need to reload the page.
|
|
12
17
|
* @property {boolean} [options.skipGuest] - Whether a configured guest authenticator should be ignored
|
|
13
18
|
*/
|
|
14
19
|
// This placeholder is replaced when Cadenza JS is released,
|
|
15
20
|
// i.e. during development, the version is not available.
|
|
16
|
-
const CADENZAJS_VERSION = '10.4.
|
|
21
|
+
const CADENZAJS_VERSION = '10.4.6';
|
|
17
22
|
/**
|
|
18
23
|
* Creates an instance of the Cadenza JS client.
|
|
19
24
|
*
|
|
@@ -214,6 +219,18 @@ globalThis.cadenza = Object.assign((/** @type Parameters<cadenza> */ ...args) =>
|
|
|
214
219
|
* @property {'FeatureCollection'} type - The object's type
|
|
215
220
|
* @property {Feature[]} features - The features within this collection
|
|
216
221
|
*/
|
|
222
|
+
/**
|
|
223
|
+
* @typedef AreaIntersectionsResult - Result object of function fetchAreaIntersections
|
|
224
|
+
* @property {FeatureCollection} results - Results of the geometry intersection
|
|
225
|
+
* @property {FeatureCollection} errors - Optional listing of corrected geometries including error description
|
|
226
|
+
*/
|
|
227
|
+
/**
|
|
228
|
+
* @typedef ProblemDetails - A adapted [JSOn] IETF RFC 9457 Problem Details for HTTP APIs object
|
|
229
|
+
* @property {string} httpStatus - http status message
|
|
230
|
+
* @property {string} type - The primary identifier for the experienced problem type
|
|
231
|
+
* @property {string} key - Short version of the type
|
|
232
|
+
* @property {string} title - Summary of the problem
|
|
233
|
+
*/
|
|
217
234
|
/** @typedef {'error'|'warning'|'info'|'success'} CustomValidityType - The type of custom validity used for disclose on visual presentation and form submission behavior */
|
|
218
235
|
/**
|
|
219
236
|
* @typedef SnappingOptions
|
|
@@ -784,7 +801,6 @@ export class CadenzaClient {
|
|
|
784
801
|
* @throws For invalid arguments
|
|
785
802
|
* @fires
|
|
786
803
|
* - {@link CadenzaChangeSelectionEvent}
|
|
787
|
-
* - {@link CadenzaObjectInfoEvent}
|
|
788
804
|
* - {@link CadenzaSelectObjectsOkEvent}
|
|
789
805
|
* - {@link CadenzaSelectObjectsCancelEvent}
|
|
790
806
|
* @embed
|
|
@@ -1048,27 +1064,33 @@ export class CadenzaClient {
|
|
|
1048
1064
|
* (identified using layer paths or print names)
|
|
1049
1065
|
* @param {Geometry} geometry - The intersection geometry
|
|
1050
1066
|
* @param {object} [__namedParameters] - Options
|
|
1067
|
+
* @param {boolean} [__namedParameters.useAutoCorrection] - Enables the automatic correction of invalid geometries
|
|
1051
1068
|
* @param {Distance} [__namedParameters.buffer] - Buffer size for geometry of the transition
|
|
1069
|
+
* @param {boolean} [__namedParameters.includeGeometryValidationReport] - Enables the list of corrected geometries, including error descriptions
|
|
1052
1070
|
* @param {AbortSignal} [__namedParameters.signal] - A signal to abort the data fetching
|
|
1053
1071
|
* @param {boolean} [__namedParameters.useMapSrs] - The intersection geometry and the result geometries are in the map's SRS (otherwise EPSG:4326 is assumed)
|
|
1054
|
-
* @return {Promise<
|
|
1072
|
+
* @return {Promise<AreaIntersectionsResult | ProblemDetails>} A `Promise` for the fetch response
|
|
1055
1073
|
* @server
|
|
1056
1074
|
*/
|
|
1057
|
-
fetchAreaIntersections(source, layerPath, geometry, { buffer, signal, useMapSrs } = {}) {
|
|
1075
|
+
fetchAreaIntersections(source, layerPath, geometry, { buffer, includeGeometryValidationReport, signal, useAutoCorrection, useMapSrs, } = {}) {
|
|
1058
1076
|
this.#log('CadenzaClient#areaIntersections', ...arguments);
|
|
1059
1077
|
const params = this.#createParams({});
|
|
1060
1078
|
return this.#fetch(resolvePath(source) + '/area-intersections', params, signal, JSON.stringify({
|
|
1061
1079
|
buffer,
|
|
1080
|
+
includeGeometryValidationReport,
|
|
1062
1081
|
layerPath: array(layerPath),
|
|
1063
1082
|
geometry,
|
|
1083
|
+
useAutoCorrection,
|
|
1064
1084
|
useMapSrs,
|
|
1085
|
+
isForwardProblemDetailsEnabled: true,
|
|
1065
1086
|
})).then((response) => response.json());
|
|
1066
1087
|
}
|
|
1067
1088
|
async #fetch(
|
|
1068
1089
|
/** @type string */ path,
|
|
1069
1090
|
/** @type URLSearchParams */ params,
|
|
1070
1091
|
/** @type AbortSignal | undefined */ signal,
|
|
1071
|
-
/** @type String | undefined If body is set, the fetch will be a post.*/ body
|
|
1092
|
+
/** @type String | undefined If body is set, the fetch will be a post.*/ body,
|
|
1093
|
+
/** @type boolean */ isForwardProblemDetailsEnabled = false) {
|
|
1072
1094
|
const url = this.#createUrl(path, params);
|
|
1073
1095
|
this.#log('Fetch', url.toString());
|
|
1074
1096
|
const method = body ? 'POST' : undefined;
|
|
@@ -1084,6 +1106,11 @@ export class CadenzaClient {
|
|
|
1084
1106
|
body,
|
|
1085
1107
|
});
|
|
1086
1108
|
if (!res.ok) {
|
|
1109
|
+
const contentType = res.headers.get('content-type');
|
|
1110
|
+
if (isForwardProblemDetailsEnabled &&
|
|
1111
|
+
contentType === 'application/problem+json') {
|
|
1112
|
+
return res;
|
|
1113
|
+
}
|
|
1087
1114
|
const errorType = {
|
|
1088
1115
|
400: 'bad-request',
|
|
1089
1116
|
401: 'unauthorized',
|
|
@@ -1225,7 +1252,9 @@ export class CadenzaClient {
|
|
|
1225
1252
|
});
|
|
1226
1253
|
}
|
|
1227
1254
|
#log(/** @type unknown[] */ ...args) {
|
|
1228
|
-
|
|
1255
|
+
const debugString = localStorage.getItem('cadenzajs.debug');
|
|
1256
|
+
const debug = debugString != null ? debugString === 'true' : this.#debug;
|
|
1257
|
+
if (debug) {
|
|
1229
1258
|
/** @type {unknown[]} */
|
|
1230
1259
|
const redundantValues = [undefined, '', false];
|
|
1231
1260
|
/** @type {(value: unknown) => value is object} */
|
|
@@ -1417,7 +1446,6 @@ function getGeometryTypeFromFeatureCollection(featureCollection) {
|
|
|
1417
1446
|
* | 'editGeometry:ok'
|
|
1418
1447
|
* | 'editGeometry:update'
|
|
1419
1448
|
* | 'editGeometry:cancel'
|
|
1420
|
-
* | 'objectInfo'
|
|
1421
1449
|
* | 'reload'
|
|
1422
1450
|
* | 'selectObjects:ok'
|
|
1423
1451
|
* | 'selectObjects:cancel'
|
|
@@ -1431,7 +1459,6 @@ function getGeometryTypeFromFeatureCollection(featureCollection) {
|
|
|
1431
1459
|
* : T extends 'editGeometry:update' ? CadenzaEditGeometryUpdateEvent
|
|
1432
1460
|
* : T extends 'editGeometry:ok' ? CadenzaEditGeometryOkEvent
|
|
1433
1461
|
* : T extends 'editGeometry:cancel' ? CadenzaEditGeometryCancelEvent
|
|
1434
|
-
* : T extends 'objectInfo' ? CadenzaObjectInfoEvent
|
|
1435
1462
|
* : T extends 'reload' ? CadenzaReloadEvent
|
|
1436
1463
|
* : T extends 'selectObjects:ok' ? CadenzaSelectObjectsOkEvent
|
|
1437
1464
|
* : T extends 'selectObjects:cancel' ? CadenzaSelectObjectsCancelEvent
|
|
@@ -1471,7 +1498,6 @@ function getGeometryTypeFromFeatureCollection(featureCollection) {
|
|
|
1471
1498
|
/** @typedef {CadenzaEvent<'editGeometry:ok', FeatureCollection | Feature>} CadenzaEditGeometryOkEvent - When the user submitted the geometry. `FeatureCollection` if batch editing is enabled. */
|
|
1472
1499
|
/** @typedef {CadenzaEvent<'editGeometry:cancel'>} CadenzaEditGeometryCancelEvent - When the user cancelled the geometry editing. */
|
|
1473
1500
|
/** @typedef {CadenzaEvent<'error', {type: string, message?: string}>} CadenzaErrorEvent - An error event that is mapped to a {@link CadenzaError} */
|
|
1474
|
-
/** @typedef {CadenzaEvent<'objectInfo', {layer: WorkbookLayerPath, objectInfos: {selectionIndex: number, elements: {attributePrintName: string, formattedValue: string}[]}}>} CadenzaObjectInfoEvent - When the user opened the object info flyout. */
|
|
1475
1501
|
/**
|
|
1476
1502
|
* @typedef {CadenzaEvent<'selectObjects:ok', undefined | {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaSelectObjectsOkEvent - When the user submitted the selection. `undefined` if no objects were selected.
|
|
1477
1503
|
*
|