@disy/cadenza.js 10.2.3 → 10.2.5

package/cadenza.d.ts

@@ -30,13 +30,14 @@ export function cadenza(baseUrl: string, options?: CadenzaClientOptions | undefi
  *   When aborted, the result Promise is rejected with an {@link AbortError}.
  * * If there's another error, the result Promise is rejected with a {@link CadenzaError}.
  * * For methods that support the `hideMainHeaderAndFooter` and `hideWorkbookToolBar` parameters - the parameters cannot override the configuration of an embedding target.
- * * For methods that support the `locationFinder` and `mapExtent` parameters - when both are given, the `mapExtent` takes precedence.
+ * * For methods that support the _deprecated_ `locationFinder` and `mapExtent` parameters - when both are given, the `mapExtent` takes precedence.
+ *   * Both `locationFinder` and `mapExtent` parameters are _deprecated_ - Use {@link LocationFinderExtentStrategy} or {@link StaticExtentStrategy} instead.
  */
 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,19 +48,19 @@ 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 embedding targets of type report and of views with view
+     * @param {object} [__namedParameters]
+     * @param {DataType} [__namedParameters.dataType] - Set to 'pdf' for embedding targets of type report and of views with view
      *     type of "JasperReports report" to show the generated 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
@@ -81,8 +82,8 @@ 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
      * @postMessage
      */
@@ -98,20 +99,21 @@ 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 {ZoomTarget} [options.zoomTarget] - A target Cadenza should zoom to
-     * @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
+     * @param {object} [__namedParameters] - Options
+     * @param {LayerDefinition[]} [__namedParameters.additionalLayers] - Layer definitions to be imported and shown in the background, as a basis for the drawing.
+     * @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 - _Deprecated_: Use {@link LocationFinderExtentStrategy} instead.
+     * @param {Extent} [__namedParameters.mapExtent] - A map extent to set - _Deprecated_: Use {@link StaticExtentStrategy} instead.
+     * @param {OperationMode} [__namedParameters.operationMode] - The mode in which a workbook should be operated
+     * @param {AbortSignal} [__namedParameters.signal] - A signal to abort the iframe loading
+     * @param {boolean} [__namedParameters.useMapSrs] - Whether the coordinates specified in other parameters are specified in the map's SRS (otherwise EPSG:4326 is assumed)
+     * @param {ExtentStrategy} [__namedParameters.extentStrategy] - Defines the initial map extent; If not given, Cadenza's default logic is used.
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
@@ -119,7 +121,8 @@ export class CadenzaClient {
      * - {@link CadenzaActionEvent}
      * @embed
      */
-    showMap(mapView: EmbeddingTargetId, { disabledUiFeatures, expandNavigator, filter, geometry, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, locationFinder, mapExtent, operationMode, useMapSrs, zoomTarget, signal, }?: {
+    showMap(mapView: EmbeddingTargetId, { disabledUiFeatures, expandNavigator, filter, geometry, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, locationFinder, mapExtent, operationMode, useMapSrs, extentStrategy, signal, additionalLayers, }?: {
+        additionalLayers?: LayerDefinition[] | undefined;
         disabledUiFeatures?: UiFeature[] | undefined;
         expandNavigator?: boolean | undefined;
         filter?: FilterVariables | undefined;
@@ -130,9 +133,9 @@ export class CadenzaClient {
         locationFinder?: string | undefined;
         mapExtent?: Extent | undefined;
         operationMode?: OperationMode | undefined;
-        useMapSrs?: boolean | undefined;
-        zoomTarget?: GeometryZoomTarget | undefined;
         signal?: AbortSignal | undefined;
+        useMapSrs?: boolean | undefined;
+        extentStrategy?: ExtentStrategy | undefined;
     } | undefined, ...args: any[]): Promise<void>;
     /**
      * Expand/collapse the navigator.
@@ -206,12 +209,6 @@ export class CadenzaClient {
      * @postMessage
      */
     removeSelection(layer: WorkbookLayerPath | string, values: unknown[][], ...args: any[]): Promise<void>;
-    /**
-     * @typedef LayerDefinition
-     * @property {string} name - The layer's name.
-     * @property {'geojson'} type - The layer's type.
-     * @property {FeatureCollection} content - The layer's content in geojson format.
-     */
     /**
      * Create a geometry.
      *
@@ -220,16 +217,17 @@ export class CadenzaClient {
      *
      * @param {EmbeddingTargetId} backgroundMapView - The workbook map view in the background
      * @param {GeometryType} geometryType - The geometry type
-     * @param {object} [options] - Options
-     * @param {UiFeature[]} [options.disabledUiFeatures] - Cadenza UI features to disable
-     * @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 {LayerDefinition[]} [options.additionalLayers] - Layer definitions to be imported and shown in the background, as a basis for the drawing.
+     * @param {object} [__namedParameters] - Options
+     * @param {LayerDefinition[]} [__namedParameters.additionalLayers] - Layer definitions to be imported and shown in the background, as a basis for the drawing.
+     * @param {UiFeature[]} [__namedParameters.disabledUiFeatures] - Cadenza UI features to disable
+     * @param {FilterVariables} [__namedParameters.filter] - Filter variables
+     * @param {string} [__namedParameters.locationFinder] - A search query for the location finder - _Deprecated_: Use {@link LocationFinderExtentStrategy} instead.
+     * @param {Extent} [__namedParameters.mapExtent] - A map extent to set - _Deprecated_: Use {@link StaticExtentStrategy} instead.
+     * @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 {OperationMode} [__namedParameters.operationMode] - The mode in which a workbook should be operated
+     * @param {AbortSignal} [__namedParameters.signal] - A signal to abort the iframe loading
+     * @param {boolean} [__namedParameters.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)
+     * @param {ExtentStrategy} [__namedParameters.extentStrategy] - Defines the initial map extent; If not given, Cadenza's default logic is used.
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
@@ -238,46 +236,34 @@ export class CadenzaClient {
      * - {@link CadenzaEditGeometryCancelEvent}
      * @embed
      */
-    createGeometry(backgroundMapView: EmbeddingTargetId, geometryType: GeometryType, { disabledUiFeatures, filter, locationFinder, mapExtent, minScale, useMapSrs, operationMode, signal, additionalLayers, }?: {
+    createGeometry(backgroundMapView: EmbeddingTargetId, geometryType: GeometryType, { additionalLayers, disabledUiFeatures, filter, locationFinder, mapExtent, minScale, useMapSrs, operationMode, signal, extentStrategy, }?: {
+        additionalLayers?: LayerDefinition[] | undefined;
         disabledUiFeatures?: UiFeature[] | undefined;
         filter?: FilterVariables | undefined;
         locationFinder?: string | undefined;
         mapExtent?: Extent | undefined;
         minScale?: number | undefined;
-        useMapSrs?: boolean | undefined;
         operationMode?: OperationMode | undefined;
         signal?: AbortSignal | undefined;
-        additionalLayers?: {
-            /**
-             * - The layer's name.
-             */
-            name: string;
-            /**
-             * - The layer's type.
-             */
-            type: 'geojson';
-            /**
-             * - The layer's content in geojson format.
-             */
-            content: FeatureCollection;
-        }[] | undefined;
+        useMapSrs?: boolean | undefined;
+        extentStrategy?: ExtentStrategy | undefined;
     } | undefined, ...args: any[]): Promise<void>;
     /**
      * Edit a geometry.
      *
      * @param {EmbeddingTargetId} backgroundMapView - The workbook map view in the background
      * @param {Geometry} geometry - The geometry
-     * @param {object} [options] - Options
-     * @param {UiFeature[]} [options.disabledUiFeatures] - Cadenza UI features to disable
-     * @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 {ZoomTarget} [options.zoomTarget] - A target Cadenza should zoom to
-     * @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
-     * @param {LayerDefinition[]} [options.additionalLayers] - Layer definitions to be imported and shown in the background, as a basis for the drawing. Each is a layer definition, with name, type and content (a Geojson featureCollection).
+     * @param {object} [__namedParameters] - Options
+     * @param {LayerDefinition[]} [__namedParameters.additionalLayers] - Layer definitions to be imported and shown in the background, as a basis for the drawing. Each is a layer definition, with name, type and content (a Geojson featureCollection).
+     * @param {UiFeature[]} [__namedParameters.disabledUiFeatures] - Cadenza UI features to disable
+     * @param {FilterVariables} [__namedParameters.filter] - Filter variables
+     * @param {string} [__namedParameters.locationFinder] - A search query for the location finder - _Deprecated_: Use {@link LocationFinderExtentStrategy} instead.
+     * @param {Extent} [__namedParameters.mapExtent] - A map extent to set - _Deprecated_: Use {@link StaticExtentStrategy} instead.
+     * @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 {OperationMode} [__namedParameters.operationMode] - The mode in which a workbook should be operated
+     * @param {AbortSignal} [__namedParameters.signal] - A signal to abort the iframe loading
+     * @param {boolean} [__namedParameters.useMapSrs] - Whether the coordinates specified in other parameters are specified in the map's SRS (otherwise EPSG:4326 is assumed)
+     * @param {ExtentStrategy} [__namedParameters.extentStrategy] - Defines the initial map extent; If not given, Cadenza's default logic is used.
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
@@ -286,30 +272,17 @@ export class CadenzaClient {
      * - {@link CadenzaEditGeometryCancelEvent}
      * @embed
      */
-    editGeometry(backgroundMapView: EmbeddingTargetId, geometry: Geometry, { disabledUiFeatures, filter, locationFinder, mapExtent, minScale, useMapSrs, zoomTarget, operationMode, signal, additionalLayers, }?: {
+    editGeometry(backgroundMapView: EmbeddingTargetId, geometry: Geometry, { additionalLayers, disabledUiFeatures, filter, locationFinder, mapExtent, minScale, operationMode, signal, useMapSrs, extentStrategy, }?: {
+        additionalLayers?: LayerDefinition[] | undefined;
         disabledUiFeatures?: UiFeature[] | undefined;
         filter?: FilterVariables | undefined;
         locationFinder?: string | undefined;
         mapExtent?: Extent | undefined;
         minScale?: number | undefined;
-        useMapSrs?: boolean | undefined;
         operationMode?: OperationMode | undefined;
-        zoomTarget?: GeometryZoomTarget | undefined;
         signal?: AbortSignal | undefined;
-        additionalLayers?: {
-            /**
-             * - The layer's name.
-             */
-            name: string;
-            /**
-             * - The layer's type.
-             */
-            type: 'geojson';
-            /**
-             * - The layer's content in geojson format.
-             */
-            content: FeatureCollection;
-        }[] | undefined;
+        useMapSrs?: boolean | undefined;
+        extentStrategy?: ExtentStrategy | undefined;
     } | undefined, ...args: any[]): Promise<void>;
     /**
      * Set custom validity state of the geometry editor in addition to the default validation state (including errors and
@@ -325,15 +298,16 @@ 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 - _Deprecated_: Use {@link LocationFinderExtentStrategy} instead.
+     * @param {Extent} [__namedParameters.mapExtent] - A map extent to set - _Deprecated_: Use {@link StaticExtentStrategy} instead.
+     * @param {boolean} [__namedParameters.useMapSrs] - Whether the coordinates specified in other parameters are specified 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
+     * @param {ExtentStrategy} [__namedParameters.extentStrategy] - Defines the initial map extent; If not given, Cadenza's default logic is used.
      * @return {Promise<void>} A `Promise` for when the iframe is loaded
      * @throws For invalid arguments
      * @fires
@@ -343,7 +317,7 @@ export class CadenzaClient {
      * - {@link CadenzaSelectObjectsCancelEvent}
      * @embed
      */
-    selectObjects(backgroundMapView: EmbeddingTargetId, { filter, layers, locationFinder, mapExtent, useMapSrs, operationMode, signal, }?: {
+    selectObjects(backgroundMapView: EmbeddingTargetId, { filter, layers, locationFinder, mapExtent, useMapSrs, operationMode, signal, extentStrategy, }?: {
         filter?: FilterVariables | undefined;
         layers?: (string | WorkbookLayerPath)[] | undefined;
         locationFinder?: string | undefined;
@@ -351,6 +325,7 @@ export class CadenzaClient {
         useMapSrs?: boolean | undefined;
         operationMode?: OperationMode | undefined;
         signal?: AbortSignal | undefined;
+        extentStrategy?: ExtentStrategy | undefined;
     } | undefined, ...args: any[]): Promise<void>;
     /**
      * Subscribe to a `postMessage()` event.
@@ -372,13 +347,13 @@ export class CadenzaClient {
      *
      * @param {EmbeddingTargetId} source - The workbook view to fetch data from.
      * @param {DataType} dataType - The data type you want to get back from the server.
-     *   Currently, `"csv"`, `"excel"` and `"json"` are supported for embedding targets of type view with a view type of
+     *  Currently, `"csv"`, `"excel"` and `"json"` are supported for embedding targets of type view with a view type of
      *   table and indicator. `"pdf"` is supported for embedding targets of type report and of type view with a view type
      *   of "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
@@ -395,11 +370,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
      */
@@ -416,10 +391,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
      */
@@ -435,13 +410,13 @@ export class CadenzaClient {
      *
      * @param {EmbeddingTargetId} source - The workbook view to fetch data from.
      * @param {DataType} dataType - The data type you want to get back from the server.
-     *   Currently, `"csv"`, `"excel"` and `"json"` are supported for embedding targets of type view with a view type of
+     *  Currently, `"csv"`, `"excel"` and `"json"` are supported for embedding targets of type view with a view type of
      *   table and indicator. `"pdf"` is supported for embedding targets of type report and of type view with a view type
      *   of "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
      */
@@ -634,6 +609,20 @@ export type OperationMode = 'normal' | 'simplified';
  * * `"workbook-view-management"` - Add/Edit/Remove workbook views (Is included in 'workbook-design'.)
  */
 export type UiFeature = 'workbook-design' | 'workbook-map-add-layer' | 'workbook-view-management';
+export type LayerDefinition = {
+    /**
+     * - The layer's name.
+     */
+    name: string;
+    /**
+     * - The layer's type.
+     */
+    type: 'geojson';
+    /**
+     * - The layer's content in geojson format.
+     */
+    content: FeatureCollection;
+};
 export type Distance = {
     value: number;
     lengthUnit: LengthUnit;
@@ -667,17 +656,64 @@ export type GeometryType = 'Point' | 'MultiPoint' | 'LineString' | 'MultiLineStr
  */
 export type Extent = [number, number, number, number];
 /**
- * - An object describing a target to zoom to
+ * - Options for defining the initial extent of a workbook map view;
+ *   If the options do not result in a defined extent, Cadenza's default logic is used:
+ *   The map will zoom in the way the underlying workbook map view was configured to initially zoom including all auto
+ *   zooming configurations.
  */
-export type ZoomTarget = GeometryZoomTarget;
+export type ExtentStrategy = GeometryExtentStrategy | LayerDataExtentStrategy | LocationFinderExtentStrategy | StaticExtentStrategy;
 /**
- * - Instructs Cadenza to zoom to a provided {@Link Geometry}
+ * - The given {@link Geometry } defines the initial map extent.
  */
-export type GeometryZoomTarget = {
+export type GeometryExtentStrategy = {
     /**
-     * The type of the zoom target
+     * - The extent strategy type
      */
     type: 'geometry';
+    /**
+     * - This geometry takes precedence over another geometry that might be given in an API call.
+     */
+    geometry?: Geometry | undefined;
+};
+/**
+ * - The given layers define the initial map extent.
+ */
+export type LayerDataExtentStrategy = {
+    /**
+     * - The extent strategy type
+     */
+    type: 'layerData';
+    /**
+     * - A layer is ignored if either the layer or its extent is not known to Cadenza.
+     * If no layers are given, __all__ map layers are used.
+     */
+    layers?: (string | WorkbookLayerPath)[] | undefined;
+};
+/**
+ * - The first result of a location finder query defines the initial map extent.
+ */
+export type LocationFinderExtentStrategy = {
+    /**
+     * - The extent strategy type
+     */
+    type: 'locationFinder';
+    /**
+     * - This query takes precedence over another query that might be given in an API call.
+     */
+    query: string;
+};
+/**
+ * - The given extent is used as the initial map extent.
+ */
+export type StaticExtentStrategy = {
+    /**
+     * - The extent strategy type
+     */
+    type: 'static';
+    /**
+     * - This extent takes precedence over another extent that might be given in an API call.
+     */
+    extent: Extent;
 };
 /**
  * - A data type