@disy/cadenza.js 10.4.3 → 10.4.5

package/cadenza.js

@@ -8,11 +8,17 @@
  *   [target origin](https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage#targetorigin) when posting events.
  *   This is required if Cadenza and your application are not running on the same origin.
  *   Please ensure that the user has view privilege for that link!
- * @property {boolean} [options.debug] - Whether to enable debug logging
+ * @property {boolean} [options.debug] - Whether to enable debug logging;
+ *   It can also be enabled/disabled at runtime via the devtools console:
+ *   ```js
+ *   localStorage.setItem('cadenzajs.debug', 'true'); // or 'false'
+ *   ```
+ *   Then you need to reload the page.
+ * @property {boolean} [options.skipGuest] - Whether a configured guest authenticator should be ignored
  */
 // This placeholder is replaced when Cadenza JS is released,
 // i.e. during development, the version is not available.
-const CADENZAJS_VERSION = '10.4.3';
+const CADENZAJS_VERSION = '10.4.5';
 /**
  * Creates an instance of the Cadenza JS client.
  *
@@ -213,6 +219,18 @@ globalThis.cadenza = Object.assign((/** @type Parameters<cadenza> */ ...args) =>
  * @property {'FeatureCollection'} type - The object's type
  * @property {Feature[]} features - The features within this collection
  */
+/**
+ * @typedef AreaIntersectionsResult - Result object of function fetchAreaIntersections
+ * @property {FeatureCollection} results - Results of the geometry intersection
+ * @property {FeatureCollection} errors - Optional listing of corrected geometries including error description
+ */
+/**
+ * @typedef ProblemDetails - A adapted [JSOn] IETF RFC 9457 Problem Details for HTTP APIs object
+ * @property {string} httpStatus - http status message
+ * @property {string} type - The primary identifier for the experienced problem type
+ * @property {string} key - Short version of the type
+ * @property {string} title - Summary of the problem
+ */
 /** @typedef {'error'|'warning'|'info'|'success'} CustomValidityType - The type of custom validity used for disclose on visual presentation and form submission behavior */
 /**
  * @typedef SnappingOptions
@@ -253,6 +271,8 @@ export class CadenzaClient {
     #iframeElement;
     /** @readonly */
     #debug;
+    /** @readonly */
+    #skipGuest;
     /** @type {[ CadenzaEventType | string, (event: CadenzaEvent<never>) => void ][]} */
     #subscriptions = [];
     /**
@@ -260,7 +280,7 @@ export class CadenzaClient {
      * @hidden
      * @param {CadenzaClientOptions} [__namedParameters]
      */
-    constructor({ baseUrl, debug = false, iframe, webApplication } = {}) {
+    constructor({ baseUrl, debug = false, skipGuest = false, iframe, webApplication, } = {}) {
         if (webApplication) {
             assert(validExternalLinkKey(webApplication), `Invalid webApplication parameter: ${webApplication}`);
         }
@@ -280,6 +300,7 @@ export class CadenzaClient {
             this.#log('Create Cadenza client for parent Cadenza');
         }
         this.#debug = debug;
+        this.#skipGuest = skipGuest;
         this.#webApplication = webApplication;
     }
     /** The base URL of the Cadenza server this client is requesting */
@@ -346,7 +367,7 @@ export class CadenzaClient {
                 'page' in source &&
                 source.page === 'welcome', 'labelSet is only supported on the welcome page');
         }
