@disy/cadenza.js 2.13.1 → 10.2.0

package/cadenza.d.ts

@@ -219,6 +219,7 @@ export class CadenzaClient {
      * @param {Extent} [options.mapExtent] - A map extent to set
      * @param {number} [options.minScale] - The minimum scale where the user should work on. A warning is shown when the map is zoomed out above the threshold.
      * @param {boolean} [options.useMapSrs] - Whether the created geometry should use the map's SRS (otherwise EPSG:4326 will be used)
+     * @param {OperationMode} [options.operationMode] - The mode in which a workbook should be operated
      * @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
@@ -228,12 +229,13 @@ export class CadenzaClient {
      * - {@link CadenzaEditGeometryCancelEvent}
      * @embed
      */
-    createGeometry(backgroundMapView: EmbeddingTargetId, geometryType: GeometryType, { filter, locationFinder, mapExtent, minScale, useMapSrs, signal }?: {
+    createGeometry(backgroundMapView: EmbeddingTargetId, geometryType: GeometryType, { filter, locationFinder, mapExtent, minScale, useMapSrs, operationMode, signal, }?: {
         filter?: FilterVariables | undefined;
         locationFinder?: string | undefined;
         mapExtent?: Extent | undefined;
         minScale?: number | undefined;
         useMapSrs?: boolean | undefined;
+        operationMode?: OperationMode | undefined;
         signal?: AbortSignal | undefined;
     } | undefined, ...args: any[]): Promise<void>;
     /**
@@ -247,6 +249,7 @@ export class CadenzaClient {
      * @param {Extent} [options.mapExtent] - A map extent to set
      * @param {number} [options.minScale] - The minimum scale where the user should work on. A warning is shown when the map is zoomed out above the threshold.
      * @param {boolean} [options.useMapSrs] - Whether the geometry is in the map's SRS (otherwise EPSG:4326 is assumed)
+     * @param {OperationMode} [options.operationMode] - The mode in which a workbook should be operated
      * @param {ZoomTarget} [options.zoomTarget] - A target Cadenza should zoom to
      * @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
@@ -257,12 +260,13 @@ export class CadenzaClient {
      * - {@link CadenzaEditGeometryCancelEvent}
      * @embed
      */
-    editGeometry(backgroundMapView: EmbeddingTargetId, geometry: Geometry, { filter, locationFinder, mapExtent, minScale, useMapSrs, zoomTarget, signal, }?: {
+    editGeometry(backgroundMapView: EmbeddingTargetId, geometry: Geometry, { filter, locationFinder, mapExtent, minScale, useMapSrs, zoomTarget, operationMode, signal, }?: {
         filter?: FilterVariables | undefined;
         locationFinder?: string | undefined;
         mapExtent?: Extent | undefined;
         minScale?: number | undefined;
         useMapSrs?: boolean | undefined;
+        operationMode?: OperationMode | undefined;
         zoomTarget?: GeometryZoomTarget | undefined;
         signal?: AbortSignal | undefined;
     } | undefined, ...args: any[]): Promise<void>;
@@ -277,6 +281,7 @@ export class CadenzaClient {
      * @param {string} [options.locationFinder] - A search query for the location finder
      * @param {Extent} [options.mapExtent] - A map extent to set
      * @param {boolean} [options.useMapSrs] - Whether the geometry is in the map's SRS (otherwise EPSG:4326 is assumed)
+     * @param {OperationMode} [options.operationMode] - The mode in which a workbook should be operated
      * @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
@@ -287,12 +292,13 @@ export class CadenzaClient {
      * - {@link CadenzaSelectObjectsCancelEvent}
      * @embed
      */
-    selectObjects(backgroundMapView: EmbeddingTargetId, { filter, layers, locationFinder, mapExtent, useMapSrs, signal }?: {
+    selectObjects(backgroundMapView: EmbeddingTargetId, { filter, layers, locationFinder, mapExtent, useMapSrs, operationMode, signal, }?: {
         filter?: FilterVariables | undefined;
         layers?: (string | WorkbookLayerPath)[] | undefined;
         locationFinder?: string | undefined;
         mapExtent?: Extent | undefined;
         useMapSrs?: boolean | undefined;
+        operationMode?: OperationMode | undefined;
         signal?: AbortSignal | undefined;
     } | undefined, ...args: any[]): Promise<void>;
     /**

package/cadenza.js

@@ -469,6 +469,7 @@ export class CadenzaClient {
      * @param {Extent} [options.mapExtent] - A map extent to set
      * @param {number} [options.minScale] - The minimum scale where the user should work on. A warning is shown when the map is zoomed out above the threshold.
      * @param {boolean} [options.useMapSrs] - Whether the created geometry should use the map's SRS (otherwise EPSG:4326 will be used)
+     * @param {OperationMode} [options.operationMode] - The mode in which a workbook should be operated
      * @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
@@ -478,7 +479,7 @@ export class CadenzaClient {
      * - {@link CadenzaEditGeometryCancelEvent}
      * @embed
      */
-    createGeometry(backgroundMapView, geometryType, { filter, locationFinder, mapExtent, minScale, useMapSrs, signal } = {}) {
+    createGeometry(backgroundMapView, geometryType, { filter, locationFinder, mapExtent, minScale, useMapSrs, operationMode, signal, } = {}) {
         this.#log('CadenzaClient#createGeometry', ...arguments);
         const params = createParams({
             action: 'editGeometry',
@@ -488,6 +489,7 @@ export class CadenzaClient {
             mapExtent,
             minScale,
             useMapSrs,
+            operationMode,
         });
         return this.#show(resolvePath(backgroundMapView), params, signal);
     }
@@ -502,6 +504,7 @@ export class CadenzaClient {
      * @param {Extent} [options.mapExtent] - A map extent to set
      * @param {number} [options.minScale] - The minimum scale where the user should work on. A warning is shown when the map is zoomed out above the threshold.
      * @param {boolean} [options.useMapSrs] - Whether the geometry is in the map's SRS (otherwise EPSG:4326 is assumed)
+     * @param {OperationMode} [options.operationMode] - The mode in which a workbook should be operated
      * @param {ZoomTarget} [options.zoomTarget] - A target Cadenza should zoom to
      * @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
@@ -512,7 +515,7 @@ export class CadenzaClient {
      * - {@link CadenzaEditGeometryCancelEvent}
      * @embed
      */
-    async editGeometry(backgroundMapView, geometry, { filter, locationFinder, mapExtent, minScale, useMapSrs, zoomTarget, signal, } = {}) {
+    async editGeometry(backgroundMapView, geometry, { filter, locationFinder, mapExtent, minScale, useMapSrs, zoomTarget, operationMode, signal, } = {}) {
         this.#log('CadenzaClient#editGeometry', ...arguments);
         assertValidGeometryType(geometry.type);
         const zoomToGeometry = geometry && zoomTarget?.type === 'geometry';
@@ -525,6 +528,7 @@ export class CadenzaClient {
             mapExtent,
             minScale,
             useMapSrs,
+            operationMode,
         });
         await this.#show(resolvePath(backgroundMapView), params, signal);
         if (geometry) {
@@ -545,6 +549,7 @@ export class CadenzaClient {
      * @param {string} [options.locationFinder] - A search query for the location finder
      * @param {Extent} [options.mapExtent] - A map extent to set
      * @param {boolean} [options.useMapSrs] - Whether the geometry is in the map's SRS (otherwise EPSG:4326 is assumed)
+     * @param {OperationMode} [options.operationMode] - The mode in which a workbook should be operated
      * @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
@@ -555,7 +560,7 @@ export class CadenzaClient {
      * - {@link CadenzaSelectObjectsCancelEvent}
      * @embed
      */
-    selectObjects(backgroundMapView, { filter, layers, locationFinder, mapExtent, useMapSrs, signal } = {}) {
+    selectObjects(backgroundMapView, { filter, layers, locationFinder, mapExtent, useMapSrs, operationMode, signal, } = {}) {
         this.#log('CadenzaClient#selectObjects', ...arguments);
         const params = createParams({
             action: 'selectObjects',
@@ -564,6 +569,7 @@ export class CadenzaClient {
             locationFinder,
             mapExtent,
             useMapSrs,
+            operationMode,
         });
         return this.#show(resolvePath(backgroundMapView), params, signal);
     }
@@ -1046,7 +1052,7 @@ function createParams({ action, dataType, disabledUiFeatures, expandNavigator, f
         ...(locationFinder && { locationFinder }),
         ...(mapExtent && { mapExtent: mapExtent.join() }),
         ...(minScale && { minScale: String(minScale) }),
-        ...(operationMode && operationMode !== 'normal' && { operationMode }),
+        ...(operationMode && { operationMode }),
         ...(parts && { parts: parts.join() }),
         ...(targetType && { targetType }),
         ...(useMapSrs && { useMapSrs: 'true' }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@disy/cadenza.js",
-  "version": "2.13.1",
+  "version": "10.2.0",
   "license": "Apache-2.0",
   "repository": "github:DisyInformationssysteme/cadenza.js",
   "type": "module",

package/sandbox.html

@@ -247,7 +247,7 @@
         mapExtent: mapExtent && mapExtent.split(',').map(Number),
         minScale: minScale && Number(minScale),
         parts: parts && parts.split(','),
-        ...(simplifiedOperationMode === 'on' && { operationMode: 'simplified' }),
+        operationMode: (simplifiedOperationMode === 'on' ? 'simplified' : 'normal' ),
         layers: layers ? JSON.parse(layers) : undefined,
         useMapSrs: useMapSrs === 'on',
         fullGeometries: fullGeometries === 'on',
@@ -490,6 +490,12 @@
       <option>MultiPolygon</option>
     </select>
   </div>
+  <div>
+    <label>
+      <input type="checkbox" name="simplifiedOperationMode">
+      Simplified operation mode
+    </label>
+  </div>
   <div>
     <label for="minScale">Minimum Scale</label>
     <input type="number" name="minScale" id="minScale">
@@ -505,6 +511,12 @@
     <label for="geometry">Geometry (GeoJSON) *</label>
     <textarea name="geometry" id="geometry" rows="5" required></textarea>
   </div>
+  <div>
+    <label>
+      <input type="checkbox" name="simplifiedOperationMode">
+      Simplified operation mode
+    </label>
+  </div>
   <div>
     <label for="minScale">Minimum Scale</label>
     <input type="number" name="minScale" id="minScale">
@@ -516,6 +528,12 @@
     <label for="embeddingTargetId">Embedding target ID of the map view *</label>
     <input name="embeddingTargetId" id="embeddingTargetId" required>
   </div>
+  <div>
+    <label>
+      <input type="checkbox" name="simplifiedOperationMode">
+      Simplified operation mode
+    </label>
+  </div>
   <div>
     <label for="layers">Layers</label>
     <input name="layers" id="layers">