@disy/cadenza.js 3.0.2 → 3.0.4

package/cadenza.d.ts

@@ -36,7 +36,7 @@ export class CadenzaClient {
     /**
      *
      * @hidden
-     * @param {CadenzaClientOptions} [options]
+     * @param {CadenzaClientOptions} [__namedParameters]
      */
     constructor({ baseUrl, debug, iframe, webApplication }?: CadenzaClientOptions | undefined);
     /** The base URL of the Cadenza server this client is requesting */
@@ -47,18 +47,18 @@ export class CadenzaClient {
      * Show a page, workbook, worksheet or workbook view in an iframe.
      *
      * @param {PageSource | EmbeddingTargetId} source - The source to show
-     * @param {object} [options]
-     * @param {DataType} [options.dataType] - Set to 'pdf' for views of type "JasperReports report"
+     * @param {object} [__namedParameters]
+     * @param {DataType} [__namedParameters.dataType] - Set to 'pdf' for views of type "JasperReports report"
      *     to show the report PDF directly, without any Cadenza headers or footers.
-     * @param {UiFeature[]} [options.disabledUiFeatures] - Cadenza UI features to disable
-     * @param {boolean} [options.expandNavigator] - Indicates if the navigator should be expanded.
-     * @param {FilterVariables} [options.filter] - Filter variables
-     * @param {boolean} [options.hideMainHeaderAndFooter] - Whether to hide the main Cadenza header and footer
-     * @param {boolean} [options.hideWorkbookToolBar] - Whether to hide the workbook toolbar
-     * @param {GlobalId} [options.highlightGlobalId] - The ID of an item to highlight / expand in the navigator
-     * @param {String} [options.labelSet] - The name of a label set defined in the `basicweb-config.xml` (only supported for the welcome page)
-     * @param {OperationMode} [options.operationMode] - The mode in which a workbook should be operated
-     * @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
+     * @param {UiFeature[]} [__namedParameters.disabledUiFeatures] - Cadenza UI features to disable
+     * @param {boolean} [__namedParameters.expandNavigator] - Indicates if the navigator should be expanded.
+     * @param {FilterVariables} [__namedParameters.filter] - Filter variables
+     * @param {boolean} [__namedParameters.hideMainHeaderAndFooter] - Whether to hide the main Cadenza header and footer
+     * @param {boolean} [__namedParameters.hideWorkbookToolBar] - Whether to hide the workbook toolbar
+     * @param {GlobalId} [__namedParameters.highlightGlobalId] - The ID of an item to highlight / expand in the navigator
+     * @param {String} [__namedParameters.labelSet] - The name of a label set defined in the `basicweb-config.xml` (only supported for the welcome page)
+     * @param {OperationMode} [__namedParameters.operationMode] - The mode in which a workbook should be operated
+     * @param {AbortSignal} [__namedParameters.signal] - A signal to abort the iframe loading
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
@@ -80,14 +80,15 @@ export class CadenzaClient {
     } | undefined, ...args: any[]): Promise<void>;
     /**
      * Reload the views of a worksheet.
-     * @param {object} [options] - Options
-     * @param {boolean} [options.invalidateCaches] - When true, caches will be invalidated for objecttypes used
+     * @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 }?: {
         invalidateCaches?: boolean | undefined;
-    } | undefined, ...args: any[]): void;
+    } | undefined, ...args: any[]): Promise<void>;
     /**
      * Sends a message to parent Cadenza window to close the window containing this application
      * @postMessageParent
@@ -97,20 +98,24 @@ export class CadenzaClient {
      * Show a workbook map view in an iframe.
      *
      * @param {EmbeddingTargetId} mapView - The workbook map view to show
-     * @param {object} [options] - Options
-     * @param {UiFeature[]} [options.disabledUiFeatures] - Cadenza UI features to disable
-     * @param {boolean} [options.expandNavigator] - Indicates if the navigator should be expanded.
-     * @param {FilterVariables} [options.filter] - Filter variables
-     * @param {Geometry} [options.geometry] - A geometry to show on the map
-     * @param {boolean} [options.hideMainHeaderAndFooter] - Whether to hide the main Cadenza header and footer
-     * @param {boolean} [options.hideWorkbookToolBar] - Whether to hide the workbook toolbar
-     * @param {GlobalId} [options.highlightGlobalId] - The ID of an item to highlight / expand in the navigator
-     * @param {string} [options.locationFinder] - A search query for the location finder
-     * @param {Extent} [options.mapExtent] - A map extent to set
-     * @param {OperationMode} [options.operationMode] - The mode in which a workbook should be operated
-     * @param {boolean} [options.useMapSrs] -  Whether the geometry and the extent are in the map's SRS (otherwise EPSG:4326 is assumed)
-     * @param {ExtentStrategy} [options.extentStrategy] - Strategy to define the new map extent
-     * @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
+     * @param {object} [__namedParameters] - Options
+     * @param {UiFeature[]} [__namedParameters.disabledUiFeatures] - Cadenza UI features to disable
+     * @param {boolean} [__namedParameters.expandNavigator] - Indicates if the navigator should be expanded.
+     * @param {FilterVariables} [__namedParameters.filter] - Filter variables
+     * @param {Geometry} [__namedParameters.geometry] - A geometry to show on the map
+     * @param {boolean} [__namedParameters.hideMainHeaderAndFooter] - Whether to hide the main Cadenza header and footer
+     * @param {boolean} [__namedParameters.hideWorkbookToolBar] - Whether to hide the workbook toolbar
+     * @param {GlobalId} [__namedParameters.highlightGlobalId] - The ID of an item to highlight / expand in the navigator
+     * @param {string} [__namedParameters.locationFinder] - A search query for the location finder
+     * @param {Extent} [__namedParameters.mapExtent] - A map extent to set
+     * @param {OperationMode} [__namedParameters.operationMode] - The mode in which a workbook should be operated
+     * @param {boolean} [__namedParameters.useMapSrs] -  Whether the geometry and the extent are in the map's SRS (otherwise EPSG:4326 is assumed)
+     * @param {ExtentStrategy} [__namedParameters.extentStrategy] - Strategy to define the initial map extent. A given extentStrategy
+     *    trumps zooming to a specified mapExtent
+     *    which trumps zooming to a locationFinder result
+     *    which trumps zooming to the initial extent of the opened mapView.
+     *    If a specified {@link GeometryExtentStrategy} doesn't contain a 'geometry', the 'geometry' of this API call is used.
+     * @param {AbortSignal} [__namedParameters.signal] - A signal to abort the iframe loading
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
@@ -225,14 +230,14 @@ 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.
-     * @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
+     * @param {object} [__namedParameters] - Options
+     * @param {FilterVariables} [__namedParameters.filter] - Filter variables
+     * @param {string} [__namedParameters.locationFinder] - A search query for the location finder
+     * @param {Extent} [__namedParameters.mapExtent] - A map extent to set
+     * @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.
+     * @param {boolean} [__namedParameters.useMapSrs] - Whether the created geometry should use the map's SRS (otherwise EPSG:4326 will be used)
+     * @param {OperationMode} [__namedParameters.operationMode] - The mode in which a workbook should be operated
+     * @param {AbortSignal} [__namedParameters.signal] - A signal to abort the iframe loading
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
@@ -255,15 +260,19 @@ 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.
-     * @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 {ExtentStrategy} [options.extentStrategy] - Strategy to define the new map extent
-     * @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
+     * @param {object} [__namedParameters] - Options
+     * @param {FilterVariables} [__namedParameters.filter] - Filter variables
+     * @param {string} [__namedParameters.locationFinder] - A search query for the location finder
+     * @param {Extent} [__namedParameters.mapExtent] - A map extent to set
+     * @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.
+     * @param {boolean} [__namedParameters.useMapSrs] - Whether the geometry is in the map's SRS (otherwise EPSG:4326 is assumed)
+     * @param {OperationMode} [__namedParameters.operationMode] - The mode in which a workbook should be operated
+     * @param {ExtentStrategy} [__namedParameters.extentStrategy] - Strategy to define the initial map extent. A given extentStrategy
+     *    trumps zooming to a specified mapExtent
+     *    which trumps zooming to a locationFinder result
+     *    which trumps zooming to the initial extent of the opened mapView.
+     *    If a specified {@link GeometryExtentStrategy} doesn't contain a 'geometry', the 'geometry' of this API call is used.
+     * @param {AbortSignal} [__namedParameters.signal] - A signal to abort the iframe loading
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
@@ -296,15 +305,15 @@ export class CadenzaClient {
      * Select objects in a workbook map.
      *
      * @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
+     * @param {object} [__namedParameters] - Options
+     * @param {FilterVariables} [__namedParameters.filter] - Filter variables
+     * @param {(WorkbookLayerPath | string)[]} [__namedParameters.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
-     * @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
+     * @param {string} [__namedParameters.locationFinder] - A search query for the location finder
+     * @param {Extent} [__namedParameters.mapExtent] - A map extent to set
+     * @param {boolean} [__namedParameters.useMapSrs] - Whether the geometry is in the map's SRS (otherwise EPSG:4326 is assumed)
+     * @param {OperationMode} [__namedParameters.operationMode] - The mode in which a workbook should be operated
+     * @param {AbortSignal} [__namedParameters.signal] - A signal to abort the iframe loading
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
@@ -345,10 +354,10 @@ export class CadenzaClient {
      * @param {DataType} dataType - The data type you want to get back from the server.
      *   Currently, `"csv"`, `"excel"` and `"json"` are supported for table and indicator views
      *   and `"pdf"` for views of type "JasperReports report".
-     * @param {object} [options] - Options
-     * @param {FilterVariables} [options.filter] - Filter variables
-     * @param {TablePart[]} [options.parts] - Table parts to export; If not specified, all parts are exported.
-     * @param {AbortSignal} [options.signal] - A signal to abort the data fetching
+     * @param {object} [__namedParameters] - Options
+     * @param {FilterVariables} [__namedParameters.filter] - Filter variables
+     * @param {TablePart[]} [__namedParameters.parts] - Table parts to export; If not specified, all parts are exported.
+     * @param {AbortSignal} [__namedParameters.signal] - A signal to abort the data fetching
      * @return {Promise<Response>} A `Promise` for the fetch response
      * @throws For invalid arguments
      * @server
@@ -365,11 +374,11 @@ export class CadenzaClient {
      * @param {(WorkbookLayerPath | string)[]} layerPath - Layer path to identify the layer
      *  (identified using layer paths or print names)
      * @param {unknown[][]} objectIds - The IDs of the objects to select
-     * @param {object} [options] - Options
-     * @param {FilterVariables} [options.filter] - Filter variables
-     * @param {AbortSignal} [options.signal] - A signal to abort the data fetching
-     * @param {Boolean} [options.useMapSrs] - Use the map SRS instead of WGS84
-     * @param {Boolean} [options.fullGeometries] - Return non-simplified geometries
+     * @param {object} [__namedParameters] - Options
+     * @param {FilterVariables} [__namedParameters.filter] - Filter variables
+     * @param {AbortSignal} [__namedParameters.signal] - A signal to abort the data fetching
+     * @param {Boolean} [__namedParameters.useMapSrs] - Use the map SRS instead of WGS84
+     * @param {Boolean} [__namedParameters.fullGeometries] - Return non-simplified geometries
      * @return {Promise<FeatureCollection>} A `Promise` for the fetch response
      * @throws For invalid arguments
      */
@@ -386,10 +395,10 @@ export class CadenzaClient {
      * @param {(WorkbookLayerPath | string)[]} layerPath - Layer path to identify the layer
      *  (identified using layer paths or print names)
      * @param {Geometry} geometry - The intersection geometry
-     * @param {object} [options] - Options
-     * @param {boolean} [options.useMapSrs]  - The intersection geometry and the result geometries are in the map's SRS (otherwise EPSG:4326 is assumed)
-     * @param {Distance} [options.buffer] - Buffer size for geometry of the transition
-     * @param {AbortSignal} [options.signal] - A signal to abort the data fetching
+     * @param {object} [__namedParameters] - Options
+     * @param {boolean} [__namedParameters.useMapSrs]  - The intersection geometry and the result geometries are in the map's SRS (otherwise EPSG:4326 is assumed)
+     * @param {Distance} [__namedParameters.buffer] - Buffer size for geometry of the transition
+     * @param {AbortSignal} [__namedParameters.signal] - A signal to abort the data fetching
      * @return {Promise<FeatureCollection>} A `Promise` for the fetch response
      * @server
      */
@@ -407,10 +416,10 @@ export class CadenzaClient {
      * @param {DataType} dataType - The data type you want to get back from the server.
      *   Currently, `"csv"`, `"excel"` and `"json"` are supported for table and indicator views
      *   and `"pdf"` for views of type "JasperReports report".
-     * @param {object} [options] - Options
-     * @param {string} [options.fileName] - The file name to use; The file extension is appended by Cadenza.
-     * @param {FilterVariables} [options.filter] - Filter variables
-     * @param {TablePart[]} [options.parts] - Table parts to export; If not specified, all parts are exported.
+     * @param {object} [__namedParameters] - Options
+     * @param {string} [__namedParameters.fileName] - The file name to use; The file extension is appended by Cadenza.
+     * @param {FilterVariables} [__namedParameters.filter] - Filter variables
+     * @param {TablePart[]} [__namedParameters.parts] - Table parts to export; If not specified, all parts are exported.
      * @throws For invalid arguments
      * @server
      */

package/cadenza.js

@@ -184,7 +184,7 @@ export class CadenzaClient {
     /**
      *
      * @hidden
-     * @param {CadenzaClientOptions} [options]
+     * @param {CadenzaClientOptions} [__namedParameters]
      */
     constructor({ baseUrl, debug = false, iframe, webApplication } = {}) {
         if (webApplication) {
@@ -241,18 +241,18 @@ export class CadenzaClient {
      * Show a page, workbook, worksheet or workbook view in an iframe.
      *
      * @param {PageSource | EmbeddingTargetId} source - The source to show
-     * @param {object} [options]
-     * @param {DataType} [options.dataType] - Set to 'pdf' for views of type "JasperReports report"
+     * @param {object} [__namedParameters]
+     * @param {DataType} [__namedParameters.dataType] - Set to 'pdf' for views of type "JasperReports report"
      *     to show the report PDF directly, without any Cadenza headers or footers.
-     * @param {UiFeature[]} [options.disabledUiFeatures] - Cadenza UI features to disable
-     * @param {boolean} [options.expandNavigator] - Indicates if the navigator should be expanded.
-     * @param {FilterVariables} [options.filter] - Filter variables
-     * @param {boolean} [options.hideMainHeaderAndFooter] - Whether to hide the main Cadenza header and footer
-     * @param {boolean} [options.hideWorkbookToolBar] - Whether to hide the workbook toolbar
-     * @param {GlobalId} [options.highlightGlobalId] - The ID of an item to highlight / expand in the navigator
-     * @param {String} [options.labelSet] - The name of a label set defined in the `basicweb-config.xml` (only supported for the welcome page)
-     * @param {OperationMode} [options.operationMode] - The mode in which a workbook should be operated
-     * @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
+     * @param {UiFeature[]} [__namedParameters.disabledUiFeatures] - Cadenza UI features to disable
+     * @param {boolean} [__namedParameters.expandNavigator] - Indicates if the navigator should be expanded.
+     * @param {FilterVariables} [__namedParameters.filter] - Filter variables
+     * @param {boolean} [__namedParameters.hideMainHeaderAndFooter] - Whether to hide the main Cadenza header and footer
+     * @param {boolean} [__namedParameters.hideWorkbookToolBar] - Whether to hide the workbook toolbar
+     * @param {GlobalId} [__namedParameters.highlightGlobalId] - The ID of an item to highlight / expand in the navigator
+     * @param {String} [__namedParameters.labelSet] - The name of a label set defined in the `basicweb-config.xml` (only supported for the welcome page)
+     * @param {OperationMode} [__namedParameters.operationMode] - The mode in which a workbook should be operated
+     * @param {AbortSignal} [__namedParameters.signal] - A signal to abort the iframe loading
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
@@ -285,14 +285,15 @@ export class CadenzaClient {
     }
     /**
      * Reload the views of a worksheet.
-     * @param {object} [options] - Options
-     * @param {boolean} [options.invalidateCaches] - When true, caches will be invalidated for objecttypes used
+     * @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
@@ -307,20 +308,24 @@ export class CadenzaClient {
      * Show a workbook map view in an iframe.
      *
      * @param {EmbeddingTargetId} mapView - The workbook map view to show
-     * @param {object} [options] - Options
-     * @param {UiFeature[]} [options.disabledUiFeatures] - Cadenza UI features to disable
-     * @param {boolean} [options.expandNavigator] - Indicates if the navigator should be expanded.
-     * @param {FilterVariables} [options.filter] - Filter variables
-     * @param {Geometry} [options.geometry] - A geometry to show on the map
-     * @param {boolean} [options.hideMainHeaderAndFooter] - Whether to hide the main Cadenza header and footer
-     * @param {boolean} [options.hideWorkbookToolBar] - Whether to hide the workbook toolbar
-     * @param {GlobalId} [options.highlightGlobalId] - The ID of an item to highlight / expand in the navigator
-     * @param {string} [options.locationFinder] - A search query for the location finder
-     * @param {Extent} [options.mapExtent] - A map extent to set
-     * @param {OperationMode} [options.operationMode] - The mode in which a workbook should be operated
-     * @param {boolean} [options.useMapSrs] -  Whether the geometry and the extent are in the map's SRS (otherwise EPSG:4326 is assumed)
-     * @param {ExtentStrategy} [options.extentStrategy] - Strategy to define the new map extent
-     * @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
+     * @param {object} [__namedParameters] - Options
+     * @param {UiFeature[]} [__namedParameters.disabledUiFeatures] - Cadenza UI features to disable
+     * @param {boolean} [__namedParameters.expandNavigator] - Indicates if the navigator should be expanded.
+     * @param {FilterVariables} [__namedParameters.filter] - Filter variables
+     * @param {Geometry} [__namedParameters.geometry] - A geometry to show on the map
+     * @param {boolean} [__namedParameters.hideMainHeaderAndFooter] - Whether to hide the main Cadenza header and footer
+     * @param {boolean} [__namedParameters.hideWorkbookToolBar] - Whether to hide the workbook toolbar
+     * @param {GlobalId} [__namedParameters.highlightGlobalId] - The ID of an item to highlight / expand in the navigator
+     * @param {string} [__namedParameters.locationFinder] - A search query for the location finder
+     * @param {Extent} [__namedParameters.mapExtent] - A map extent to set
+     * @param {OperationMode} [__namedParameters.operationMode] - The mode in which a workbook should be operated
+     * @param {boolean} [__namedParameters.useMapSrs] -  Whether the geometry and the extent are in the map's SRS (otherwise EPSG:4326 is assumed)
+     * @param {ExtentStrategy} [__namedParameters.extentStrategy] - Strategy to define the initial map extent. A given extentStrategy
+     *    trumps zooming to a specified mapExtent
+     *    which trumps zooming to a locationFinder result
+     *    which trumps zooming to the initial extent of the opened mapView.
+     *    If a specified {@link GeometryExtentStrategy} doesn't contain a 'geometry', the 'geometry' of this API call is used.
+     * @param {AbortSignal} [__namedParameters.signal] - A signal to abort the iframe loading
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
@@ -333,7 +338,12 @@ export class CadenzaClient {
         if (geometry) {
             assertValidGeometryType(geometry.type);
         }
-        const zoomToGeometry = geometry && extentStrategy?.type === 'geometry';
+        const validExtentStrategy = sanitizeExtentStrategy({
+            geometry,
+            extentStrategy,
+        });
+        const zoomToGeometry = validExtentStrategy?.type === 'geometry' &&
+            validExtentStrategy?.geometry === geometry;
         const params = createParams({
             disabledUiFeatures,
             expandNavigator,
@@ -356,6 +366,9 @@ export class CadenzaClient {
                 zoomToGeometry,
             });
         }
+        if (!zoomToGeometry && validExtentStrategy) {
+            this.#setExtentStrategy(validExtentStrategy);
+        }
     }
     /**
      * Expand/collapse the navigator.
@@ -494,14 +507,14 @@ 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.
-     * @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
+     * @param {object} [__namedParameters] - Options
+     * @param {FilterVariables} [__namedParameters.filter] - Filter variables
+     * @param {string} [__namedParameters.locationFinder] - A search query for the location finder
+     * @param {Extent} [__namedParameters.mapExtent] - A map extent to set
+     * @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.
+     * @param {boolean} [__namedParameters.useMapSrs] - Whether the created geometry should use the map's SRS (otherwise EPSG:4326 will be used)
+     * @param {OperationMode} [__namedParameters.operationMode] - The mode in which a workbook should be operated
+     * @param {AbortSignal} [__namedParameters.signal] - A signal to abort the iframe loading
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
@@ -529,15 +542,19 @@ 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.
-     * @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 {ExtentStrategy} [options.extentStrategy] - Strategy to define the new map extent
-     * @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
+     * @param {object} [__namedParameters] - Options
+     * @param {FilterVariables} [__namedParameters.filter] - Filter variables
+     * @param {string} [__namedParameters.locationFinder] - A search query for the location finder
+     * @param {Extent} [__namedParameters.mapExtent] - A map extent to set
+     * @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.
+     * @param {boolean} [__namedParameters.useMapSrs] - Whether the geometry is in the map's SRS (otherwise EPSG:4326 is assumed)
+     * @param {OperationMode} [__namedParameters.operationMode] - The mode in which a workbook should be operated
+     * @param {ExtentStrategy} [__namedParameters.extentStrategy] - Strategy to define the initial map extent. A given extentStrategy
+     *    trumps zooming to a specified mapExtent
+     *    which trumps zooming to a locationFinder result
+     *    which trumps zooming to the initial extent of the opened mapView.
+     *    If a specified {@link GeometryExtentStrategy} doesn't contain a 'geometry', the 'geometry' of this API call is used.
+     * @param {AbortSignal} [__namedParameters.signal] - A signal to abort the iframe loading
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
@@ -549,7 +566,12 @@ export class CadenzaClient {
     async editGeometry(backgroundMapView, geometry, { filter, locationFinder, mapExtent, minScale, useMapSrs, extentStrategy, operationMode, signal, } = {}) {
         this.#log('CadenzaClient#editGeometry', ...arguments);
         assertValidGeometryType(geometry.type);
-        const zoomToGeometry = geometry && extentStrategy?.type === 'geometry';
+        const validExtentStrategy = sanitizeExtentStrategy({
+            geometry,
+            extentStrategy,
+        });
+        const zoomToGeometry = validExtentStrategy?.type === 'geometry' &&
+            validExtentStrategy?.geometry === geometry;
         const params = createParams({
             action: 'editGeometry',
             filter,
@@ -568,6 +590,9 @@ export class CadenzaClient {
                 zoomToGeometry,
             });
         }
+        if (!zoomToGeometry && validExtentStrategy) {
+            this.#setExtentStrategy(validExtentStrategy);
+        }
     }
     /**
      * Set custom validity state of the geometry editor in addition to the default validation state (including errors and
@@ -586,15 +611,15 @@ export class CadenzaClient {
      * Select objects in a workbook map.
      *
      * @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
+     * @param {object} [__namedParameters] - Options
+     * @param {FilterVariables} [__namedParameters.filter] - Filter variables
+     * @param {(WorkbookLayerPath | string)[]} [__namedParameters.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
-     * @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
+     * @param {string} [__namedParameters.locationFinder] - A search query for the location finder
+     * @param {Extent} [__namedParameters.mapExtent] - A map extent to set
+     * @param {boolean} [__namedParameters.useMapSrs] - Whether the geometry is in the map's SRS (otherwise EPSG:4326 is assumed)
+     * @param {OperationMode} [__namedParameters.operationMode] - The mode in which a workbook should be operated
+     * @param {AbortSignal} [__namedParameters.signal] - A signal to abort the iframe loading
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
@@ -800,10 +825,10 @@ export class CadenzaClient {
      * @param {DataType} dataType - The data type you want to get back from the server.
      *   Currently, `"csv"`, `"excel"` and `"json"` are supported for table and indicator views
      *   and `"pdf"` for views of type "JasperReports report".
-     * @param {object} [options] - Options
-     * @param {FilterVariables} [options.filter] - Filter variables
-     * @param {TablePart[]} [options.parts] - Table parts to export; If not specified, all parts are exported.
-     * @param {AbortSignal} [options.signal] - A signal to abort the data fetching
+     * @param {object} [__namedParameters] - Options
+     * @param {FilterVariables} [__namedParameters.filter] - Filter variables
+     * @param {TablePart[]} [__namedParameters.parts] - Table parts to export; If not specified, all parts are exported.
+     * @param {AbortSignal} [__namedParameters.signal] - A signal to abort the data fetching
      * @return {Promise<Response>} A `Promise` for the fetch response
      * @throws For invalid arguments
      * @server
@@ -821,11 +846,11 @@ export class CadenzaClient {
      * @param {(WorkbookLayerPath | string)[]} layerPath - Layer path to identify the layer
      *  (identified using layer paths or print names)
      * @param {unknown[][]} objectIds - The IDs of the objects to select
-     * @param {object} [options] - Options
-     * @param {FilterVariables} [options.filter] - Filter variables
-     * @param {AbortSignal} [options.signal] - A signal to abort the data fetching
-     * @param {Boolean} [options.useMapSrs] - Use the map SRS instead of WGS84
-     * @param {Boolean} [options.fullGeometries] - Return non-simplified geometries
+     * @param {object} [__namedParameters] - Options
+     * @param {FilterVariables} [__namedParameters.filter] - Filter variables
+     * @param {AbortSignal} [__namedParameters.signal] - A signal to abort the data fetching
+     * @param {Boolean} [__namedParameters.useMapSrs] - Use the map SRS instead of WGS84
+     * @param {Boolean} [__namedParameters.fullGeometries] - Return non-simplified geometries
      * @return {Promise<FeatureCollection>} A `Promise` for the fetch response
      * @throws For invalid arguments
      */
@@ -848,10 +873,10 @@ export class CadenzaClient {
      * @param {(WorkbookLayerPath | string)[]} layerPath - Layer path to identify the layer
      *  (identified using layer paths or print names)
      * @param {Geometry} geometry - The intersection geometry
-     * @param {object} [options] - Options
-     * @param {boolean} [options.useMapSrs]  - The intersection geometry and the result geometries are in the map's SRS (otherwise EPSG:4326 is assumed)
-     * @param {Distance} [options.buffer] - Buffer size for geometry of the transition
-     * @param {AbortSignal} [options.signal] - A signal to abort the data fetching
+     * @param {object} [__namedParameters] - Options
+     * @param {boolean} [__namedParameters.useMapSrs]  - The intersection geometry and the result geometries are in the map's SRS (otherwise EPSG:4326 is assumed)
+     * @param {Distance} [__namedParameters.buffer] - Buffer size for geometry of the transition
+     * @param {AbortSignal} [__namedParameters.signal] - A signal to abort the data fetching
      * @return {Promise<FeatureCollection>} A `Promise` for the fetch response
      * @server
      */
@@ -903,10 +928,10 @@ export class CadenzaClient {
      * @param {DataType} dataType - The data type you want to get back from the server.
      *   Currently, `"csv"`, `"excel"` and `"json"` are supported for table and indicator views
      *   and `"pdf"` for views of type "JasperReports report".
-     * @param {object} [options] - Options
-     * @param {string} [options.fileName] - The file name to use; The file extension is appended by Cadenza.
-     * @param {FilterVariables} [options.filter] - Filter variables
-     * @param {TablePart[]} [options.parts] - Table parts to export; If not specified, all parts are exported.
+     * @param {object} [__namedParameters] - Options
+     * @param {string} [__namedParameters.fileName] - The file name to use; The file extension is appended by Cadenza.
+     * @param {FilterVariables} [__namedParameters.filter] - Filter variables
+     * @param {TablePart[]} [__namedParameters.parts] - Table parts to export; If not specified, all parts are exported.
      * @throws For invalid arguments
      * @server
      */
@@ -1105,6 +1130,30 @@ function createParams({ action, dataType, disabledUiFeatures, expandNavigator, f
 function array(/** @type unknown */ value) {
     return Array.isArray(value) ? value : [value];
 }
+/**
+ * Creates a valid extent strategy
+ *
+ * If the result is not a valid extent strategy, the return value is undefined.
+ *
+ * @param {object} __namedParameters
+ * @param {Geometry} [__namedParameters.geometry]
+ * @param {ExtentStrategy} [__namedParameters.extentStrategy]
+ * @return {ExtentStrategy | undefined}
+ */
+function sanitizeExtentStrategy({ extentStrategy, geometry } = {}) {
+    if (extentStrategy) {
+        switch (extentStrategy.type) {
+            case 'geometry':
+                geometry = extentStrategy.geometry ?? geometry;
+                if (geometry) {
+                    return { type: 'geometry', geometry };
+                }
+                break;
+            default:
+                return extentStrategy;
+        }
+    }
+}
 // Please do not add internal event types like 'ready' here.
 /**
  * @typedef {'action'

package/package.json

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