-        const params = createParams({
+        const params = this.#createParams({
             dataType,
             disabledUiFeatures,
             expandNavigator,
@@ -414,7 +435,7 @@ export class CadenzaClient {
             extentStrategy,
             geometry,
         });
-        const params = createParams({
+        const params = this.#createParams({
             disabledUiFeatures,
             expandNavigator,
             filter,
@@ -582,7 +603,7 @@ export class CadenzaClient {
         const validExtentStrategy = sanitizeExtentStrategy({
             extentStrategy,
         });
-        const params = createParams({
+        const params = this.#createParams({
             action: 'editGeometry',
             disabledUiFeatures,
             filter,
@@ -622,7 +643,7 @@ export class CadenzaClient {
             extentStrategy,
             geometry,
         });
-        const params = createParams({
+        const params = this.#createParams({
             action: 'editGeometry',
             disabledUiFeatures,
             filter,
@@ -661,7 +682,7 @@ export class CadenzaClient {
         const validExtentStrategy = sanitizeExtentStrategy({
             extentStrategy,
         });
-        const params = createParams({
+        const params = this.#createParams({
             action: 'editGeometry',
             batchModeEnabled: true,
             disabledUiFeatures,
@@ -701,7 +722,7 @@ export class CadenzaClient {
             extentStrategy,
             geometry: features.features[features.features.length - 1].geometry,
         });
-        const params = createParams({
+        const params = this.#createParams({
             action: 'editGeometry',
             batchModeEnabled: true,
             disabledUiFeatures,
@@ -780,7 +801,6 @@ export class CadenzaClient {
      * @throws For invalid arguments
      * @fires
      * - {@link CadenzaChangeSelectionEvent}
-     * - {@link CadenzaObjectInfoEvent}
      * - {@link CadenzaSelectObjectsOkEvent}
      * - {@link CadenzaSelectObjectsCancelEvent}
      * @embed
@@ -790,7 +810,7 @@ export class CadenzaClient {
         const validExtentStrategy = sanitizeExtentStrategy({
             extentStrategy,
         });
-        const params = createParams({
+        const params = this.#createParams({
             action: 'selectObjects',
             disabledUiFeatures,
             filter,
@@ -1006,7 +1026,7 @@ export class CadenzaClient {
     fetchData(source, dataType, { filter, parts, signal } = {}) {
         this.#log('CadenzaClient#fetchData', ...arguments);
         assertSupportedDataType(dataType, ['csv', 'excel', 'json', 'pdf']);
-        const params = createParams({ dataType, filter, parts });
+        const params = this.#createParams({ dataType, filter, parts });
         return this.#fetch(resolvePath(source), params, signal);
     }
     /**
@@ -1026,7 +1046,7 @@ export class CadenzaClient {
      */
     fetchObjectInfo(source, layerPath, objectIds, { filter, signal, fullGeometries, useMapSrs } = {}) {
         this.#log('CadenzaClient#fetchObjectInfo', ...arguments);
-        const params = createParams({
+        const params = this.#createParams({
             filter,
         });
         return this.#fetch(resolvePath(source) + '/objectinfo', params, signal, JSON.stringify({
@@ -1044,27 +1064,33 @@ export class CadenzaClient {
      *  (identified using layer paths or print names)
      * @param {Geometry} geometry - The intersection geometry
      * @param {object} [__namedParameters] - Options
+     * @param {boolean} [__namedParameters.useAutoCorrection] - Enables the automatic correction of invalid geometries
      * @param {Distance} [__namedParameters.buffer] - Buffer size for geometry of the transition
+     * @param {boolean} [__namedParameters.includeGeometryValidationReport] - Enables the list of corrected geometries, including error descriptions
      * @param {AbortSignal} [__namedParameters.signal] - A signal to abort the data fetching
      * @param {boolean} [__namedParameters.useMapSrs]  - The intersection geometry and the result geometries are in the map's SRS (otherwise EPSG:4326 is assumed)
-     * @return {Promise<FeatureCollection>} A `Promise` for the fetch response
+     * @return {Promise<AreaIntersectionsResult | ProblemDetails>} A `Promise` for the fetch response
      * @server
      */
-    fetchAreaIntersections(source, layerPath, geometry, { buffer, signal, useMapSrs } = {}) {
+    fetchAreaIntersections(source, layerPath, geometry, { buffer, includeGeometryValidationReport, signal, useAutoCorrection, useMapSrs, } = {}) {
         this.#log('CadenzaClient#areaIntersections', ...arguments);
-        const params = createParams({});
+        const params = this.#createParams({});
         return this.#fetch(resolvePath(source) + '/area-intersections', params, signal, JSON.stringify({
             buffer,
+            includeGeometryValidationReport,
             layerPath: array(layerPath),
             geometry,
+            useAutoCorrection,
             useMapSrs,
+            isForwardProblemDetailsEnabled: true,
         })).then((response) => response.json());
     }
     async #fetch(
     /** @type string */ path, 
     /** @type URLSearchParams */ params, 
     /** @type AbortSignal | undefined */ signal, 
-    /** @type String | undefined If body is set, the fetch will be a post.*/ body) {
+    /** @type String | undefined If body is set, the fetch will be a post.*/ body, 
+    /** @type boolean */ isForwardProblemDetailsEnabled = false) {
         const url = this.#createUrl(path, params);
         this.#log('Fetch', url.toString());
         const method = body ? 'POST' : undefined;
@@ -1080,6 +1106,11 @@ export class CadenzaClient {
             body,
         });
         if (!res.ok) {
+            const contentType = res.headers.get('content-type');
+            if (isForwardProblemDetailsEnabled &&
+                contentType === 'application/problem+json') {
+                return res;
+            }
             const errorType = {
                 400: 'bad-request',
                 401: 'unauthorized',
@@ -1109,7 +1140,7 @@ export class CadenzaClient {
     downloadData(source, dataType, { fileName, filter, parts } = {}) {
         this.#log('CadenzaClient#downloadData', ...arguments);
         assertSupportedDataType(dataType, ['csv', 'excel', 'json', 'pdf']);
-        const params = createParams({ dataType, fileName, filter, parts });
+        const params = this.#createParams({ dataType, fileName, filter, parts });
         this.#download(resolvePath(source), params);
     }
     #download(/** @type string */ path, /** @type URLSearchParams */ params) {
@@ -1133,8 +1164,97 @@ export class CadenzaClient {
         }
         return url;
     }
+    /**
+     * @param {object} params
+     * @param {string} [params.action]
+     * @param {boolean} [params.batchModeEnabled]
+     * @param {DataType} [params.dataType]
+     * @param {UiFeature[]} [params.disabledUiFeatures]
+     * @param {boolean} [params.expandNavigator]
+     * @param {string} [params.fileName]
+     * @param {FilterVariables} [params.filter]
+     * @param {GeometryType} [params.geometryType]
+     * @param {boolean} [params.hideMainHeaderAndFooter]
+     * @param {boolean} [params.hideWorkbookToolBar]
+     * @param {GlobalId} [params.highlightGlobalId]
+     * @param {string} [params.labelSet]
+     * @param {WorkbookLayerPath[]} [params.layers]
+     * @param {number} [params.minScale]
+     * @param {OperationMode} [params.operationMode]
+     * @param {TablePart[]} [params.parts]
+     * @param {'MAP'} [params.targetType]
+     * @param {SnappingOptions} [params.snapping]
+     * @param {boolean} [params.useMapSrs]
+     * @param {ExtentStrategy} [params.validExtentStrategy]
+     * @param {Layout} [params.layout]
+     * @return {URLSearchParams}
+     */
+    #createParams({ action, batchModeEnabled, dataType, disabledUiFeatures, expandNavigator, fileName, filter, geometryType, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, labelSet, layers, minScale, operationMode, parts, targetType, snapping, useMapSrs, validExtentStrategy, layout, }) {
+        if (disabledUiFeatures) {
+            disabledUiFeatures.forEach((feature) => assert(validUiFeature(feature), `Invalid UI feature: ${feature}`));
+        }
+        if (filter) {
+            assertValidFilterVariables(filter);
+        }
+        if (geometryType) {
+            assertValidGeometryType(geometryType);
+        }
+        if (operationMode) {
+            assert(validOperationMode(operationMode), `Invalid operation mode: ${operationMode}`);
+        }
+        if (layout) {
+            assert(validLayout(layout), `Invalid layout: ${layout}`);
+        }
+        if (parts) {
+            parts.forEach((part) => assert(validTablePart(part), `Invalid table part: ${part}`));
+        }
+        let locationFinder;
+        let mapExtent;
+        if (validExtentStrategy) {
+            if (validExtentStrategy.type === 'static') {
+                mapExtent = validExtentStrategy.extent;
+            }
+            else if (validExtentStrategy.type === 'locationFinder') {
+                locationFinder = validExtentStrategy.query;
+            }
+        }
+        return new URLSearchParams({
+            ...(action && { action }),
+            ...(batchModeEnabled && { batchModeEnabled: 'true' }),
+            ...(dataType && { dataType }),
+            ...(disabledUiFeatures && {
+                disabledUiFeatures: disabledUiFeatures.join(),
+            }),
+            ...(expandNavigator && { expandNavigator: 'true' }),
+            ...(fileName && { fileName }),
+            ...(filter &&
+                Object.fromEntries(Object.entries(filter).map(([variable, value]) => [
+                    `filter.${variable}`,
+                    JSON.stringify(value instanceof Date ? value.toISOString() : value),
+                ]))),
+            ...(geometryType && { geometryType }),
+            ...(hideMainHeaderAndFooter && { hideMainHeaderAndFooter: 'true' }),
+            ...(hideWorkbookToolBar && { hideWorkbookToolBar: 'true' }),
+            ...(highlightGlobalId && { highlightGlobalId }),
+            ...(labelSet && { labelSet }),
+            ...(layers?.length && { layers: JSON.stringify(layers) }),
+            ...(locationFinder && { locationFinder }),
+            ...(mapExtent && { mapExtent: mapExtent.join() }),
+            ...(minScale && { minScale: String(minScale) }),
+            ...(operationMode && { operationMode }),
+            ...(parts && { parts: parts.join() }),
+            ...(snapping && { snappingLayer: JSON.stringify(array(snapping.layer)) }),
+            ...(snapping?.types?.length && { snappingTypes: snapping.types.join() }),
+            ...(targetType && { targetType }),
+            ...(useMapSrs && { useMapSrs: 'true' }),
+            ...(layout && { layout }),
+            ...(this.#skipGuest && { skipGuestAccess: 'true' }),
+        });
+    }
     #log(/** @type unknown[] */ ...args) {
-        if (this.#debug) {
+        const debugString = localStorage.getItem('cadenzajs.debug');
+        const debug = debugString != null ? debugString === 'true' : this.#debug;
+        if (debug) {
             /** @type {unknown[]} */
             const redundantValues = [undefined, '', false];
             /** @type {(value: unknown) => value is object} */
@@ -1260,92 +1380,6 @@ function assertValidFilterVariables(/** @type {FilterVariables} */ filter) {
         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}`));
 }
-/**
- * @param {object} params
- * @param {string} [params.action]
- * @param {boolean} [params.batchModeEnabled]
- * @param {DataType} [params.dataType]
- * @param {UiFeature[]} [params.disabledUiFeatures]
- * @param {boolean} [params.expandNavigator]
- * @param {string} [params.fileName]
- * @param {FilterVariables} [params.filter]
- * @param {GeometryType} [params.geometryType]
- * @param {boolean} [params.hideMainHeaderAndFooter]
- * @param {boolean} [params.hideWorkbookToolBar]
- * @param {GlobalId} [params.highlightGlobalId]
- * @param {string} [params.labelSet]
- * @param {WorkbookLayerPath[]} [params.layers]
- * @param {number} [params.minScale]
- * @param {OperationMode} [params.operationMode]
- * @param {TablePart[]} [params.parts]
- * @param {'MAP'} [params.targetType]
- * @param {SnappingOptions} [params.snapping]
- * @param {boolean} [params.useMapSrs]
- * @param {ExtentStrategy | undefined} [params.validExtentStrategy]
- * @param {Layout | undefined} [params.layout]
- * @return {URLSearchParams}
- */
-function createParams({ action, batchModeEnabled, dataType, disabledUiFeatures, expandNavigator, fileName, filter, geometryType, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, labelSet, layers, minScale, operationMode, parts, targetType, snapping, useMapSrs, validExtentStrategy, layout, }) {
-    if (disabledUiFeatures) {
-        disabledUiFeatures.forEach((feature) => assert(validUiFeature(feature), `Invalid UI feature: ${feature}`));
-    }
-    if (filter) {
-        assertValidFilterVariables(filter);
-    }
-    if (geometryType) {
-        assertValidGeometryType(geometryType);
-    }
-    if (operationMode) {
-        assert(validOperationMode(operationMode), `Invalid operation mode: ${operationMode}`);
-    }
-    if (layout) {
-        assert(validLayout(layout), `Invalid layout: ${layout}`);
-    }
-    if (parts) {
-        parts.forEach((part) => assert(validTablePart(part), `Invalid table part: ${part}`));
-    }
-    let locationFinder;
-    let mapExtent;
-    if (validExtentStrategy) {
-        if (validExtentStrategy.type === 'static') {
-            mapExtent = validExtentStrategy.extent;
-        }
-        else if (validExtentStrategy.type === 'locationFinder') {
-            locationFinder = validExtentStrategy.query;
-        }
-    }
-    return new URLSearchParams({
-        ...(action && { action }),
-        ...(batchModeEnabled && { batchModeEnabled: 'true' }),
-        ...(dataType && { dataType }),
-        ...(disabledUiFeatures && {
-            disabledUiFeatures: disabledUiFeatures.join(),
-        }),
-        ...(expandNavigator && { expandNavigator: 'true' }),
-        ...(fileName && { fileName }),
-        ...(filter &&
-            Object.fromEntries(Object.entries(filter).map(([variable, value]) => [
-                `filter.${variable}`,
-                JSON.stringify(value instanceof Date ? value.toISOString() : value),
-            ]))),
-        ...(geometryType && { geometryType }),
-        ...(hideMainHeaderAndFooter && { hideMainHeaderAndFooter: 'true' }),
-        ...(hideWorkbookToolBar && { hideWorkbookToolBar: 'true' }),
-        ...(highlightGlobalId && { highlightGlobalId }),
-        ...(labelSet && { labelSet }),
-        ...(layers?.length && { layers: JSON.stringify(layers) }),
-        ...(locationFinder && { locationFinder }),
-        ...(mapExtent && { mapExtent: mapExtent.join() }),
-        ...(minScale && { minScale: String(minScale) }),
-        ...(operationMode && { operationMode }),
-        ...(parts && { parts: parts.join() }),
-        ...(snapping && { snappingLayer: JSON.stringify(array(snapping.layer)) }),
-        ...(snapping?.types?.length && { snappingTypes: snapping.types.join() }),
-        ...(targetType && { targetType }),
-        ...(useMapSrs && { useMapSrs: 'true' }),
-        ...(layout && { layout }),
-    });
-}
 function array(/** @type unknown */ value) {
     return Array.isArray(value) ? value : [value];
 }
@@ -1412,7 +1446,6 @@ function getGeometryTypeFromFeatureCollection(featureCollection) {
  * | 'editGeometry:ok'
  * | 'editGeometry:update'
  * | 'editGeometry:cancel'
- * | 'objectInfo'
  * | 'reload'
  * | 'selectObjects:ok'
  * | 'selectObjects:cancel'
@@ -1426,7 +1459,6 @@ function getGeometryTypeFromFeatureCollection(featureCollection) {
  *  : T extends 'editGeometry:update' ? CadenzaEditGeometryUpdateEvent
  *  : T extends 'editGeometry:ok' ? CadenzaEditGeometryOkEvent
  *  : T extends 'editGeometry:cancel' ? CadenzaEditGeometryCancelEvent
- *  : T extends 'objectInfo' ? CadenzaObjectInfoEvent
  *  : T extends 'reload' ? CadenzaReloadEvent
  *  : T extends 'selectObjects:ok' ? CadenzaSelectObjectsOkEvent
  *  : T extends 'selectObjects:cancel' ? CadenzaSelectObjectsCancelEvent
@@ -1466,7 +1498,6 @@ function getGeometryTypeFromFeatureCollection(featureCollection) {
 /** @typedef {CadenzaEvent<'editGeometry:ok', FeatureCollection | Feature>} CadenzaEditGeometryOkEvent - When the user submitted the geometry. `FeatureCollection` if batch editing is enabled. */
 /** @typedef {CadenzaEvent<'editGeometry:cancel'>} CadenzaEditGeometryCancelEvent - When the user cancelled the geometry editing. */
 /** @typedef {CadenzaEvent<'error', {type: string, message?: string}>} CadenzaErrorEvent - An error event that is mapped to a {@link CadenzaError} */
-/** @typedef {CadenzaEvent<'objectInfo', {layer: WorkbookLayerPath, objectInfos: {selectionIndex: number, elements: {attributePrintName: string, formattedValue: string}[]}}>} CadenzaObjectInfoEvent - When the user opened the object info flyout. */
 /**
  * @typedef {CadenzaEvent<'selectObjects:ok', undefined | {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaSelectObjectsOkEvent - When the user submitted the selection. `undefined` if no objects were selected.
  *

package/package.json

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

package/sandbox.html

@@ -163,9 +163,9 @@
       },
       setFilter: data => cadenzaClient.setFilter(parseFilterVariables(data.filter)),
       setLayerVisibility: data => cadenzaClient.setLayerVisibility(JSON.parse(data.layer), data.visibility === 'on'),
-      setSelection: data => cadenzaClient.setSelection(JSON.parse(data.layer), JSON.parse(data.objectIds), {extentStrategy: JSON.parse(data.extentStrategy)}),
-      addSelection: data => cadenzaClient.addSelection(JSON.parse(data.layer), JSON.parse(data.objectIds), { extentStrategy: JSON.parse(data.extentStrategy) }),
-      removeSelection: data => cadenzaClient.removeSelection(JSON.parse(data.layer), JSON.parse(data.objectIds), { extentStrategy: JSON.parse(data.extentStrategy) }),
+      setSelection: data => cadenzaClient.setSelection(JSON.parse(data.layer), JSON.parse(data.objectIds), data.extentStrategy ? {extentStrategy: JSON.parse(data.extentStrategy) } : {}),
+      addSelection: data => cadenzaClient.addSelection(JSON.parse(data.layer), JSON.parse(data.objectIds), data.extentStrategy ? {extentStrategy: JSON.parse(data.extentStrategy) } : {}),
+      removeSelection: data => cadenzaClient.removeSelection(JSON.parse(data.layer), JSON.parse(data.objectIds), data.extentStrategy ? {extentStrategy: JSON.parse(data.extentStrategy) } : {}),
       createGeometry: (data, formData) => cadenzaClient.createGeometry(data.embeddingTargetId, data.geometryType, getOptions(data, formData)),
       editGeometry: (data, formData) => cadenzaClient.editGeometry(data.embeddingTargetId, JSON.parse(data.geometry), getOptions(data, formData)),
       batchCreateGeometry: (data , formData) => cadenzaClient.batchCreateGeometry(data.embeddingTargetId, data.geometryType, getOptions(data, formData)),
@@ -230,6 +230,7 @@
       hideMainHeaderAndFooter,
       hideWorkbookToolBar,
       highlightGlobalId,
+      includeGeometryValidationReport,
       labelSet,
       layers,
       lengthUnit,
@@ -238,6 +239,7 @@
       requestAsPdf,
       simplifiedOperationMode,
       snappingLayer,
+      useAutoCorrection,
       useMapSrs,
       layout,
       width,
@@ -259,6 +261,7 @@
         hideMainHeaderAndFooter: (hideMainHeaderAndFooter === 'on'),
         hideWorkbookToolBar: (hideWorkbookToolBar === 'on'),
         highlightGlobalId,
+        includeGeometryValidationReport: (includeGeometryValidationReport === 'on'),
         labelSet,
         layers: layers ? JSON.parse(layers) : undefined,
         minScale: minScale && Number(minScale),
@@ -268,6 +271,7 @@
           layer: JSON.parse(snappingLayer),
           types: formData?.getAll('snappingTypes')
         }: undefined,
+        useAutoCorrection: useAutoCorrection === 'on',
         useMapSrs: useMapSrs === 'on',
         layout: layout || undefined,
         width: Number(width),
@@ -922,6 +926,14 @@
       <input type="checkbox" name="useMapSrs">
       Use map SRS
     </label>
+    <label>
+      <input type="checkbox" name="useAutoCorrection">
+      Enable geometry autocorrection
+    </label>
+    <label>
+      <input type="checkbox" name="includeGeometryValidationReport">
+      Enable invalid geometries report
+    </label>
   </div>
   <div>
     <label for="distance">Buffer size</label>

package/apidoc/types/CadenzaObjectInfoEvent.html

@@ -1,2 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>CadenzaObjectInfoEvent | Cadenza JS - v10.4.3</title><meta name="description" content="Documentation for Cadenza JS"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/DisyInformationssysteme/cadenza.js">Cadenza JS on GitHub</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Cadenza JS - v10.4.3</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Cadenza JS</a></li><li><a href="CadenzaObjectInfoEvent.html">CadenzaObjectInfoEvent</a></li></ul><h1>Type Alias CadenzaObjectInfoEvent</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">CadenzaObjectInfoEvent</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/CadenzaEvent.html" class="tsd-signature-type tsd-kind-interface">CadenzaEvent</a><span class="tsd-signature-symbol">&lt;</span><br/>    <span class="tsd-signature-type">&quot;objectInfo&quot;</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-signature-symbol">{</span><br/>        <span class="tsd-kind-property">layer</span><span class="tsd-signature-symbol">:</span> <a href="WorkbookLayerPath.html" class="tsd-signature-type tsd-kind-type-alias">WorkbookLayerPath</a><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-kind-property">objectInfos</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/>            <span class="tsd-kind-property">elements</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">attributePrintName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span> <span class="tsd-kind-property">formattedValue</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">;</span><br/>            <span class="tsd-kind-property">selectionIndex</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/>        <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">;</span><br/>    <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">&gt;</span></div><div class="tsd-comment tsd-typography"><p>When the user opened the object info flyout.</p>
-</div><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/4522c387f7632af2607b88506d17d5838fbb1d77/src/cadenza.js#L1788">src/cadenza.js:1788</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://github.com/DisyInformationssysteme/cadenza.js" class="tsd-nav-link">Cadenza JS on GitHub</a></nav><nav class="tsd-navigation"><a href="../modules.html">Cadenza JS - v10.4.3</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>