@disy/cadenza.js 10.2.7 → 10.2.9

package/cadenza.js

@@ -10,6 +10,9 @@
  *   Please ensure that the user has view privilege for that link!
  * @property {boolean} [options.debug] - Whether to enable debug logging
  */
+// This placeholder is replaced when Cadenza JS is released,
+// i.e. during development, the version is not available.
+const CADENZAJS_VERSION = '10.2.9';
 /**
  * Creates an instance of the Cadenza JS client.
  *
@@ -40,9 +43,11 @@ export function cadenza(baseUrlOrOptions, options) {
             : baseUrlOrOptions;
     return new CadenzaClient(options);
 }
+cadenza.version = CADENZAJS_VERSION;
 /* @ts-ignore */
 const previousGlobalCadenza = globalThis.cadenza;
 globalThis.cadenza = Object.assign((/** @type Parameters<cadenza> */ ...args) => cadenza(...args), {
+    version: CADENZAJS_VERSION,
     noConflict() {
         globalThis.cadenza = previousGlobalCadenza;
         return cadenza;
@@ -190,7 +195,7 @@ let firstEmbeddingTargetShown;
  * _Notes:_
  * * Most public methods are tagged with one of these modifiers:
  *   * `Embed`: The method embeds Cadenza in the given iframe.
- *   * `Post Message`: The method communicates with an embedded or parent/opener Cadenza via postMessage.
+ *   * `Post Message`: The method communicates with an embedded Cadenza via postMessage.
  *   * `Post Message Parent`: The method communicates with a parent/opener Cadenza via postMessage.
  *   * `Server`: The method communicates with the Cadenza server via HTTP.
  * * Most public methods can be aborted using an [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal).
@@ -324,11 +329,12 @@ export class CadenzaClient {
      * @param {object} [__namedParameters] - Options
      * @param {boolean} [__namedParameters.invalidateCaches] - When true, caches will be invalidated for objecttypes used
      *   in the worksheet
+     * @return {Promise<void>} A `Promise` which resolves when the views of the worksheet have finished reloading
      * @postMessage
      */
     reload({ invalidateCaches = false } = {}) {
         this.#log('CadenzaClient#reload', ...arguments);
-        this.#postEvent('reload', { invalidateCaches });
+        return this.#postRequest('reload', { invalidateCaches });
     }
     /**
      * Sends a message to parent Cadenza window to close the window containing this application
@@ -465,12 +471,19 @@ export class CadenzaClient {
      * @hidden
      * @param {WorkbookLayerPath | string} layer - The data view layer to set the selection in
      * @param {unknown[][]} values - The IDs of the objects to select
+     * @param {object} [__namedParameters]
+     * @param {GeometryExtentStrategy} [__namedParameters.extentStrategy] - Strategy to define the new map extent
      * @return {Promise<void>} A `Promise` for when the selection was set.
      * @postMessage
      */
-    setSelection(layer, values) {
+    setSelection(layer, values, { extentStrategy } = {}) {
         this.#log('CadenzaClient#setSelection', ...arguments);
-        return this.#postRequest('setSelection', { layer: array(layer), values });
+        const selectionResult = this.#postRequest('setSelection', {
+            layer: array(layer),
+            values,
+        });
+        this.#setExtentStrategy(extentStrategy);
+        return selectionResult;
     }
     /**
      * Add to the selection in the currently shown workbook map view.
@@ -478,12 +491,19 @@ export class CadenzaClient {
      * @hidden
      * @param {WorkbookLayerPath | string} layer - The data view layer to change the selection in
      * @param {unknown[][]} values - The IDs of the objects to select
+     * @param {object} [__namedParameters]
+     * @param {GeometryExtentStrategy} [__namedParameters.extentStrategy] - Strategy to define the new map extent
      * @return {Promise<void>} A `Promise` for when the selection was changed.
      * @postMessage
      */
-    addSelection(layer, values) {
+    addSelection(layer, values, { extentStrategy } = {}) {
         this.#log('CadenzaClient#addSelection', ...arguments);
-        return this.#postRequest('addSelection', { layer: array(layer), values });
+        const selectionResult = this.#postRequest('addSelection', {
+            layer: array(layer),
+            values,
+        });
+        this.#setExtentStrategy(extentStrategy);
+        return selectionResult;
     }
     /**
      * Remove from the selection in the currently shown workbook map view.
@@ -491,15 +511,19 @@ export class CadenzaClient {
      * @hidden
      * @param {WorkbookLayerPath | string} layer - The data view layer to change the selection in
      * @param {unknown[][]} values - The IDs of the objects to unselect
+     * @param {object} [__namedParameters]
+     * @param {GeometryExtentStrategy} [__namedParameters.extentStrategy] - Strategy to define the new map extent
      * @return {Promise<void>} A `Promise` for when the selection was changed.
      * @postMessage
      */
-    removeSelection(layer, values) {
+    removeSelection(layer, values, { extentStrategy } = {}) {
         this.#log('CadenzaClient#removeSelection', ...arguments);
-        return this.#postRequest('removeSelection', {
+        const selectionResult = this.#postRequest('removeSelection', {
             layer: array(layer),
             values,
         });
+        this.#setExtentStrategy(extentStrategy);
+        return selectionResult;
     }
     /**
      * Create a geometry.

package/package.json

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

package/sandbox.html

@@ -162,9 +162,9 @@
       },
       setFilter: data => cadenzaClient.setFilter(parseFilterVariables(data.filter)),
       setLayerVisibility: data => cadenzaClient.setLayerVisibility(JSON.parse(data.layer), data.visibility === 'on'),
-      setSelection: data => cadenzaClient.setSelection(JSON.parse(data.layer), JSON.parse(data.objectIds)),
-      addSelection: data => cadenzaClient.addSelection(JSON.parse(data.layer), JSON.parse(data.objectIds)),
-      removeSelection: data => cadenzaClient.removeSelection(JSON.parse(data.layer), JSON.parse(data.objectIds)),
+      setSelection: data => cadenzaClient.setSelection(JSON.parse(data.layer), JSON.parse(data.objectIds), {extentStrategy: JSON.parse(data.extentStrategy)}),
+      addSelection: data => cadenzaClient.addSelection(JSON.parse(data.layer), JSON.parse(data.objectIds), { extentStrategy: JSON.parse(data.extentStrategy) }),
+      removeSelection: data => cadenzaClient.removeSelection(JSON.parse(data.layer), JSON.parse(data.objectIds), { extentStrategy: JSON.parse(data.extentStrategy) }),
       createGeometry: data => cadenzaClient.createGeometry(data.embeddingTargetId, data.geometryType, getOptions(data)),
       editGeometry: ({ geometry, ...data }) => cadenzaClient.editGeometry(data.embeddingTargetId, JSON.parse(geometry), getOptions(data)),
       selectObjects: data => cadenzaClient.selectObjects(data.embeddingTargetId, getOptions(data)),
@@ -578,9 +578,9 @@
   </div>
 </template>
 
-<template data-action="setSelection" data-common="layer,object-ids"></template>
-<template data-action="addSelection" data-common="layer,object-ids"></template>
-<template data-action="removeSelection" data-common="layer,object-ids"></template>
+<template data-action="setSelection" data-common="layer,object-ids,extentStrategy"></template>
+<template data-action="addSelection" data-common="layer,object-ids,extentStrategy"></template>
+<template data-action="removeSelection" data-common="layer,object-ids,extentStrategy"></template>
 
 <template data-action="reload">
   <div>
@@ -655,7 +655,7 @@
 
 <template id="common-geometry">
   <div>
-    <label for="geometry">Geometry (GeoJSON) *</label>
+    <label for="geometry">Geometry (GeoJSON)</label>
     <textarea name="geometry" id="geometry" rows="5"></textarea>
     <small>
       <strong>Example:</strong>