@disy/cadenza.js 10.5.5 → 10.5.7

package/cadenza.js

@@ -18,7 +18,7 @@
  */
 // This placeholder is replaced when Cadenza JS is released,
 // i.e. during development, the version is not available.
-const CADENZAJS_VERSION = '10.5.5';
+const CADENZAJS_VERSION = '10.5.7';
 /**
  * Creates an instance of the Cadenza JS client.
  *
@@ -177,6 +177,7 @@ globalThis.cadenza = Object.assign((/** @type Parameters<cadenza> */ ...args) =>
  * @property {OperationMode} [operationMode] - The mode in which a workbook should be operated
  * @property {AbortSignal} [signal] - A signal to abort the iframe loading
  * @property {SnappingOptions} [snapping] - Passing these options enables snapping
+ * @property {boolean} [hideLegend] - Whether the legend should be hidden initially. Default is true.
  * @property {boolean} [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)
  */
 /**
@@ -186,13 +187,26 @@ globalThis.cadenza = Object.assign((/** @type Parameters<cadenza> */ ...args) =>
  */
 /** @typedef {'columns' | 'values' | 'totals'} TablePart - A part of a table to export */
 /**
- * @typedef {Record<string, string | string[] | number | Date | SpatialFilterValue | null>} FilterVariables - Filter variable names and values
+ * @typedef {string | number} AttributeValue - The value of a Cadenza attribute
  *
- * Variables of type String, Integer, Long, Double and Date can be set.
- * A property named "$spatial" reflects a Spatial filter value and must adhere to type {@link SpatialFilterValue}.
+ * The exact representation is described in [JSON Representation of Cadenza Object Data](../index.html#json-representation-of-cadenza-object-data).
+ */
+/**
+ * @typedef {AttributeValue | bigint | Date} LenientAttributeValue - A lenient variant of {@link AttributeValue} that - for convenience - allows more values.
+ *
+ * Here's how the values are converted to proper attribute values:
+ *
+ * | `LenientAttributeValue` | Conversion to `AttributeType` |
+ * |-------------------------|-------------------------------|
+ * | `bigint`                | `value.toString()`            |
+ * | `Date`                  | `value.toISOString()`         |
+ */
+/**
+ * @typedef {Record<string, LenientAttributeValue | string[] | SpatialFilterValue | null>} FilterVariables - Filter variable names and values
  *
- * _Note:_ Since numbers in JavaScript are Double values ([more info on MDN](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number#number_encoding)),
- * for Long variables, the API is currently limited to the Double value range.
+ * - Use `null` to unset a filter variable.
+ * - Use a `string` array to pass multiple values for a variable that is used in an `IN` expression.
+ * - The name "$spatial" reflects a Spatial filter value and must adhere to type {@link SpatialFilterValue}.
  */
 /**
  * @typedef SpatialFilterValue - Defines a spatial filter variable value.
@@ -207,7 +221,7 @@ globalThis.cadenza = Object.assign((/** @type Parameters<cadenza> */ ...args) =>
 /**
  * @typedef Feature - A adapted [GeoJSON](https://geojson.org/) feature object.
  * @property {'Feature'} type - The object's type
- * @property {any[]} objectId - The id of the feature
+ * @property {AttributeValue[]} objectId - The id of the feature
  * @property {Geometry} geometry - The geometry
  * @property {Record<string, string>} properties - The formated properties
  * @property {number} [area] - The area of a `Polygon` feature
@@ -505,8 +519,9 @@ export class CadenzaClient {
      */
     setFilter(filter) {
         this.#log('CadenzaClient#setFilter', ...arguments);
-        assertValidFilterVariables(filter);
-        return this.#postRequest('setFilter', { filter });
+        return this.#postRequest('setFilter', {
+            filter: sanitizeAndValidateFilterVariables(filter),
+        });
     }
     /**
      * Set the visibility of a layer in the currently shown workbook map view.
@@ -531,7 +546,7 @@ export class CadenzaClient {
      * Set the selection in the currently shown workbook map view.
      *
      * @param {WorkbookLayerPath | string} layer - The data view layer to set the selection in
-     * @param {unknown[][]} values - The IDs of the objects to select
+     * @param {LenientAttributeValue[][]} 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.
@@ -541,7 +556,7 @@ export class CadenzaClient {
         this.#log('CadenzaClient#setSelection', ...arguments);
         const selectionResult = this.#postRequest('setSelection', {
             layer: array(layer),
-            values,
+            values: values.map(sanitizeAndValidateAttributeValues),
         });
         this.#setExtentStrategy(extentStrategy);
         return selectionResult;
@@ -550,7 +565,7 @@ export class CadenzaClient {
      * Add to the selection in the currently shown workbook map view.
      *
      * @param {WorkbookLayerPath | string} layer - The data view layer to change the selection in
-     * @param {unknown[][]} values - The IDs of the objects to select
+     * @param {LenientAttributeValue[][]} 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.
@@ -560,7 +575,7 @@ export class CadenzaClient {
         this.#log('CadenzaClient#addSelection', ...arguments);
         const selectionResult = this.#postRequest('addSelection', {
             layer: array(layer),
-            values,
+            values: values.map(sanitizeAndValidateAttributeValues),
         });
         this.#setExtentStrategy(extentStrategy);
         return selectionResult;
@@ -569,7 +584,7 @@ export class CadenzaClient {
      * Remove from the selection in the currently shown workbook map view.
      *
      * @param {WorkbookLayerPath | string} layer - The data view layer to change the selection in
-     * @param {unknown[][]} values - The IDs of the objects to unselect
+     * @param {LenientAttributeValue[][]} 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.
@@ -579,7 +594,7 @@ export class CadenzaClient {
         this.#log('CadenzaClient#removeSelection', ...arguments);
         const selectionResult = this.#postRequest('removeSelection', {
             layer: array(layer),
-            values,
+            values: values.map(sanitizeAndValidateAttributeValues),
         });
         this.#setExtentStrategy(extentStrategy);
         return selectionResult;
@@ -602,7 +617,7 @@ export class CadenzaClient {
      * - {@link CadenzaEditGeometryCancelEvent}
      * @embed
      */
