@disy/cadenza.js 10.5.5 → 10.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +6 -0
- package/apidoc/assets/search.js +1 -1
- package/apidoc/classes/AbortError.html +3 -3
- package/apidoc/classes/CadenzaClient.html +35 -31
- package/apidoc/classes/CadenzaError.html +5 -5
- package/apidoc/functions/cadenza.html +4 -4
- package/apidoc/index.html +21 -21
- package/apidoc/interfaces/AreaIntersectionsResult.html +4 -4
- package/apidoc/interfaces/CadenzaClientOptions.html +6 -6
- package/apidoc/interfaces/CadenzaEvent.html +4 -4
- package/apidoc/interfaces/CommonEditGeometryOptions.html +13 -11
- package/apidoc/interfaces/Distance.html +2 -2
- package/apidoc/interfaces/ExternalLinkKey.html +4 -4
- package/apidoc/interfaces/Feature.html +9 -9
- package/apidoc/interfaces/FeatureCollection.html +4 -4
- package/apidoc/interfaces/Geometry.html +4 -4
- package/apidoc/interfaces/GeometryExtentStrategy.html +4 -4
- package/apidoc/interfaces/LayerDataExtentStrategy.html +4 -4
- package/apidoc/interfaces/LayerDefinition.html +4 -4
- package/apidoc/interfaces/LocationFinderExtentStrategy.html +4 -4
- package/apidoc/interfaces/PageSource.html +3 -3
- package/apidoc/interfaces/ProblemDetails.html +6 -6
- package/apidoc/interfaces/SnappingOptions.html +3 -3
- package/apidoc/interfaces/SpatialFilterValue.html +4 -4
- package/apidoc/interfaces/StaticExtentStrategy.html +4 -4
- package/apidoc/modules.html +1 -1
- package/apidoc/types/CadenzaActionEvent.html +2 -2
- package/apidoc/types/CadenzaChangeExtentEvent.html +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/CadenzaEditGeometryCreateEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryDeleteEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryEditEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryOkEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryUpdateEvent.html +2 -2
- package/apidoc/types/CadenzaErrorEvent.html +2 -2
- package/apidoc/types/CadenzaEventByType.html +1 -1
- package/apidoc/types/CadenzaEventType.html +2 -2
- package/apidoc/types/CadenzaReloadEvent.html +2 -2
- package/apidoc/types/CadenzaSelectObjectsCancelEvent.html +2 -2
- package/apidoc/types/CadenzaSelectObjectsOkEvent.html +2 -2
- package/apidoc/types/Coordinate.html +2 -2
- package/apidoc/types/CustomValidityType.html +2 -2
- package/apidoc/types/DataType.html +2 -2
- package/apidoc/types/EmbeddingTargetId.html +2 -2
- package/apidoc/types/Extent.html +2 -2
- package/apidoc/types/ExtentStrategy.html +2 -2
- package/apidoc/types/FilterVariables.html +2 -2
- package/apidoc/types/GeometryType.html +2 -2
- package/apidoc/types/GlobalId.html +2 -2
- package/apidoc/types/Layout.html +2 -2
- package/apidoc/types/LengthUnit.html +1 -1
- package/apidoc/types/OpaqueString.html +2 -2
- package/apidoc/types/OperationMode.html +2 -2
- package/apidoc/types/Polygon.html +1 -1
- package/apidoc/types/SpatialRelation.html +2 -2
- package/apidoc/types/TablePart.html +2 -2
- package/apidoc/types/UiFeature.html +2 -2
- package/apidoc/types/WorkbookLayerPath.html +2 -2
- package/apidoc/types/WorksheetPlaceholders.html +2 -2
- package/cadenza.d.ts +18 -9
- package/cadenza.js +26 -11
- package/package.json +3 -5
- package/sandbox.html +15 -4
|
@@ -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.
|
|
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.6.0</title><meta name="description" content="Documentation for Cadenza JS"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/DisyInformationssysteme/cadenza.js">Cadenza JS on GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Cadenza JS - v10.6.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Cadenza JS</a></li><li><a href="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/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/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.6.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
|
@@ -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>WorksheetPlaceholders | Cadenza JS - v10.
|
|
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>WorksheetPlaceholders | Cadenza JS - v10.6.0</title><meta name="description" content="Documentation for Cadenza JS"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/DisyInformationssysteme/cadenza.js">Cadenza JS on GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Cadenza JS - v10.6.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Cadenza JS</a></li><li><a href="WorksheetPlaceholders.html">WorksheetPlaceholders</a></li></ul><h1>Type Alias WorksheetPlaceholders</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">WorksheetPlaceholders</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</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>Maps the worksheet placeholder IDs in report embeddings to the print names of the worksheets to replace them with.</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/de62c3b4ea2e61fadcfbecc0ffac98e74ad60a04/src/cadenza.js#L242">src/cadenza.js:242</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.6.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>
|
package/cadenza.d.ts
CHANGED
|
@@ -245,7 +245,7 @@ export class CadenzaClient {
|
|
|
245
245
|
* - {@link CadenzaEditGeometryCancelEvent}
|
|
246
246
|
* @embed
|
|
247
247
|
*/
|
|
248
|
-
createGeometry(backgroundMapView: EmbeddingTargetId, geometryType: GeometryType, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, useMapSrs, operationMode, signal, snapping, }?: CommonEditGeometryOptions | undefined, ...args: any[]): Promise<void>;
|
|
248
|
+
createGeometry(backgroundMapView: EmbeddingTargetId, geometryType: GeometryType, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, useMapSrs, operationMode, signal, snapping, hideLegend, }?: CommonEditGeometryOptions | undefined, ...args: any[]): Promise<void>;
|
|
249
249
|
/**
|
|
250
250
|
* Edit a geometry.
|
|
251
251
|
*
|
|
@@ -262,7 +262,7 @@ export class CadenzaClient {
|
|
|
262
262
|
* - {@link CadenzaEditGeometryCancelEvent}
|
|
263
263
|
* @embed
|
|
264
264
|
*/
|
|
265
|
-
editGeometry(backgroundMapView: EmbeddingTargetId, geometry: Geometry, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, operationMode, signal, snapping, useMapSrs, }?: CommonEditGeometryOptions | undefined, ...args: any[]): Promise<void>;
|
|
265
|
+
editGeometry(backgroundMapView: EmbeddingTargetId, geometry: Geometry, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, operationMode, signal, snapping, useMapSrs, hideLegend, }?: CommonEditGeometryOptions | undefined, ...args: any[]): Promise<void>;
|
|
266
266
|
/**
|
|
267
267
|
* Create multiple geometries.
|
|
268
268
|
*
|
|
@@ -282,7 +282,7 @@ export class CadenzaClient {
|
|
|
282
282
|
* - {@link CadenzaEditGeometryCancelEvent}
|
|
283
283
|
* @embed
|
|
284
284
|
*/
|
|
285
|
-
batchCreateGeometry(backgroundMapView: EmbeddingTargetId, geometryType: GeometryType, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, operationMode, signal, snapping, useMapSrs, }?: CommonEditGeometryOptions | undefined, ...args: any[]): Promise<void>;
|
|
285
|
+
batchCreateGeometry(backgroundMapView: EmbeddingTargetId, geometryType: GeometryType, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, operationMode, signal, snapping, useMapSrs, hideLegend, }?: CommonEditGeometryOptions | undefined, ...args: any[]): Promise<void>;
|
|
286
286
|
/**
|
|
287
287
|
* Edit multiple geometries.
|
|
288
288
|
*
|
|
@@ -302,13 +302,18 @@ export class CadenzaClient {
|
|
|
302
302
|
* - {@link CadenzaEditGeometryCancelEvent}
|
|
303
303
|
* @embed
|
|
304
304
|
*/
|
|
305
|
-
batchEditGeometry(backgroundMapView: EmbeddingTargetId, features: FeatureCollection, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, operationMode, signal, snapping, useMapSrs, }?: CommonEditGeometryOptions | undefined, ...args: any[]): Promise<void>;
|
|
305
|
+
batchEditGeometry(backgroundMapView: EmbeddingTargetId, features: FeatureCollection, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, operationMode, signal, snapping, useMapSrs, hideLegend, }?: CommonEditGeometryOptions | undefined, ...args: any[]): Promise<void>;
|
|
306
306
|
/**
|
|
307
|
-
* Set custom
|
|
308
|
-
*
|
|
309
|
-
*
|
|
310
|
-
*
|
|
311
|
-
*
|
|
307
|
+
* Set the custom validation status of the geometry editor dialog ( {@link createGeometry}, {@link editGeometry}, {@link batchCreateGeometry}, {@link batchEditGeometry} )
|
|
308
|
+
* or the {@link selectObjects} dialog in addition to the default validation status (including errors and warnings).
|
|
309
|
+
*
|
|
310
|
+
* Behavior:
|
|
311
|
+
* - When the custom validation status is of type 'error', the dialog submission is blocked.
|
|
312
|
+
* - If a custom validation status is already set, it will be overwritten.
|
|
313
|
+
* - Passing '' (an empty string) as the message parameter resets the custom validation status, which means no custom validation status is displayed.
|
|
314
|
+
*
|
|
315
|
+
* If neither the geometry editor nor {@link selectObjects} is started, the method call has no effect.
|
|
316
|
+
*
|
|
312
317
|
* @param {string} message The message to show in the dialog
|
|
313
318
|
* @param {CustomValidityType} [type] The type of message (defaults to 'error')
|
|
314
319
|
*/
|
|
@@ -795,6 +800,10 @@ export type CommonEditGeometryOptions = {
|
|
|
795
800
|
* - Passing these options enables snapping
|
|
796
801
|
*/
|
|
797
802
|
snapping?: SnappingOptions | undefined;
|
|
803
|
+
/**
|
|
804
|
+
* - Whether the legend should be hidden initially. Default is true.
|
|
805
|
+
*/
|
|
806
|
+
hideLegend?: boolean | undefined;
|
|
798
807
|
/**
|
|
799
808
|
* - 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)
|
|
800
809
|
*/
|
package/cadenza.js
CHANGED
|
@@ -18,7 +18,7 @@
|
|
|
18
18
|
*/
|
|
19
19
|
// This placeholder is replaced when Cadenza JS is released,
|
|
20
20
|
// i.e. during development, the version is not available.
|
|
21
|
-
const CADENZAJS_VERSION = '10.
|
|
21
|
+
const CADENZAJS_VERSION = '10.6.0';
|
|
22
22
|
/**
|
|
23
23
|
* Creates an instance of the Cadenza JS client.
|
|
24
24
|
*
|
|
@@ -177,6 +177,7 @@ globalThis.cadenza = Object.assign((/** @type Parameters<cadenza> */ ...args) =>
|
|
|
177
177
|
* @property {OperationMode} [operationMode] - The mode in which a workbook should be operated
|
|
178
178
|
* @property {AbortSignal} [signal] - A signal to abort the iframe loading
|
|
179
179
|
* @property {SnappingOptions} [snapping] - Passing these options enables snapping
|
|
180
|
+
* @property {boolean} [hideLegend] - Whether the legend should be hidden initially. Default is true.
|
|
180
181
|
* @property {boolean} [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)
|
|
181
182
|
*/
|
|
182
183
|
/**
|
|
@@ -602,7 +603,7 @@ export class CadenzaClient {
|
|
|
602
603
|
* - {@link CadenzaEditGeometryCancelEvent}
|
|
603
604
|
* @embed
|
|
604
605
|
*/
|
|
605
|
-
async createGeometry(backgroundMapView, geometryType, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, useMapSrs, operationMode, signal, snapping, } = {}) {
|
|
606
|
+
async createGeometry(backgroundMapView, geometryType, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, useMapSrs, operationMode, signal, snapping, hideLegend = true, } = {}) {
|
|
606
607
|
this.#log('CadenzaClient#createGeometry', ...arguments);
|
|
607
608
|
const validExtentStrategy = sanitizeExtentStrategy({
|
|
608
609
|
extentStrategy,
|
|
@@ -612,6 +613,7 @@ export class CadenzaClient {
|
|
|
612
613
|
disabledUiFeatures,
|
|
613
614
|
filter,
|
|
614
615
|
geometryType,
|
|
616
|
+
hideLegend,
|
|
615
617
|
minScale,
|
|
616
618
|
operationMode,
|
|
617
619
|
snapping,
|
|
@@ -641,7 +643,7 @@ export class CadenzaClient {
|
|
|
641
643
|
* - {@link CadenzaEditGeometryCancelEvent}
|
|
642
644
|
* @embed
|
|
643
645
|
*/
|
|
644
|
-
async editGeometry(backgroundMapView, geometry, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, operationMode, signal, snapping, useMapSrs, } = {}) {
|
|
646
|
+
async editGeometry(backgroundMapView, geometry, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, operationMode, signal, snapping, useMapSrs, hideLegend = true, } = {}) {
|
|
645
647
|
this.#log('CadenzaClient#editGeometry', ...arguments);
|
|
646
648
|
const geometryType = geometry.type;
|
|
647
649
|
assertValidGeometryType(geometryType);
|
|
@@ -654,6 +656,7 @@ export class CadenzaClient {
|
|
|
654
656
|
disabledUiFeatures,
|
|
655
657
|
filter,
|
|
656
658
|
geometryType,
|
|
659
|
+
hideLegend,
|
|
657
660
|
minScale,
|
|
658
661
|
operationMode,
|
|
659
662
|
snapping,
|
|
@@ -687,7 +690,7 @@ export class CadenzaClient {
|
|
|
687
690
|
* - {@link CadenzaEditGeometryCancelEvent}
|
|
688
691
|
* @embed
|
|
689
692
|
*/
|
|
690
|
-
async batchCreateGeometry(backgroundMapView, geometryType, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, operationMode, signal, snapping, useMapSrs, } = {}) {
|
|
693
|
+
async batchCreateGeometry(backgroundMapView, geometryType, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, operationMode, signal, snapping, useMapSrs, hideLegend = true, } = {}) {
|
|
691
694
|
this.#log('CadenzaClient#editGeometry', ...arguments);
|
|
692
695
|
assertValidGeometryType(geometryType);
|
|
693
696
|
const validExtentStrategy = sanitizeExtentStrategy({
|
|
@@ -699,6 +702,7 @@ export class CadenzaClient {
|
|
|
699
702
|
disabledUiFeatures,
|
|
700
703
|
filter,
|
|
701
704
|
geometryType,
|
|
705
|
+
hideLegend,
|
|
702
706
|
minScale,
|
|
703
707
|
operationMode,
|
|
704
708
|
snapping,
|
|
@@ -731,7 +735,7 @@ export class CadenzaClient {
|
|
|
731
735
|
* - {@link CadenzaEditGeometryCancelEvent}
|
|
732
736
|
* @embed
|
|
733
737
|
*/
|
|
734
|
-
async batchEditGeometry(backgroundMapView, features, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, operationMode, signal, snapping, useMapSrs, } = {}) {
|
|
738
|
+
async batchEditGeometry(backgroundMapView, features, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, operationMode, signal, snapping, useMapSrs, hideLegend = true, } = {}) {
|
|
735
739
|
this.#log('CadenzaClient#editGeometry', ...arguments);
|
|
736
740
|
const geometryType = getGeometryTypeFromFeatureCollection(features);
|
|
737
741
|
const validExtentStrategy = sanitizeExtentStrategy({
|
|
@@ -744,6 +748,7 @@ export class CadenzaClient {
|
|
|
744
748
|
disabledUiFeatures,
|
|
745
749
|
filter,
|
|
746
750
|
geometryType,
|
|
751
|
+
hideLegend,
|
|
747
752
|
minScale,
|
|
748
753
|
operationMode,
|
|
749
754
|
snapping,
|
|
@@ -813,15 +818,23 @@ export class CadenzaClient {
|
|
|
813
818
|
#setEditFeature(objectId) {
|
|
814
819
|
return this.#postRequest('requestEditFeature', objectId);
|
|
815
820
|
}
|
|
821
|
+
/**
|
|
822
|
+
* Sets editor state to ready.
|
|
823
|
+
*/
|
|
816
824
|
#setEditorStateToReady() {
|
|
817
825
|
return this.#postRequest('setEditorState', 'READY');
|
|
818
826
|
}
|
|
819
827
|
/**
|
|
820
|
-
* Set custom
|
|
821
|
-
*
|
|
822
|
-
*
|
|
823
|
-
*
|
|
824
|
-
*
|
|
828
|
+
* Set the custom validation status of the geometry editor dialog ( {@link createGeometry}, {@link editGeometry}, {@link batchCreateGeometry}, {@link batchEditGeometry} )
|
|
829
|
+
* or the {@link selectObjects} dialog in addition to the default validation status (including errors and warnings).
|
|
830
|
+
*
|
|
831
|
+
* Behavior:
|
|
832
|
+
* - When the custom validation status is of type 'error', the dialog submission is blocked.
|
|
833
|
+
* - If a custom validation status is already set, it will be overwritten.
|
|
834
|
+
* - Passing '' (an empty string) as the message parameter resets the custom validation status, which means no custom validation status is displayed.
|
|
835
|
+
*
|
|
836
|
+
* If neither the geometry editor nor {@link selectObjects} is started, the method call has no effect.
|
|
837
|
+
*
|
|
825
838
|
* @param {string} message The message to show in the dialog
|
|
826
839
|
* @param {CustomValidityType} [type] The type of message (defaults to 'error')
|
|
827
840
|
*/
|
|
@@ -1233,6 +1246,7 @@ export class CadenzaClient {
|
|
|
1233
1246
|
* @param {string} [params.fileName]
|
|
1234
1247
|
* @param {FilterVariables} [params.filter]
|
|
1235
1248
|
* @param {GeometryType} [params.geometryType]
|
|
1249
|
+
* @param {boolean} [params.hideLegend]
|
|
1236
1250
|
* @param {boolean} [params.hideMainHeaderAndFooter]
|
|
1237
1251
|
* @param {boolean} [params.hideWorkbookToolBar]
|
|
1238
1252
|
* @param {GlobalId} [params.highlightGlobalId]
|
|
@@ -1249,7 +1263,7 @@ export class CadenzaClient {
|
|
|
1249
1263
|
* @param {Layout} [params.layout]
|
|
1250
1264
|
* @return {URLSearchParams}
|
|
1251
1265
|
*/
|
|
1252
|
-
#createParams({ action, batchModeEnabled, dataType, disabledUiFeatures, expandNavigator, fileName, filter, geometryType, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, labelSet, layers, minScale, operationMode, worksheetPlaceholders, parts, targetType, snapping, useMapSrs, validExtentStrategy, layout, }) {
|
|
1266
|
+
#createParams({ action, batchModeEnabled, dataType, disabledUiFeatures, expandNavigator, fileName, filter, geometryType, hideLegend, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, labelSet, layers, minScale, operationMode, worksheetPlaceholders, parts, targetType, snapping, useMapSrs, validExtentStrategy, layout, }) {
|
|
1253
1267
|
if (disabledUiFeatures) {
|
|
1254
1268
|
disabledUiFeatures.forEach((feature) => assert(validUiFeature(feature), `Invalid UI feature: ${feature}`));
|
|
1255
1269
|
}
|
|
@@ -1301,6 +1315,7 @@ export class CadenzaClient {
|
|
|
1301
1315
|
JSON.stringify(worksheetPrintName),
|
|
1302
1316
|
]))),
|
|
1303
1317
|
...(geometryType && { geometryType }),
|
|
1318
|
+
...(hideLegend && { hideLegend: 'true' }),
|
|
1304
1319
|
...(hideMainHeaderAndFooter && { hideMainHeaderAndFooter: 'true' }),
|
|
1305
1320
|
...(hideWorkbookToolBar && { hideWorkbookToolBar: 'true' }),
|
|
1306
1321
|
...(highlightGlobalId && { highlightGlobalId }),
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@disy/cadenza.js",
|
|
3
|
-
"version": "10.
|
|
3
|
+
"version": "10.6.0",
|
|
4
4
|
"license": "Apache-2.0",
|
|
5
5
|
"repository": "github:DisyInformationssysteme/cadenza.js",
|
|
6
6
|
"type": "module",
|
|
@@ -18,21 +18,19 @@
|
|
|
18
18
|
"build": "run-p validate:* build:*",
|
|
19
19
|
"build:docs": "typedoc",
|
|
20
20
|
"build:ts": "tsc",
|
|
21
|
-
"validate:format": "prettier ./src --check",
|
|
21
|
+
"validate:format": "prettier ./src/**/*.{js,ts} --check",
|
|
22
22
|
"validate:changelog": "changelog --latest-release",
|
|
23
23
|
"start": "run-p start:*",
|
|
24
24
|
"start:docs": "npm run build:docs -- --watch",
|
|
25
25
|
"start:test": "npm test -- --watch",
|
|
26
26
|
"start:ts": "npm run build:ts -- --watch",
|
|
27
|
-
"start:reformat": "onchange \"src
|
|
27
|
+
"start:reformat": "onchange \"src/**/*.js\" \"src/**/*.ts\" -- prettier {{changed}} --write",
|
|
28
28
|
"test": "cross-env NODE_OPTIONS=--unhandled-rejections=warn jest",
|
|
29
|
-
"deploy:docs": "gh-pages --dist apidoc",
|
|
30
29
|
"sandbox": "node ./sandbox.cjs"
|
|
31
30
|
},
|
|
32
31
|
"devDependencies": {
|
|
33
32
|
"@types/jest": "29.5.14",
|
|
34
33
|
"cross-env": "7.0.3",
|
|
35
|
-
"gh-pages": "6.3.0",
|
|
36
34
|
"http-server": "14.1.1",
|
|
37
35
|
"jest": "29.7.0",
|
|
38
36
|
"jest-environment-jsdom": "29.7.0",
|
package/sandbox.html
CHANGED
|
@@ -243,6 +243,7 @@
|
|
|
243
243
|
minScale,
|
|
244
244
|
parts,
|
|
245
245
|
requestAsPdf,
|
|
246
|
+
showLegend,
|
|
246
247
|
simplifiedOperationMode,
|
|
247
248
|
snappingLayer,
|
|
248
249
|
useAutoCorrection,
|
|
@@ -272,6 +273,7 @@
|
|
|
272
273
|
layers: layers ? JSON.parse(layers) : undefined,
|
|
273
274
|
minScale: minScale && Number(minScale),
|
|
274
275
|
operationMode: (simplifiedOperationMode === 'on' ? 'simplified' : 'normal' ),
|
|
276
|
+
hideLegend: showLegend !== 'on',
|
|
275
277
|
parts: parts && parts.split(','),
|
|
276
278
|
snapping: snappingLayer ? {
|
|
277
279
|
layer: JSON.parse(snappingLayer),
|
|
@@ -576,14 +578,14 @@
|
|
|
576
578
|
|
|
577
579
|
<template data-action="setFilter" data-common="filter"></template>
|
|
578
580
|
|
|
579
|
-
<template data-action="createGeometry" data-common="geometryType,simplifiedOperationMode,minimumScale,additionalLayers,extentStrategy,map,snapping,disabledUiFeatures,filter">
|
|
581
|
+
<template data-action="createGeometry" data-common="geometryType,simplifiedOperationMode,showLegend,minimumScale,additionalLayers,extentStrategy,map,snapping,disabledUiFeatures,filter">
|
|
580
582
|
<div>
|
|
581
583
|
<label for="embeddingTargetId">Embedding target ID of the map view *</label>
|
|
582
584
|
<input name="embeddingTargetId" id="embeddingTargetId" required>
|
|
583
585
|
</div>
|
|
584
586
|
</template>
|
|
585
587
|
|
|
586
|
-
<template data-action="editGeometry" data-common="simplifiedOperationMode,minimumScale,additionalLayers,extentStrategy,map,snapping,disabledUiFeatures,filter">
|
|
588
|
+
<template data-action="editGeometry" data-common="simplifiedOperationMode,showLegend,minimumScale,additionalLayers,extentStrategy,map,snapping,disabledUiFeatures,filter">
|
|
587
589
|
<div>
|
|
588
590
|
<label for="embeddingTargetId">Embedding target ID of the map view *</label>
|
|
589
591
|
<input name="embeddingTargetId" id="embeddingTargetId" required>
|
|
@@ -610,14 +612,14 @@
|
|
|
610
612
|
</div>
|
|
611
613
|
</template>
|
|
612
614
|
|
|
613
|
-
<template data-action="batchCreateGeometry" data-common="geometryType,simplifiedOperationMode,minimumScale,additionalLayers,extentStrategy,map,snapping,disabledUiFeatures,filter">
|
|
615
|
+
<template data-action="batchCreateGeometry" data-common="geometryType,simplifiedOperationMode,showLegend,minimumScale,additionalLayers,extentStrategy,map,snapping,disabledUiFeatures,filter">
|
|
614
616
|
<div>
|
|
615
617
|
<label for="embeddingTargetId">Embedding target ID of the map view *</label>
|
|
616
618
|
<input name="embeddingTargetId" id="embeddingTargetId" required>
|
|
617
619
|
</div>
|
|
618
620
|
</template>
|
|
619
621
|
|
|
620
|
-
<template data-action="batchEditGeometry" data-common="simplifiedOperationMode,minimumScale,additionalLayers,extentStrategy,map,snapping,disabledUiFeatures,filter">
|
|
622
|
+
<template data-action="batchEditGeometry" data-common="simplifiedOperationMode,showLegend,minimumScale,additionalLayers,extentStrategy,map,snapping,disabledUiFeatures,filter">
|
|
621
623
|
<div>
|
|
622
624
|
<label for="embeddingTargetId">Embedding target ID of the map view *</label>
|
|
623
625
|
<input name="embeddingTargetId" id="embeddingTargetId" required>
|
|
@@ -751,6 +753,15 @@
|
|
|
751
753
|
</div>
|
|
752
754
|
</template>
|
|
753
755
|
|
|
756
|
+
<template id="common-showLegend">
|
|
757
|
+
<div>
|
|
758
|
+
<label>
|
|
759
|
+
<input type="checkbox" name="showLegend">
|
|
760
|
+
Show Legend
|
|
761
|
+
</label>
|
|
762
|
+
</div>
|
|
763
|
+
</template>
|
|
764
|
+
|
|
754
765
|
<template id="common-minimumScale">
|
|
755
766
|
<div>
|
|
756
767
|
<label for="minScale">Minimum Scale</label>
|