@disy/cadenza.js 10.3.0 → 10.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/apidoc/assets/navigation.js +1 -1
- package/apidoc/assets/search.js +1 -1
- package/apidoc/classes/AbortError.html +3 -3
- package/apidoc/classes/CadenzaClient.html +23 -21
- package/apidoc/classes/CadenzaError.html +5 -5
- package/apidoc/functions/cadenza.html +4 -4
- package/apidoc/index.html +2 -2
- package/apidoc/interfaces/CadenzaClientOptions.html +5 -5
- package/apidoc/interfaces/CadenzaEvent.html +4 -4
- package/apidoc/interfaces/Distance.html +2 -2
- package/apidoc/interfaces/ExternalLinkKey.html +4 -4
- package/apidoc/interfaces/Feature.html +9 -9
- package/apidoc/interfaces/FeatureCollection.html +4 -4
- package/apidoc/interfaces/Geometry.html +4 -4
- package/apidoc/interfaces/GeometryExtentStrategy.html +4 -4
- package/apidoc/interfaces/LayerDataExtentStrategy.html +4 -4
- package/apidoc/interfaces/LayerDefinition.html +4 -4
- package/apidoc/interfaces/LocationFinderExtentStrategy.html +4 -4
- package/apidoc/interfaces/PageSource.html +3 -3
- package/apidoc/interfaces/SnappingOptions.html +5 -0
- package/apidoc/interfaces/StaticExtentStrategy.html +4 -4
- package/apidoc/modules.html +1 -1
- package/apidoc/types/CadenzaActionEvent.html +2 -2
- package/apidoc/types/CadenzaChangeSelectionEvent.html +2 -2
- package/apidoc/types/CadenzaDrillThroughEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryCancelEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryOkEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryUpdateEvent.html +2 -2
- package/apidoc/types/CadenzaErrorEvent.html +2 -2
- package/apidoc/types/CadenzaEventByType.html +1 -1
- package/apidoc/types/CadenzaEventType.html +2 -2
- package/apidoc/types/CadenzaObjectInfoEvent.html +2 -2
- package/apidoc/types/CadenzaReloadEvent.html +2 -2
- package/apidoc/types/CadenzaSelectObjectsCancelEvent.html +2 -2
- package/apidoc/types/CadenzaSelectObjectsOkEvent.html +2 -2
- package/apidoc/types/Coordinate.html +2 -2
- package/apidoc/types/CustomValidityType.html +2 -2
- package/apidoc/types/DataType.html +2 -2
- package/apidoc/types/EmbeddingTargetId.html +2 -2
- package/apidoc/types/Extent.html +2 -2
- package/apidoc/types/ExtentStrategy.html +2 -2
- package/apidoc/types/FilterVariables.html +2 -2
- package/apidoc/types/GeometryType.html +2 -2
- package/apidoc/types/GlobalId.html +2 -2
- package/apidoc/types/LengthUnit.html +1 -1
- package/apidoc/types/OpaqueString.html +2 -2
- package/apidoc/types/OperationMode.html +2 -2
- package/apidoc/types/TablePart.html +2 -2
- package/apidoc/types/UiFeature.html +3 -2
- package/apidoc/types/WorkbookLayerPath.html +2 -2
- package/cadenza.d.ts +38 -23
- package/cadenza.js +40 -29
- package/package.json +1 -1
- package/sandbox.html +64 -21
|
@@ -1,8 +1,9 @@
|
|
|
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.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>UiFeature | Cadenza JS - v10.3.2</title><meta name="description" content="Documentation for Cadenza JS"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/DisyInformationssysteme/cadenza.js">Cadenza JS on GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Cadenza JS - v10.3.2</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Cadenza JS</a></li><li><a href="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">"geometry-edit-translate"</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></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
|
+
<li><code>"geometry-edit-translate"</code> - Enables translation interactions when editing geometries</li>
|
|
4
5
|
<li><code>"workbook-design"</code> - The workbook designer</li>
|
|
5
6
|
<li><code>"workbook-map-add-layer"</code>- Add layers to the map</li>
|
|
6
7
|
<li><code>"workbook-view-management"</code> - Add/Edit/Remove workbook views (Is included in 'workbook-design'.)</li>
|
|
7
8
|
</ul>
|
|
8
|
-
</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/
|
|
9
|
+
</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/037e35ae1a44ca6831ca9f8529a43366d8e6f89a/src/cadenza.js#L111">src/cadenza.js:111</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.3.2</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -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.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.3.2</title><meta name="description" content="Documentation for Cadenza JS"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/DisyInformationssysteme/cadenza.js">Cadenza JS on GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Cadenza JS - v10.3.2</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Cadenza JS</a></li><li><a href="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/037e35ae1a44ca6831ca9f8529a43366d8e6f89a/src/cadenza.js#L100">src/cadenza.js:100</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.3.2</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
package/cadenza.d.ts
CHANGED
|
@@ -107,6 +107,7 @@ export class CadenzaClient {
|
|
|
107
107
|
* @param {LayerDefinition[]} [__namedParameters.additionalLayers] - Layer definitions to be imported and shown in the background, as a basis for the drawing.
|
|
108
108
|
* @param {UiFeature[]} [__namedParameters.disabledUiFeatures] - Cadenza UI features to disable
|
|
109
109
|
* @param {boolean} [__namedParameters.expandNavigator] - Indicates if the navigator should be expanded.
|
|
110
|
+
* @param {ExtentStrategy} [__namedParameters.extentStrategy] - Defines the initial map extent; If not given, Cadenza's default logic is used.
|
|
110
111
|
* @param {FilterVariables} [__namedParameters.filter] - Filter variables
|
|
111
112
|
* @param {Geometry} [__namedParameters.geometry] - A geometry to show on the map
|
|
112
113
|
* @param {boolean} [__namedParameters.hideMainHeaderAndFooter] - Whether to hide the main Cadenza header and footer
|
|
@@ -117,7 +118,6 @@ export class CadenzaClient {
|
|
|
117
118
|
* @param {OperationMode} [__namedParameters.operationMode] - The mode in which a workbook should be operated
|
|
118
119
|
* @param {AbortSignal} [__namedParameters.signal] - A signal to abort the iframe loading
|
|
119
120
|
* @param {boolean} [__namedParameters.useMapSrs] - Whether the coordinates specified in other parameters are specified in the map's SRS (otherwise EPSG:4326 is assumed)
|
|
120
|
-
* @param {ExtentStrategy} [__namedParameters.extentStrategy] - Defines the initial map extent; If not given, Cadenza's default logic is used.
|
|
121
121
|
* @return {Promise<void>} A `Promise` for when the iframe is loaded
|
|
122
122
|
* @throws For invalid arguments
|
|
123
123
|
* @fires
|
|
@@ -125,10 +125,11 @@ export class CadenzaClient {
|
|
|
125
125
|
* - {@link CadenzaActionEvent}
|
|
126
126
|
* @embed
|
|
127
127
|
*/
|
|
128
|
-
showMap(mapView: EmbeddingTargetId, { disabledUiFeatures, expandNavigator, filter, geometry, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, locationFinder, mapExtent, operationMode, useMapSrs,
|
|
128
|
+
showMap(mapView: EmbeddingTargetId, { additionalLayers, disabledUiFeatures, expandNavigator, extentStrategy, filter, geometry, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, locationFinder, mapExtent, operationMode, useMapSrs, signal, }?: {
|
|
129
129
|
additionalLayers?: LayerDefinition[] | undefined;
|
|
130
130
|
disabledUiFeatures?: UiFeature[] | undefined;
|
|
131
131
|
expandNavigator?: boolean | undefined;
|
|
132
|
+
extentStrategy?: ExtentStrategy | undefined;
|
|
132
133
|
filter?: FilterVariables | undefined;
|
|
133
134
|
geometry?: Geometry | undefined;
|
|
134
135
|
hideMainHeaderAndFooter?: boolean | undefined;
|
|
@@ -139,7 +140,6 @@ export class CadenzaClient {
|
|
|
139
140
|
operationMode?: OperationMode | undefined;
|
|
140
141
|
signal?: AbortSignal | undefined;
|
|
141
142
|
useMapSrs?: boolean | undefined;
|
|
142
|
-
extentStrategy?: ExtentStrategy | undefined;
|
|
143
143
|
} | undefined, ...args: any[]): Promise<void>;
|
|
144
144
|
/**
|
|
145
145
|
* Expand/collapse the navigator.
|
|
@@ -236,14 +236,15 @@ export class CadenzaClient {
|
|
|
236
236
|
* @param {object} [__namedParameters] - Options
|
|
237
237
|
* @param {LayerDefinition[]} [__namedParameters.additionalLayers] - Layer definitions to be imported and shown in the background, as a basis for the drawing.
|
|
238
238
|
* @param {UiFeature[]} [__namedParameters.disabledUiFeatures] - Cadenza UI features to disable
|
|
239
|
+
* @param {ExtentStrategy} [__namedParameters.extentStrategy] - Defines the initial map extent; If not given, Cadenza's default logic is used.
|
|
239
240
|
* @param {FilterVariables} [__namedParameters.filter] - Filter variables
|
|
240
241
|
* @param {string} [__namedParameters.locationFinder] - A search query for the location finder - _Deprecated_: Use {@link LocationFinderExtentStrategy} instead.
|
|
241
242
|
* @param {Extent} [__namedParameters.mapExtent] - A map extent to set - _Deprecated_: Use {@link StaticExtentStrategy} instead.
|
|
242
243
|
* @param {number} [__namedParameters.minScale] - The minimum scale where the user should work on. A warning is shown when the map is zoomed out above the threshold.
|
|
243
244
|
* @param {OperationMode} [__namedParameters.operationMode] - The mode in which a workbook should be operated
|
|
244
245
|
* @param {AbortSignal} [__namedParameters.signal] - A signal to abort the iframe loading
|
|
246
|
+
* @param {SnappingOptions} [__namedParameters.snapping] - Passing these options enables snapping
|
|
245
247
|
* @param {boolean} [__namedParameters.useMapSrs] - Whether the coordinates specified in other parameters are specified in the map's SRS and the created geometry should use the map's SRS (otherwise EPSG:4326 is assumed)
|
|
246
|
-
* @param {ExtentStrategy} [__namedParameters.extentStrategy] - Defines the initial map extent; If not given, Cadenza's default logic is used.
|
|
247
248
|
* @return {Promise<void>} A `Promise` for when the iframe is loaded
|
|
248
249
|
* @throws For invalid arguments
|
|
249
250
|
* @fires
|
|
@@ -252,17 +253,18 @@ export class CadenzaClient {
|
|
|
252
253
|
* - {@link CadenzaEditGeometryCancelEvent}
|
|
253
254
|
* @embed
|
|
254
255
|
*/
|
|
255
|
-
createGeometry(backgroundMapView: EmbeddingTargetId, geometryType: GeometryType, { additionalLayers, disabledUiFeatures, filter, locationFinder, mapExtent, minScale, useMapSrs, operationMode, signal,
|
|
256
|
+
createGeometry(backgroundMapView: EmbeddingTargetId, geometryType: GeometryType, { additionalLayers, disabledUiFeatures, extentStrategy, filter, locationFinder, mapExtent, minScale, useMapSrs, operationMode, signal, snapping, }?: {
|
|
256
257
|
additionalLayers?: LayerDefinition[] | undefined;
|
|
257
258
|
disabledUiFeatures?: UiFeature[] | undefined;
|
|
259
|
+
extentStrategy?: ExtentStrategy | undefined;
|
|
258
260
|
filter?: FilterVariables | undefined;
|
|
259
261
|
locationFinder?: string | undefined;
|
|
260
262
|
mapExtent?: Extent | undefined;
|
|
261
263
|
minScale?: number | undefined;
|
|
262
264
|
operationMode?: OperationMode | undefined;
|
|
263
265
|
signal?: AbortSignal | undefined;
|
|
266
|
+
snapping?: SnappingOptions | undefined;
|
|
264
267
|
useMapSrs?: boolean | undefined;
|
|
265
|
-
extentStrategy?: ExtentStrategy | undefined;
|
|
266
268
|
} | undefined, ...args: any[]): Promise<void>;
|
|
267
269
|
/**
|
|
268
270
|
* Edit a geometry.
|
|
@@ -272,14 +274,15 @@ export class CadenzaClient {
|
|
|
272
274
|
* @param {object} [__namedParameters] - Options
|
|
273
275
|
* @param {LayerDefinition[]} [__namedParameters.additionalLayers] - Layer definitions to be imported and shown in the background, as a basis for the drawing. Each is a layer definition, with name, type and content (a Geojson featureCollection).
|
|
274
276
|
* @param {UiFeature[]} [__namedParameters.disabledUiFeatures] - Cadenza UI features to disable
|
|
277
|
+
* @param {ExtentStrategy} [__namedParameters.extentStrategy] - Defines the initial map extent; If not given, Cadenza's default logic is used.
|
|
275
278
|
* @param {FilterVariables} [__namedParameters.filter] - Filter variables
|
|
276
279
|
* @param {string} [__namedParameters.locationFinder] - A search query for the location finder - _Deprecated_: Use {@link LocationFinderExtentStrategy} instead.
|
|
277
280
|
* @param {Extent} [__namedParameters.mapExtent] - A map extent to set - _Deprecated_: Use {@link StaticExtentStrategy} instead.
|
|
278
281
|
* @param {number} [__namedParameters.minScale] - The minimum scale where the user should work on. A warning is shown when the map is zoomed out above the threshold.
|
|
279
282
|
* @param {OperationMode} [__namedParameters.operationMode] - The mode in which a workbook should be operated
|
|
280
283
|
* @param {AbortSignal} [__namedParameters.signal] - A signal to abort the iframe loading
|
|
284
|
+
* @param {SnappingOptions} [__namedParameters.snapping] - Passing these options enables snapping
|
|
281
285
|
* @param {boolean} [__namedParameters.useMapSrs] - Whether the coordinates specified in other parameters are specified in the map's SRS (otherwise EPSG:4326 is assumed)
|
|
282
|
-
* @param {ExtentStrategy} [__namedParameters.extentStrategy] - Defines the initial map extent; If not given, Cadenza's default logic is used.
|
|
283
286
|
* @return {Promise<void>} A `Promise` for when the iframe is loaded
|
|
284
287
|
* @throws For invalid arguments
|
|
285
288
|
* @fires
|
|
@@ -288,17 +291,18 @@ export class CadenzaClient {
|
|
|
288
291
|
* - {@link CadenzaEditGeometryCancelEvent}
|
|
289
292
|
* @embed
|
|
290
293
|
*/
|
|
291
|
-
editGeometry(backgroundMapView: EmbeddingTargetId, geometry: Geometry, { additionalLayers, disabledUiFeatures, filter, locationFinder, mapExtent, minScale, operationMode, signal,
|
|
294
|
+
editGeometry(backgroundMapView: EmbeddingTargetId, geometry: Geometry, { additionalLayers, disabledUiFeatures, extentStrategy, filter, locationFinder, mapExtent, minScale, operationMode, signal, snapping, useMapSrs, }?: {
|
|
292
295
|
additionalLayers?: LayerDefinition[] | undefined;
|
|
293
296
|
disabledUiFeatures?: UiFeature[] | undefined;
|
|
297
|
+
extentStrategy?: ExtentStrategy | undefined;
|
|
294
298
|
filter?: FilterVariables | undefined;
|
|
295
299
|
locationFinder?: string | undefined;
|
|
296
300
|
mapExtent?: Extent | undefined;
|
|
297
301
|
minScale?: number | undefined;
|
|
298
302
|
operationMode?: OperationMode | undefined;
|
|
299
303
|
signal?: AbortSignal | undefined;
|
|
304
|
+
snapping?: SnappingOptions | undefined;
|
|
300
305
|
useMapSrs?: boolean | undefined;
|
|
301
|
-
extentStrategy?: ExtentStrategy | undefined;
|
|
302
306
|
} | undefined, ...args: any[]): Promise<void>;
|
|
303
307
|
/**
|
|
304
308
|
* Set custom validity state of the geometry editor in addition to the default validation state (including errors and
|
|
@@ -315,6 +319,7 @@ export class CadenzaClient {
|
|
|
315
319
|
*
|
|
316
320
|
* @param {EmbeddingTargetId} backgroundMapView - The workbook map view
|
|
317
321
|
* @param {object} [__namedParameters] - Options
|
|
322
|
+
* @param {ExtentStrategy} [__namedParameters.extentStrategy] - Defines the initial map extent; If not given, Cadenza's default logic is used.
|
|
318
323
|
* @param {FilterVariables} [__namedParameters.filter] - Filter variables
|
|
319
324
|
* @param {(WorkbookLayerPath | string)[]} [__namedParameters.layers] - Layers to restrict the selection to
|
|
320
325
|
* (identified using layer paths or print names)
|
|
@@ -323,7 +328,6 @@ export class CadenzaClient {
|
|
|
323
328
|
* @param {boolean} [__namedParameters.useMapSrs] - Whether the coordinates specified in other parameters are specified in the map's SRS (otherwise EPSG:4326 is assumed)
|
|
324
329
|
* @param {OperationMode} [__namedParameters.operationMode] - The mode in which a workbook should be operated
|
|
325
330
|
* @param {AbortSignal} [__namedParameters.signal] - A signal to abort the iframe loading
|
|
326
|
-
* @param {ExtentStrategy} [__namedParameters.extentStrategy] - Defines the initial map extent; If not given, Cadenza's default logic is used.
|
|
327
331
|
* @return {Promise<void>} A `Promise` for when the iframe is loaded
|
|
328
332
|
* @throws For invalid arguments
|
|
329
333
|
* @fires
|
|
@@ -333,7 +337,8 @@ export class CadenzaClient {
|
|
|
333
337
|
* - {@link CadenzaSelectObjectsCancelEvent}
|
|
334
338
|
* @embed
|
|
335
339
|
*/
|
|
336
|
-
selectObjects(backgroundMapView: EmbeddingTargetId, { filter, layers, locationFinder, mapExtent, useMapSrs, operationMode, signal,
|
|
340
|
+
selectObjects(backgroundMapView: EmbeddingTargetId, { extentStrategy, filter, layers, locationFinder, mapExtent, useMapSrs, operationMode, signal, }?: {
|
|
341
|
+
extentStrategy?: ExtentStrategy | undefined;
|
|
337
342
|
filter?: FilterVariables | undefined;
|
|
338
343
|
layers?: (string | WorkbookLayerPath)[] | undefined;
|
|
339
344
|
locationFinder?: string | undefined;
|
|
@@ -341,7 +346,6 @@ export class CadenzaClient {
|
|
|
341
346
|
useMapSrs?: boolean | undefined;
|
|
342
347
|
operationMode?: OperationMode | undefined;
|
|
343
348
|
signal?: AbortSignal | undefined;
|
|
344
|
-
extentStrategy?: ExtentStrategy | undefined;
|
|
345
349
|
} | undefined, ...args: any[]): Promise<void>;
|
|
346
350
|
/**
|
|
347
351
|
* Subscribe to a `postMessage()` event.
|
|
@@ -388,17 +392,17 @@ export class CadenzaClient {
|
|
|
388
392
|
* @param {unknown[][]} objectIds - The IDs of the objects to select
|
|
389
393
|
* @param {object} [__namedParameters] - Options
|
|
390
394
|
* @param {FilterVariables} [__namedParameters.filter] - Filter variables
|
|
395
|
+
* @param {Boolean} [__namedParameters.fullGeometries] - Return non-simplified geometries
|
|
391
396
|
* @param {AbortSignal} [__namedParameters.signal] - A signal to abort the data fetching
|
|
392
397
|
* @param {Boolean} [__namedParameters.useMapSrs] - Use the map SRS instead of WGS84
|
|
393
|
-
* @param {Boolean} [__namedParameters.fullGeometries] - Return non-simplified geometries
|
|
394
398
|
* @return {Promise<FeatureCollection>} A `Promise` for the fetch response
|
|
395
399
|
* @throws For invalid arguments
|
|
396
400
|
*/
|
|
397
|
-
fetchObjectInfo(source: EmbeddingTargetId, layerPath: (WorkbookLayerPath | string)[], objectIds: unknown[][], { filter, signal,
|
|
401
|
+
fetchObjectInfo(source: EmbeddingTargetId, layerPath: (WorkbookLayerPath | string)[], objectIds: unknown[][], { filter, signal, fullGeometries, useMapSrs }?: {
|
|
398
402
|
filter?: FilterVariables | undefined;
|
|
403
|
+
fullGeometries?: boolean | undefined;
|
|
399
404
|
signal?: AbortSignal | undefined;
|
|
400
405
|
useMapSrs?: boolean | undefined;
|
|
401
|
-
fullGeometries?: boolean | undefined;
|
|
402
406
|
} | undefined, ...args: any[]): Promise<FeatureCollection>;
|
|
403
407
|
/**
|
|
404
408
|
* Fetch the intersection areas from a workbook map view layer in JSON format for a given area.
|
|
@@ -408,16 +412,16 @@ export class CadenzaClient {
|
|
|
408
412
|
* (identified using layer paths or print names)
|
|
409
413
|
* @param {Geometry} geometry - The intersection geometry
|
|
410
414
|
* @param {object} [__namedParameters] - Options
|
|
411
|
-
* @param {boolean} [__namedParameters.useMapSrs] - The intersection geometry and the result geometries are in the map's SRS (otherwise EPSG:4326 is assumed)
|
|
412
415
|
* @param {Distance} [__namedParameters.buffer] - Buffer size for geometry of the transition
|
|
413
416
|
* @param {AbortSignal} [__namedParameters.signal] - A signal to abort the data fetching
|
|
417
|
+
* @param {boolean} [__namedParameters.useMapSrs] - The intersection geometry and the result geometries are in the map's SRS (otherwise EPSG:4326 is assumed)
|
|
414
418
|
* @return {Promise<FeatureCollection>} A `Promise` for the fetch response
|
|
415
419
|
* @server
|
|
416
420
|
*/
|
|
417
|
-
fetchAreaIntersections(source: EmbeddingTargetId, layerPath: (WorkbookLayerPath | string)[], geometry: Geometry, {
|
|
418
|
-
useMapSrs?: boolean | undefined;
|
|
421
|
+
fetchAreaIntersections(source: EmbeddingTargetId, layerPath: (WorkbookLayerPath | string)[], geometry: Geometry, { buffer, signal, useMapSrs }?: {
|
|
419
422
|
buffer?: Distance | undefined;
|
|
420
423
|
signal?: AbortSignal | undefined;
|
|
424
|
+
useMapSrs?: boolean | undefined;
|
|
421
425
|
} | undefined, ...args: any[]): Promise<FeatureCollection>;
|
|
422
426
|
/**
|
|
423
427
|
* Download data from a workbook view.
|
|
@@ -451,9 +455,9 @@ export class CadenzaClient {
|
|
|
451
455
|
* | 'editGeometry:update'
|
|
452
456
|
* | 'editGeometry:cancel'
|
|
453
457
|
* | 'objectInfo'
|
|
458
|
+
* | 'reload'
|
|
454
459
|
* | 'selectObjects:ok'
|
|
455
460
|
* | 'selectObjects:cancel'
|
|
456
|
-
* | 'reload'
|
|
457
461
|
* } CadenzaEventType - An event type to subscribe to using {@link CadenzaClient#on}
|
|
458
462
|
*/
|
|
459
463
|
/**
|
|
@@ -465,9 +469,9 @@ export class CadenzaClient {
|
|
|
465
469
|
* : T extends 'editGeometry:ok' ? CadenzaEditGeometryOkEvent
|
|
466
470
|
* : T extends 'editGeometry:cancel' ? CadenzaEditGeometryCancelEvent
|
|
467
471
|
* : T extends 'objectInfo' ? CadenzaObjectInfoEvent
|
|
472
|
+
* : T extends 'reload' ? CadenzaReloadEvent
|
|
468
473
|
* : T extends 'selectObjects:ok' ? CadenzaSelectObjectsOkEvent
|
|
469
474
|
* : T extends 'selectObjects:cancel' ? CadenzaSelectObjectsCancelEvent
|
|
470
|
-
* : T extends 'reload' ? CadenzaReloadEvent
|
|
471
475
|
* : never
|
|
472
476
|
* } CadenzaEventByType
|
|
473
477
|
*/
|
|
@@ -620,11 +624,12 @@ export type OperationMode = 'normal' | 'simplified';
|
|
|
620
624
|
* - The name of a Cadenza UI feature
|
|
621
625
|
*
|
|
622
626
|
* _Note:_ Supported features are:
|
|
627
|
+
* * `"geometry-edit-translate"` - Enables translation interactions when editing geometries
|
|
623
628
|
* * `"workbook-design"` - The workbook designer
|
|
624
629
|
* * `"workbook-map-add-layer"`- Add layers to the map
|
|
625
630
|
* * `"workbook-view-management"` - Add/Edit/Remove workbook views (Is included in 'workbook-design'.)
|
|
626
631
|
*/
|
|
627
|
-
export type UiFeature = 'workbook-design' | 'workbook-map-add-layer' | 'workbook-view-management';
|
|
632
|
+
export type UiFeature = 'geometry-edit-translate' | 'workbook-design' | 'workbook-map-add-layer' | 'workbook-view-management';
|
|
628
633
|
export type LayerDefinition = {
|
|
629
634
|
/**
|
|
630
635
|
* - The layer's name.
|
|
@@ -800,11 +805,21 @@ export type FeatureCollection = {
|
|
|
800
805
|
* - The type of custom validity used for disclose on visual presentation and form submission behavior
|
|
801
806
|
*/
|
|
802
807
|
export type CustomValidityType = 'error' | 'warning' | 'info' | 'success';
|
|
808
|
+
export type SnappingOptions = {
|
|
809
|
+
/**
|
|
810
|
+
* - The layer to snap to
|
|
811
|
+
*/
|
|
812
|
+
layer: WorkbookLayerPath | string;
|
|
813
|
+
/**
|
|
814
|
+
* - Snapping types; Without this option, the Cadenza default snapping types are used.
|
|
815
|
+
*/
|
|
816
|
+
types?: ("toVertices" | "toEdges" | "lineTracing")[] | undefined;
|
|
817
|
+
};
|
|
803
818
|
/**
|
|
804
819
|
* - An event type to subscribe to using {@link CadenzaClienton }
|
|
805
820
|
*/
|
|
806
|
-
export type CadenzaEventType = 'action' | 'change:selection' | 'drillThrough' | 'editGeometry:ok' | 'editGeometry:update' | 'editGeometry:cancel' | 'objectInfo' | '
|
|
807
|
-
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 'objectInfo' ? CadenzaObjectInfoEvent : T extends '
|
|
821
|
+
export type CadenzaEventType = 'action' | 'change:selection' | 'drillThrough' | 'editGeometry:ok' | 'editGeometry:update' | 'editGeometry:cancel' | 'objectInfo' | 'reload' | 'selectObjects:ok' | 'selectObjects:cancel';
|
|
822
|
+
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 'objectInfo' ? CadenzaObjectInfoEvent : T extends 'reload' ? CadenzaReloadEvent : T extends 'selectObjects:ok' ? CadenzaSelectObjectsOkEvent : T extends 'selectObjects:cancel' ? CadenzaSelectObjectsCancelEvent : never;
|
|
808
823
|
/**
|
|
809
824
|
* - A Cadenza `postMessage()` event
|
|
810
825
|
*/
|