-    async createGeometry(backgroundMapView, geometryType, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, useMapSrs, operationMode, signal, snapping, } = {}) {
+    async createGeometry(backgroundMapView, geometryType, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, useMapSrs, operationMode, signal, snapping, hideLegend = true, } = {}) {
         this.#log('CadenzaClient#createGeometry', ...arguments);
         const validExtentStrategy = sanitizeExtentStrategy({
             extentStrategy,
@@ -612,6 +627,7 @@ export class CadenzaClient {
             disabledUiFeatures,
             filter,
             geometryType,
+            hideLegend,
             minScale,
             operationMode,
             snapping,
@@ -641,7 +657,7 @@ export class CadenzaClient {
      * - {@link CadenzaEditGeometryCancelEvent}
      * @embed
      */
-    async editGeometry(backgroundMapView, geometry, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, operationMode, signal, snapping, useMapSrs, } = {}) {
+    async editGeometry(backgroundMapView, geometry, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, operationMode, signal, snapping, useMapSrs, hideLegend = true, } = {}) {
         this.#log('CadenzaClient#editGeometry', ...arguments);
         const geometryType = geometry.type;
         assertValidGeometryType(geometryType);
@@ -654,6 +670,7 @@ export class CadenzaClient {
             disabledUiFeatures,
             filter,
             geometryType,
+            hideLegend,
             minScale,
             operationMode,
             snapping,
@@ -687,7 +704,7 @@ export class CadenzaClient {
      * - {@link CadenzaEditGeometryCancelEvent}
      * @embed
      */
-    async batchCreateGeometry(backgroundMapView, geometryType, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, operationMode, signal, snapping, useMapSrs, } = {}) {
+    async batchCreateGeometry(backgroundMapView, geometryType, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, operationMode, signal, snapping, useMapSrs, hideLegend = true, } = {}) {
         this.#log('CadenzaClient#editGeometry', ...arguments);
         assertValidGeometryType(geometryType);
         const validExtentStrategy = sanitizeExtentStrategy({
@@ -699,6 +716,7 @@ export class CadenzaClient {
             disabledUiFeatures,
             filter,
             geometryType,
+            hideLegend,
             minScale,
             operationMode,
             snapping,
@@ -731,7 +749,7 @@ export class CadenzaClient {
      * - {@link CadenzaEditGeometryCancelEvent}
      * @embed
      */
-    async batchEditGeometry(backgroundMapView, features, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, operationMode, signal, snapping, useMapSrs, } = {}) {
+    async batchEditGeometry(backgroundMapView, features, { additionalLayers, disabledUiFeatures, extentStrategy, filter, minScale, operationMode, signal, snapping, useMapSrs, hideLegend = true, } = {}) {
         this.#log('CadenzaClient#editGeometry', ...arguments);
         const geometryType = getGeometryTypeFromFeatureCollection(features);
         const validExtentStrategy = sanitizeExtentStrategy({
@@ -744,6 +762,7 @@ export class CadenzaClient {
             disabledUiFeatures,
             filter,
             geometryType,
+            hideLegend,
             minScale,
             operationMode,
             snapping,
@@ -813,15 +832,23 @@ export class CadenzaClient {
     #setEditFeature(objectId) {
         return this.#postRequest('requestEditFeature', objectId);
     }
+    /**
+     * Sets editor state to ready.
+     */
     #setEditorStateToReady() {
         return this.#postRequest('setEditorState', 'READY');
     }
     /**
-     * Set custom validity state of the geometry editor in addition to the default validation state (including errors and
-     * warnings). When set to error the dialog submission is blocked.
-     * If there already is a custom state set it will override it.
-     * Passing '' will reset the custom state to undefined, meaning no custom state is displayed.
-     * If no geometry editing is started, the method call has no effect.
+     * Set the custom validation status of the geometry editor dialog ( {@link createGeometry}, {@link editGeometry}, {@link batchCreateGeometry}, {@link batchEditGeometry} )
+     * or the {@link selectObjects} dialog in addition to the default validation status (including errors and warnings).
+     *
+     * Behavior:
+     * - When the custom validation status is of type 'error', the dialog submission is blocked.
+     * - If a custom validation status is already set, it will be overwritten.
+     * - Passing '' (an empty string) as the message parameter resets the custom validation status, which means no custom validation status is displayed.
+     *
+     * If neither the geometry editor nor {@link selectObjects} is started, the method call has no effect.
+     *
      * @param {string} message The message to show in the dialog
      * @param {CustomValidityType} [type] The type of message (defaults to 'error')
      */
@@ -1094,7 +1121,7 @@ export class CadenzaClient {
      * @param {EmbeddingTargetId} source - The workbook view to fetch object info from.
      * @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 {LenientAttributeValue[][]} objectIds - The IDs of the objects to select
      * @param {object} [__namedParameters] - Options
      * @param {FilterVariables} [__namedParameters.filter] - Filter variables
      * @param {Boolean} [__namedParameters.fullGeometries] - Return non-simplified geometries
@@ -1110,7 +1137,7 @@ export class CadenzaClient {
         });
         return this.#fetch(resolvePath(source) + '/objectinfo', params, signal, JSON.stringify({
             fullGeometries,
-            objectIds,
+            objectIds: objectIds.map(sanitizeAndValidateAttributeValues),
             layerPath: array(layerPath),
             useMapSrs,
         })).then((response) => response.json());
@@ -1233,6 +1260,7 @@ export class CadenzaClient {
      * @param {string} [params.fileName]
      * @param {FilterVariables} [params.filter]
      * @param {GeometryType} [params.geometryType]
+     * @param {boolean} [params.hideLegend]
      * @param {boolean} [params.hideMainHeaderAndFooter]
      * @param {boolean} [params.hideWorkbookToolBar]
      * @param {GlobalId} [params.highlightGlobalId]
@@ -1249,12 +1277,12 @@ export class CadenzaClient {
      * @param {Layout} [params.layout]
      * @return {URLSearchParams}
      */
-    #createParams({ action, batchModeEnabled, dataType, disabledUiFeatures, expandNavigator, fileName, filter, geometryType, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, labelSet, layers, minScale, operationMode, worksheetPlaceholders, parts, targetType, snapping, useMapSrs, validExtentStrategy, layout, }) {
+    #createParams({ action, batchModeEnabled, dataType, disabledUiFeatures, expandNavigator, fileName, filter, geometryType, hideLegend, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, labelSet, layers, minScale, operationMode, worksheetPlaceholders, parts, targetType, snapping, useMapSrs, validExtentStrategy, layout, }) {
         if (disabledUiFeatures) {
             disabledUiFeatures.forEach((feature) => assert(validUiFeature(feature), `Invalid UI feature: ${feature}`));
         }
         if (filter) {
-            assertValidFilterVariables(filter);
+            filter = sanitizeAndValidateFilterVariables(filter);
         }
         if (geometryType) {
             assertValidGeometryType(geometryType);
@@ -1293,7 +1321,7 @@ export class CadenzaClient {
             ...(filter &&
                 Object.fromEntries(Object.entries(filter).map(([variable, value]) => [
                     `filter.${variable}`,
-                    JSON.stringify(value instanceof Date ? value.toISOString() : value),
+                    value,
                 ]))),
             ...(worksheetPlaceholders &&
                 Object.fromEntries(Object.entries(worksheetPlaceholders).map(([placeholderId, worksheetPrintName]) => [
@@ -1301,6 +1329,7 @@ export class CadenzaClient {
                     JSON.stringify(worksheetPrintName),
                 ]))),
             ...(geometryType && { geometryType }),
+            ...(hideLegend && { hideLegend: 'true' }),
             ...(hideMainHeaderAndFooter && { hideMainHeaderAndFooter: 'true' }),
             ...(hideWorkbookToolBar && { hideWorkbookToolBar: 'true' }),
             ...(highlightGlobalId && { highlightGlobalId }),
@@ -1427,10 +1456,7 @@ function assertSupportedDataType(
     assert(supportedTypes.includes(type), `Invalid data type: ${type}`);
 }
 function validSpatialFilterValue(/** @type SpatialFilterValue */ $spatial) {
-    if ($spatial === null) {
-        return true;
-    }
-    if (typeof $spatial === 'object') {
+    if (typeof $spatial === 'object' && $spatial != null) {
         return (validSpatialRelation($spatial.spatialRelation) &&
             validSpatialFilterGeometry($spatial.geometry));
     }
@@ -1442,11 +1468,45 @@ function validSpatialRelation(/** @type SpatialRelation */ spatialRelation) {
 function validSpatialFilterGeometry(/** @type Polygon */ geometry) {
     return typeof geometry === 'object' && geometry.type === 'Polygon';
 }
-function assertValidFilterVariables(/** @type {FilterVariables} */ filter) {
-    const { $spatial, ...otherFilter } = filter;
-    assert($spatial === undefined ||
-        validSpatialFilterValue(/** @type {SpatialFilterValue} */ ($spatial)), 'Invalid value for spatial filter value under $spatial property');
-    Object.keys(otherFilter).forEach((varName) => assert(validKebabCaseString(varName), `Invalid filter variable name: ${varName}`));
+/** @return {AttributeValue} */
+function sanitizeAttributeValue(/** @type {LenientAttributeValue} */ value) {
+    if (typeof value === 'bigint') {
+        value = value.toString();
+    }
+    if (value instanceof Date) {
+        value = value.toISOString();
+    }
+    return value;
+}
+function validAttributeValue(/** @type unknown */ value) {
+    return typeof value === 'string' || typeof value === 'number';
+}
+function sanitizeAndValidateAttributeValues(
+/** @type {LenientAttributeValue[]} */ values) {
+    return values.map((value) => {
+        value = sanitizeAttributeValue(value);
+        assert(validAttributeValue(value), `Invalid attribute value`);
+        return value;
+    });
+}
+function sanitizeAndValidateFilterVariables(
+/** @type {FilterVariables} */ filter) {
+    return Object.fromEntries(Object.entries(filter).map(([varName, value = null]) => {
+        if (varName === '$spatial') {
+            assert(value == null ||
+                validSpatialFilterValue(/** @type {SpatialFilterValue} */ (value)), 'Invalid value for spatial filter ($spatial)');
+        }
+        else {
+            assert(validKebabCaseString(varName), `Invalid filter variable name: ${varName}`);
+            if (value != null &&
+                !(Array.isArray(value) && value.every((v) => typeof v === 'string'))) {
+                value = sanitizeAttributeValue(
+                /** @type {LenientAttributeValue} */ (value));
+                assert(validAttributeValue(value), `Invalid value for filter variable "${varName}"`);
+            }
+        }
+        return [varName, value];
+    }));
 }
 function assertValidWorksheetPlaceholdersValues(
 /** @type {WorksheetPlaceholders} */ worksheetPlaceholders) {
@@ -1562,12 +1622,12 @@ function getGeometryTypeFromFeatureCollection(featureCollection) {
  *   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. `undefined` if no objects were selected.
+ * @typedef {CadenzaEvent<'change:selection', undefined | {layer: WorkbookLayerPath, values: AttributeValue[][]}>} CadenzaChangeSelectionEvent - When the user changed the selection. `undefined` if no objects were selected.
  *
  * For a selection in a workbook map view with activated feature info, the values also include the simplified geometries of the selected objects.
  */
 /**
- * @typedef {CadenzaEvent<'drillThrough', {context?: string, values: unknown[][]}>} CadenzaDrillThroughEvent - When the user executed a POST message drill-through.
+ * @typedef {CadenzaEvent<'drillThrough', {context?: string, values: AttributeValue[][]}>} CadenzaDrillThroughEvent - When the user executed a POST message drill-through.
  * <p>
  * The event includes a data row for every item in the workbook selection, each row consisting of the values of
  * the attributes that were selected for the POST message content. If the drill-through was executed from a map
@@ -1583,7 +1643,7 @@ function getGeometryTypeFromFeatureCollection(featureCollection) {
 /** @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<'selectObjects:ok', undefined | {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaSelectObjectsOkEvent - When the user submitted the selection. `undefined` if no objects were selected.
+ * @typedef {CadenzaEvent<'selectObjects:ok', undefined | {layer: WorkbookLayerPath, values: AttributeValue[][]}>} CadenzaSelectObjectsOkEvent - When the user submitted the selection. `undefined` if no objects were selected.
  *
  * For a selection in a workbook map view with activated feature info, the values also include the simplified geometries of the selected objects.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@disy/cadenza.js",
-  "version": "10.5.5",
+  "version": "10.5.7",
   "license": "Apache-2.0",
   "repository": "github:DisyInformationssysteme/cadenza.js",
   "type": "module",
@@ -18,21 +18,19 @@
     "build": "run-p validate:* build:*",
     "build:docs": "typedoc",
     "build:ts": "tsc",
-    "validate:format": "prettier ./src --check",
+    "validate:format": "prettier ./src/**/*.{js,ts} --check",
     "validate:changelog": "changelog --latest-release",
     "start": "run-p start:*",
     "start:docs": "npm run build:docs -- --watch",
     "start:test": "npm test -- --watch",
     "start:ts": "npm run build:ts -- --watch",
-    "start:reformat": "onchange \"src/**/*\" -- prettier {{changed}} --write",
+    "start:reformat": "onchange \"src/**/*.js\" \"src/**/*.ts\" -- prettier {{changed}} --write",
     "test": "cross-env NODE_OPTIONS=--unhandled-rejections=warn jest",
-    "deploy:docs": "gh-pages --dist apidoc",
     "sandbox": "node ./sandbox.cjs"
   },
   "devDependencies": {
     "@types/jest": "29.5.14",
     "cross-env": "7.0.3",
-    "gh-pages": "6.3.0",
     "http-server": "14.1.1",
     "jest": "29.7.0",
     "jest-environment-jsdom": "29.7.0",

package/sandbox.html

@@ -243,6 +243,7 @@
       minScale,
       parts,
       requestAsPdf,
+      showLegend,
       simplifiedOperationMode,
       snappingLayer,
       useAutoCorrection,
@@ -272,6 +273,7 @@
         layers: layers ? JSON.parse(layers) : undefined,
         minScale: minScale && Number(minScale),
         operationMode: (simplifiedOperationMode === 'on' ? 'simplified' : 'normal' ),
+        hideLegend: showLegend !== 'on',
         parts: parts && parts.split(','),
         snapping: snappingLayer ? {
           layer: JSON.parse(snappingLayer),
@@ -446,6 +448,7 @@
     <small>
       <p>A JSON object with filter variable names and values</p>
       <p>Dates need to be ISO strings<br>(e.g. <code>"2023-11-17T17:12:06.175Z"</code>).<br>Use <code>"{{currentDate}}"</code> for the current date.</p>
+      <p>Longs need to be strings (e.g. <code>"1234567890"</code>).</p>
       <p>Pass multiple values for an <code>IN</code> expression as <code>["a", "b", ...]</code></p>
       <p>Spatial filter values can be set using the dedicated <code>"$spatial"</code> variable name:
         <ul>
@@ -576,14 +579,14 @@
 
 <template data-action="setFilter" data-common="filter"></template>
 
-<template data-action="createGeometry" data-common="geometryType,simplifiedOperationMode,minimumScale,additionalLayers,extentStrategy,map,snapping,disabledUiFeatures,filter">
+<template data-action="createGeometry" data-common="geometryType,simplifiedOperationMode,showLegend,minimumScale,additionalLayers,extentStrategy,map,snapping,disabledUiFeatures,filter">
   <div>
     <label for="embeddingTargetId">Embedding target ID of the map view *</label>
     <input name="embeddingTargetId" id="embeddingTargetId" required>
   </div>
 </template>
 
-<template data-action="editGeometry" data-common="simplifiedOperationMode,minimumScale,additionalLayers,extentStrategy,map,snapping,disabledUiFeatures,filter">
+<template data-action="editGeometry" data-common="simplifiedOperationMode,showLegend,minimumScale,additionalLayers,extentStrategy,map,snapping,disabledUiFeatures,filter">
   <div>
     <label for="embeddingTargetId">Embedding target ID of the map view *</label>
     <input name="embeddingTargetId" id="embeddingTargetId" required>
@@ -610,14 +613,14 @@
   </div>
 </template>
 
-<template data-action="batchCreateGeometry" data-common="geometryType,simplifiedOperationMode,minimumScale,additionalLayers,extentStrategy,map,snapping,disabledUiFeatures,filter">
+<template data-action="batchCreateGeometry" data-common="geometryType,simplifiedOperationMode,showLegend,minimumScale,additionalLayers,extentStrategy,map,snapping,disabledUiFeatures,filter">
   <div>
     <label for="embeddingTargetId">Embedding target ID of the map view *</label>
     <input name="embeddingTargetId" id="embeddingTargetId" required>
   </div>
 </template>
 
-<template data-action="batchEditGeometry" data-common="simplifiedOperationMode,minimumScale,additionalLayers,extentStrategy,map,snapping,disabledUiFeatures,filter">
+<template data-action="batchEditGeometry" data-common="simplifiedOperationMode,showLegend,minimumScale,additionalLayers,extentStrategy,map,snapping,disabledUiFeatures,filter">
   <div>
     <label for="embeddingTargetId">Embedding target ID of the map view *</label>
     <input name="embeddingTargetId" id="embeddingTargetId" required>
@@ -751,6 +754,15 @@
   </div>
 </template>
 
+<template id="common-showLegend">
+  <div>
+    <label>
+      <input type="checkbox" name="showLegend">
+      Show Legend
+    </label>
+  </div>
+</template>
+
 <template id="common-minimumScale">
   <div>
     <label for="minScale">Minimum Scale</label>