@disy/cadenza.js 2.5.0 → 2.7.0

package/cadenza.d.ts

@@ -185,6 +185,7 @@ export class CadenzaClient {
      * @param {EmbeddingTargetId} backgroundMapView - The workbook map view in the background
      * @param {GeometryType} geometryType - The geometry type
      * @param {object} [options] - Options
+     * @param {FilterVariables} [options.filter] - Filter variables
      * @param {string} [options.locationFinder] - A search query for the location finder
      * @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.
@@ -197,7 +198,8 @@ export class CadenzaClient {
      * - {@link CadenzaEditGeometryOkEvent}
      * - {@link CadenzaEditGeometryCancelEvent}
      */
-    createGeometry(backgroundMapView: EmbeddingTargetId, geometryType: GeometryType, { locationFinder, mapExtent, minScale, useMapSrs, signal }?: {
+    createGeometry(backgroundMapView: EmbeddingTargetId, geometryType: GeometryType, { filter, locationFinder, mapExtent, minScale, useMapSrs, signal }?: {
+        filter?: FilterVariables | undefined;
         locationFinder?: string | undefined;
         mapExtent?: Extent | undefined;
         minScale?: number | undefined;
@@ -210,6 +212,7 @@ export class CadenzaClient {
      * @param {EmbeddingTargetId} backgroundMapView - The workbook map view in the background
      * @param {Geometry} geometry - The geometry
      * @param {object} [options] - Options
+     * @param {FilterVariables} [options.filter] - Filter variables
      * @param {string} [options.locationFinder] - A search query for the location finder
      * @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.
@@ -222,7 +225,8 @@ export class CadenzaClient {
      * - {@link CadenzaEditGeometryOkEvent}
      * - {@link CadenzaEditGeometryCancelEvent}
      */
-    editGeometry(backgroundMapView: EmbeddingTargetId, geometry: Geometry, { locationFinder, mapExtent, minScale, useMapSrs, signal }?: {
+    editGeometry(backgroundMapView: EmbeddingTargetId, geometry: Geometry, { filter, locationFinder, mapExtent, minScale, useMapSrs, signal }?: {
+        filter?: FilterVariables | undefined;
         locationFinder?: string | undefined;
         mapExtent?: Extent | undefined;
         minScale?: number | undefined;
@@ -234,6 +238,7 @@ export class CadenzaClient {
      *
      * @param {EmbeddingTargetId} backgroundMapView - The workbook map view
      * @param {object} [options] - Options
+     * @param {FilterVariables} [options.filter] - Filter variables
      * @param {(WorkbookLayerPath | string)[]} [options.layers] - Layers to restrict the selection to
      *  (identified using layer paths or print names)
      * @param {string} [options.locationFinder] - A search query for the location finder
@@ -248,7 +253,8 @@ export class CadenzaClient {
      * - {@link CadenzaSelectObjectsOkEvent}
      * - {@link CadenzaSelectObjectsCancelEvent}
      */
-    selectObjects(backgroundMapView: EmbeddingTargetId, { layers, locationFinder, mapExtent, useMapSrs, signal }?: {
+    selectObjects(backgroundMapView: EmbeddingTargetId, { filter, layers, locationFinder, mapExtent, useMapSrs, signal }?: {
+        filter?: FilterVariables | undefined;
         layers?: (string | WorkbookLayerPath)[] | undefined;
         locationFinder?: string | undefined;
         mapExtent?: Extent | undefined;
@@ -303,6 +309,10 @@ export class CadenzaClient {
         filter?: FilterVariables | undefined;
         parts?: TablePart[] | undefined;
     } | undefined, ...args: any[]): void;
+    /**
+     * Reload the views of a worksheet.
+     */
+    reload(): void;
     #private;
 }
 /**
@@ -336,7 +346,11 @@ export class CadenzaClient {
  * @property {TYPE} type - The event type
  * @property {DETAIL} detail - Optional event details (depending on the event type)
  */
-/** @typedef {CadenzaEvent<'change:selection', undefined | {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaChangeSelectionEvent - When the user changed the selection. */
+/**
+ * @typedef {CadenzaEvent<'change:selection', undefined | {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaChangeSelectionEvent - When the user changed the selection.
+ *
+ * For a selection in a workbook map view with activated feature info, the values also include the geometries of the selected objects.
+ */
 /**
  * @typedef {CadenzaEvent<'drillThrough', {context?: string, values: unknown[][]}>} CadenzaDrillThroughEvent - When the user executed a POST message drill-through.
  * <p>
@@ -351,7 +365,11 @@ export class CadenzaClient {
 /** @typedef {CadenzaEvent<'editGeometry:cancel'>} CadenzaEditGeometryCancelEvent - When the user cancelled the geometry editing. */
 /** @typedef {CadenzaEvent<'error', {type: string, message?: string}>} CadenzaErrorEvent - An error event that is mapped to a {@link CadenzaError} */
 /** @typedef {CadenzaEvent<'objectInfo', {layer: WorkbookLayerPath, objectInfos: {selectionIndex: number, elements: {attributePrintName: string, formattedValue: string}[]}}>} CadenzaObjectInfoEvent - When the user opened the object info flyout. */
-/** @typedef {CadenzaEvent<'selectObjects:ok', {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaSelectObjectsOkEvent - When the user submitted the selection. */
+/**
+ * @typedef {CadenzaEvent<'selectObjects:ok', {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaSelectObjectsOkEvent - When the user submitted the selection.
+ *
+ * For a selection in a workbook map view with activated feature info, the values also include the geometries of the selected objects.
+ */
 /** @typedef {CadenzaEvent<'selectObjects:cancel'>} CadenzaSelectObjectsCancelEvent - When the user cancelled the selection. */
 export class AbortError extends DOMException {
     constructor();
@@ -499,6 +517,8 @@ export type CadenzaEvent<TYPE extends string, DETAIL = unknown> = {
 };
 /**
  * - When the user changed the selection.
+ *
+ * For a selection in a workbook map view with activated feature info, the values also include the geometries of the selected objects.
  */
 export type CadenzaChangeSelectionEvent = CadenzaEvent<'change:selection', undefined | {
     layer: string[];
@@ -555,6 +575,8 @@ export type CadenzaObjectInfoEvent = CadenzaEvent<'objectInfo', {
 }>;
 /**
  * - When the user submitted the selection.
+ *
+ * For a selection in a workbook map view with activated feature info, the values also include the geometries of the selected objects.
  */
 export type CadenzaSelectObjectsOkEvent = CadenzaEvent<'selectObjects:ok', {
     layer: string[];

package/cadenza.js

@@ -358,6 +358,7 @@ export class CadenzaClient {
      * @param {EmbeddingTargetId} backgroundMapView - The workbook map view in the background
      * @param {GeometryType} geometryType - The geometry type
      * @param {object} [options] - Options
+     * @param {FilterVariables} [options.filter] - Filter variables
      * @param {string} [options.locationFinder] - A search query for the location finder
      * @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.
@@ -370,10 +371,11 @@ export class CadenzaClient {
      * - {@link CadenzaEditGeometryOkEvent}
      * - {@link CadenzaEditGeometryCancelEvent}
      */
-    createGeometry(backgroundMapView, geometryType, { locationFinder, mapExtent, minScale, useMapSrs, signal } = {}) {
+    createGeometry(backgroundMapView, geometryType, { filter, locationFinder, mapExtent, minScale, useMapSrs, signal } = {}) {
         this.#log('CadenzaClient#createGeometry', ...arguments);
         const params = createParams({
             action: 'editGeometry',
+            filter,
             geometryType,
             locationFinder,
             mapExtent,
@@ -388,6 +390,7 @@ export class CadenzaClient {
      * @param {EmbeddingTargetId} backgroundMapView - The workbook map view in the background
      * @param {Geometry} geometry - The geometry
      * @param {object} [options] - Options
+     * @param {FilterVariables} [options.filter] - Filter variables
      * @param {string} [options.locationFinder] - A search query for the location finder
      * @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.
@@ -400,11 +403,12 @@ export class CadenzaClient {
      * - {@link CadenzaEditGeometryOkEvent}
      * - {@link CadenzaEditGeometryCancelEvent}
      */
-    async editGeometry(backgroundMapView, geometry, { locationFinder, mapExtent, minScale, useMapSrs, signal } = {}) {
+    async editGeometry(backgroundMapView, geometry, { filter, locationFinder, mapExtent, minScale, useMapSrs, signal } = {}) {
         this.#log('CadenzaClient#editGeometry', ...arguments);
         assertValidGeometryType(geometry.type);
         const params = createParams({
             action: 'editGeometry',
+            filter,
             locationFinder,
             mapExtent,
             minScale,
@@ -420,6 +424,7 @@ export class CadenzaClient {
      *
      * @param {EmbeddingTargetId} backgroundMapView - The workbook map view
      * @param {object} [options] - Options
+     * @param {FilterVariables} [options.filter] - Filter variables
      * @param {(WorkbookLayerPath | string)[]} [options.layers] - Layers to restrict the selection to
      *  (identified using layer paths or print names)
      * @param {string} [options.locationFinder] - A search query for the location finder
@@ -434,10 +439,11 @@ export class CadenzaClient {
      * - {@link CadenzaSelectObjectsOkEvent}
      * - {@link CadenzaSelectObjectsCancelEvent}
      */
-    selectObjects(backgroundMapView, { layers, locationFinder, mapExtent, useMapSrs, signal } = {}) {
+    selectObjects(backgroundMapView, { filter, layers, locationFinder, mapExtent, useMapSrs, signal } = {}) {
         this.#log('CadenzaClient#selectObjects', ...arguments);
         const params = createParams({
             action: 'selectObjects',
+            filter,
             layers: layers?.map(array),
             locationFinder,
             mapExtent,
@@ -670,6 +676,13 @@ export class CadenzaClient {
         const params = createParams({ dataType, fileName, filter, parts });
         this.#download(resolvePath(source), params);
     }
+    /**
+     * Reload the views of a worksheet.
+     */
+    reload() {
+        this.#log('CadenzaClient#reload');
+        this.#postEvent('reload');
+    }
     #download(/** @type string */ path, /** @type URLSearchParams */ params) {
         const url = this.#createUrl(path, params);
         const a = document.createElement('a');
@@ -895,7 +908,11 @@ function array(/** @type unknown */ value) {
  * @typedef {CadenzaEvent<'change:extent', {extent: Extent}>} CadenzaChangeExtentEvent - When the user moved the map.
  *   The extent is transformed according to the `useMapSrs` option.
  */
-/** @typedef {CadenzaEvent<'change:selection', undefined | {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaChangeSelectionEvent - When the user changed the selection. */
+/**
+ * @typedef {CadenzaEvent<'change:selection', undefined | {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaChangeSelectionEvent - When the user changed the selection.
+ *
+ * For a selection in a workbook map view with activated feature info, the values also include the geometries of the selected objects.
+ */
 /**
  * @typedef {CadenzaEvent<'drillThrough', {context?: string, values: unknown[][]}>} CadenzaDrillThroughEvent - When the user executed a POST message drill-through.
  * <p>
@@ -910,7 +927,11 @@ function array(/** @type unknown */ value) {
 /** @typedef {CadenzaEvent<'editGeometry:cancel'>} CadenzaEditGeometryCancelEvent - When the user cancelled the geometry editing. */
 /** @typedef {CadenzaEvent<'error', {type: string, message?: string}>} CadenzaErrorEvent - An error event that is mapped to a {@link CadenzaError} */
 /** @typedef {CadenzaEvent<'objectInfo', {layer: WorkbookLayerPath, objectInfos: {selectionIndex: number, elements: {attributePrintName: string, formattedValue: string}[]}}>} CadenzaObjectInfoEvent - When the user opened the object info flyout. */
-/** @typedef {CadenzaEvent<'selectObjects:ok', {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaSelectObjectsOkEvent - When the user submitted the selection. */
+/**
+ * @typedef {CadenzaEvent<'selectObjects:ok', {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaSelectObjectsOkEvent - When the user submitted the selection.
+ *
+ * For a selection in a workbook map view with activated feature info, the values also include the geometries of the selected objects.
+ */
 /** @typedef {CadenzaEvent<'selectObjects:cancel'>} CadenzaSelectObjectsCancelEvent - When the user cancelled the selection. */
 export class AbortError extends DOMException {
     constructor() {

package/package.json

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

package/sandbox.html

@@ -139,6 +139,7 @@
       showPage: data => cadenzaClient.show({ page: data.page }, getOptions(data)),
       showMap: data => cadenzaClient.showMap(data.embeddingTargetId, getOptions(data)),
       expandNavigator: data => cadenzaClient.expandNavigator(data.expandNavigator === 'on'),
+      reload: () => cadenzaClient.reload(),
       getData: async data => {
         const dataType = data.dataType;
         const result = await cadenzaClient.getData(dataType);
@@ -261,6 +262,7 @@
             <!--option value="setSelection">Set Selection</option-->
             <!--option value="addSelection">Add Selection</option-->
             <!--option value="removeSelection">Remove Selection</option-->
+            <option value="reload">Reload worksheet views</option>
           </optgroup>
           <optgroup label="Map Dialogs">
             <option value="createGeometry">Create Geometry</option>
@@ -440,7 +442,7 @@
 
 <template data-action="setFilter" data-common="filter"></template>
 
-<template data-action="createGeometry" data-common="map">
+<template data-action="createGeometry" data-common="map,filter">
   <div>
     <label for="embeddingTargetId">Embedding target ID of the map view *</label>
     <input name="embeddingTargetId" id="embeddingTargetId" required>
@@ -462,7 +464,7 @@
   </div>
 </template>
 
-<template data-action="editGeometry" data-common="map">
+<template data-action="editGeometry" data-common="map,filter">
   <div>
     <label for="embeddingTargetId">Embedding target ID of the map view *</label>
     <input name="embeddingTargetId" id="embeddingTargetId" required>
@@ -477,7 +479,7 @@
   </div>
 </template>
 
-<template data-action="selectObjects" data-common="map">
+<template data-action="selectObjects" data-common="map,filter">
   <div>
     <label for="embeddingTargetId">Embedding target ID of the map view *</label>
     <input name="embeddingTargetId" id="embeddingTargetId" required>
@@ -506,6 +508,7 @@
 <template data-action="setSelection" data-common="layer,layer-selection"></template>
 <template data-action="addSelection" data-common="layer,layer-selection"></template>
 <template data-action="removeSelection" data-common="layer,layer-selection"></template>
+<template data-action="reload">No Paramters needed.</template>
 
 <template id="common-layer-selection">
   <div>