@disy/cadenza.js 1.3.0 → 1.5.0

package/cadenza.d.ts

@@ -37,6 +37,10 @@ export function cadenza(baseUrl: string, options?: {
  * @property {string} workbookId - The ID of the workbook
  * @property {string} viewId - The ID of the view
  */
+/**
+ * @typedef PageSource - A well-known Cadenza page
+ * @property {'welcome'} page - The name of the page (Only `"welcome"` is currently supported.)
+ */
 /** @typedef {EmbeddingTargetId | WorkbookKey} WorkbookSource - A workbook source */
 /** @typedef {EmbeddingTargetId | WorksheetKey} WorksheetSource - A worksheet source */
 /** @typedef {EmbeddingTargetId | WorkbookViewKey} WorkbookViewSource - A workbook view source */
@@ -48,12 +52,6 @@ export function cadenza(baseUrl: string, options?: {
  * * 'workbook-design' - The workbook designer
  * * 'workbook-view-management' - Add/Edit/Remove workbook views (Is included in 'workbook-design'.)
  * */
-/**
- * @typedef PageSource - A well-known Cadenza page
- * @property {PageType} page - The name of the page
- *
- * @typedef {'welcome'} PageType - A Cadenza well-known page name
- */
 /**
  * @typedef Geometry - A [GeoJSON](https://geojson.org/) geometry object
  * @property {GeometryType} type - The type of the geometry
@@ -64,6 +62,12 @@ export function cadenza(baseUrl: string, options?: {
  * _Note:_ The GeoJSON geometry type "GeometryCollection" is currently not supported.
  */
 /** @typedef {[number,number,number,number]} Extent - An array of numbers representing an extent: [minx, miny, maxx, maxy] */
+/**
+ * @typedef {string} MediaType - A media type
+ *
+ * See {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types}
+ */
+/** @typedef {'columns' | 'values' | 'totals'} TablePart - A part of a table to export. */
 /**
  * _Notes:_
  * * Most public methods can be aborted using an [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal).
@@ -100,6 +104,7 @@ export class CadenzaClient {
      * @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 {MediaType} [options.mediaType] - Set to 'application/pdf' for views of type "JasperReports report"
      *     to show the report PDF directly, without any Cadenza headers or footers.
      * @param {OperationMode} [options.operationMode] - The mode in which a workbook should be operated
@@ -107,12 +112,13 @@ export class CadenzaClient {
      * @return {Promise<void>} A Promise for when the iframe is loaded
      * @throws For invalid arguments
      */
-    show(source: PageSource | WorkbookSource | WorksheetSource | WorkbookViewSource, { disabledUiFeatures, expandNavigator, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, mediaType, operationMode, signal, }?: {
+    show(source: PageSource | WorkbookSource | WorksheetSource | WorkbookViewSource, { disabledUiFeatures, expandNavigator, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, labelSet, mediaType, operationMode, signal, }?: {
         disabledUiFeatures?: UiFeature[] | undefined;
         expandNavigator?: boolean | undefined;
         hideMainHeaderAndFooter?: boolean | undefined;
         hideWorkbookToolBar?: boolean | undefined;
         highlightGlobalId?: string | undefined;
+        labelSet?: string | undefined;
         mediaType?: string | undefined;
         operationMode?: OperationMode | undefined;
         signal?: AbortSignal | undefined;
@@ -150,11 +156,11 @@ export class CadenzaClient {
         signal?: AbortSignal | undefined;
     } | undefined): Promise<void>;
     /**
-     * Expand/collapse the navigator tree.
+     * Expand/collapse the navigator.
      *
-     * @param {boolean} expandNavigator - The expansion state of the navigator.
+     * @param {boolean} expanded - The expansion state of the navigator
      */
-    expandNavigator(expandNavigator: boolean): void;
+    expandNavigator(expanded?: boolean): void;
     /**
      * Create a geometry.
      *
@@ -225,7 +231,7 @@ export class CadenzaClient {
      * * 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' (Excel)
      * * 'text/csv'
      * @param {object} options - Options
-     * @param {TablePart[]} [options.parts] - An optional array of table parts to export. If not specified, all parts are exported.
+     * @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
      * @return {Promise<Response>} A Promise for the fetch response
      * @throws For invalid arguments
@@ -247,7 +253,7 @@ export class CadenzaClient {
      * * 'text/csv'
      * @param {object} options - Options
      * @param {string} [options.fileName] - The file name to use; The file extension is appended by Cadenza.
-     * @param {TablePart[]} [options.parts] - An optional array of table parts to export. If not specified, all parts are exported.
+     * @param {TablePart[]} [options.parts] - Table parts to export; If not specified, all parts are exported.
      * @throws For invalid arguments
      */
     downloadData(source: WorkbookViewSource, mediaType: MediaType, { fileName, parts }: {
@@ -280,10 +286,6 @@ export class CadenzaError extends Error {
     get type(): string;
     #private;
 }
-/**
- * - A part of a table to export.
- */
-export type TablePart = 'columns' | 'values' | 'totals';
 /**
  * - The ID of an embedding target
  */
@@ -352,6 +354,15 @@ export type WorkbookViewKey = {
      */
     viewId: string;
 };
+/**
+ * - A well-known Cadenza page
+ */
+export type PageSource = {
+    /**
+     * - The name of the page (Only `"welcome"` is currently supported.)
+     */
+    page: 'welcome';
+};
 /**
  * - A workbook source
  */
@@ -376,19 +387,6 @@ export type OperationMode = 'normal' | 'simplified';
  * * 'workbook-view-management' - Add/Edit/Remove workbook views (Is included in 'workbook-design'.)
  */
 export type UiFeature = 'workbook-design' | 'workbook-view-management';
-/**
- * - A well-known Cadenza page
- */
-export type PageSource = {
-    /**
-     * - The name of the page
-     */
-    page: PageType;
-};
-/**
- * - A Cadenza well-known page name
- */
-export type PageType = 'welcome';
 /**
  * - A [GeoJSON](https://geojson.org/) geometry object
  */
@@ -414,6 +412,10 @@ export type Extent = [number, number, number, number];
  * See {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types}
  */
 export type MediaType = string;
+/**
+ * - A part of a table to export.
+ */
+export type TablePart = 'columns' | 'values' | 'totals';
 /**
  * - A Cadenza `postMessage()` event
  */

package/cadenza.js

@@ -43,6 +43,10 @@ globalThis.cadenza = Object.assign((/** @type Parameters<cadenza> */ ...args) =>
  * @property {string} workbookId - The ID of the workbook
  * @property {string} viewId - The ID of the view
  */
+/**
+ * @typedef PageSource - A well-known Cadenza page
+ * @property {'welcome'} page - The name of the page (Only `"welcome"` is currently supported.)
+ */
 /** @typedef {EmbeddingTargetId | WorkbookKey} WorkbookSource - A workbook source */
 /** @typedef {EmbeddingTargetId | WorksheetKey} WorksheetSource - A worksheet source */
 /** @typedef {EmbeddingTargetId | WorkbookViewKey} WorkbookViewSource - A workbook view source */
@@ -54,12 +58,6 @@ globalThis.cadenza = Object.assign((/** @type Parameters<cadenza> */ ...args) =>
  * * 'workbook-design' - The workbook designer
  * * 'workbook-view-management' - Add/Edit/Remove workbook views (Is included in 'workbook-design'.)
  * */
-/**
- * @typedef PageSource - A well-known Cadenza page
- * @property {PageType} page - The name of the page
- *
- * @typedef {'welcome'} PageType - A Cadenza well-known page name
- */
 /**
  * @typedef Geometry - A [GeoJSON](https://geojson.org/) geometry object
  * @property {GeometryType} type - The type of the geometry
@@ -70,6 +68,12 @@ globalThis.cadenza = Object.assign((/** @type Parameters<cadenza> */ ...args) =>
  * _Note:_ The GeoJSON geometry type "GeometryCollection" is currently not supported.
  */
 /** @typedef {[number,number,number,number]} Extent - An array of numbers representing an extent: [minx, miny, maxx, maxy] */
+/**
+ * @typedef {string} MediaType - A media type
+ *
+ * See {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types}
+ */
+/** @typedef {'columns' | 'values' | 'totals'} TablePart - A part of a table to export. */
 /**
  * _Notes:_
  * * Most public methods can be aborted using an [AbortSignal](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal).
@@ -148,6 +152,7 @@ export class CadenzaClient {
      * @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 {MediaType} [options.mediaType] - Set to 'application/pdf' for views of type "JasperReports report"
      *     to show the report PDF directly, without any Cadenza headers or footers.
      * @param {OperationMode} [options.operationMode] - The mode in which a workbook should be operated
@@ -155,19 +160,25 @@ export class CadenzaClient {
      * @return {Promise<void>} A Promise for when the iframe is loaded
      * @throws For invalid arguments
      */
-    show(source, { disabledUiFeatures, expandNavigator, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, mediaType, operationMode, signal, } = {}) {
+    show(source, { disabledUiFeatures, expandNavigator, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, labelSet, mediaType, operationMode, signal, } = {}) {
         this.#log('CadenzaClient#show', source);
         if (mediaType) {
             assertSupportedMediaType(mediaType, [MediaType.PDF]);
         }
+        if (labelSet) {
+            assert(typeof source !== 'string' &&
+                'page' in source &&
+                source.page === 'welcome', 'labelSet is only supported on the welcome page');
+        }
         const params = createParams({
             disabledUiFeatures,
             expandNavigator,
             hideMainHeaderAndFooter,
             hideWorkbookToolBar,
             highlightGlobalId,
-            operationMode,
+            labelSet,
             mediaType,
+            operationMode,
             webApplication: this.#webApplication,
         });
         return this.#show(resolvePath(source), params, signal);
@@ -212,13 +223,13 @@ export class CadenzaClient {
         this.#postEvent('setGeometry', { geometry });
     }
     /**
-     * Expand/collapse the navigator tree.
+     * Expand/collapse the navigator.
      *
-     * @param {boolean} expandNavigator - The expansion state of the navigator.
+     * @param {boolean} expanded - The expansion state of the navigator
      */
-    expandNavigator(expandNavigator) {
-        this.#log('CadenzaClient#expandNavigator', expandNavigator);
-        this.#postEvent('expandNavigator', { expandNavigator: !!expandNavigator });
+    expandNavigator(expanded = true) {
+        this.#log('CadenzaClient#expandNavigator', expanded);
+        this.#postEvent('expandNavigator', { expandNavigator: Boolean(expanded) });
     }
     /**
      * Create a geometry.
@@ -385,7 +396,7 @@ export class CadenzaClient {
      * * 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' (Excel)
      * * 'text/csv'
      * @param {object} options - Options
-     * @param {TablePart[]} [options.parts] - An optional array of table parts to export. If not specified, all parts are exported.
+     * @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
      * @return {Promise<Response>} A Promise for the fetch response
      * @throws For invalid arguments
@@ -393,7 +404,6 @@ export class CadenzaClient {
     fetchData(source, mediaType, { parts, signal } = {}) {
         this.#log('CadenzaClient#fetchData', source, mediaType);
         assertSupportedMediaType(mediaType);
-        assertValidTableParts(parts);
         const params = createParams({ mediaType, parts });
         return this.#fetch(resolvePath(source), params, signal);
     }
@@ -427,13 +437,12 @@ export class CadenzaClient {
      * * 'text/csv'
      * @param {object} options - Options
      * @param {string} [options.fileName] - The file name to use; The file extension is appended by Cadenza.
-     * @param {TablePart[]} [options.parts] - An optional array of table parts to export. If not specified, all parts are exported.
+     * @param {TablePart[]} [options.parts] - Table parts to export; If not specified, all parts are exported.
      * @throws For invalid arguments
      */
     downloadData(source, mediaType, { fileName, parts }) {
         this.#log('CadenzaClient#downloadData', source, mediaType);
         assertSupportedMediaType(mediaType);
-        assertValidTableParts(parts);
         const params = createParams({ fileName, mediaType, parts });
         this.#download(resolvePath(source), params);
     }
@@ -543,30 +552,15 @@ function validGeometryType(/** @type string */ value) {
         'MultiPolygon',
     ].includes(value);
 }
-/** @typedef {'columns' | 'values' | 'totals'} TablePart - A part of a table to export. */
 function validTablePart(/** @type TablePart */ value) {
     return ['columns', 'values', 'totals'].includes(value);
 }
-function assertValidTablePart(/** @type TablePart */ value) {
-    assert(validTablePart(value));
-}
-function assertValidTableParts(/** @type TablePart[] | undefined */ parts) {
-    if (parts) {
-        assert(Array.isArray(parts), `'parts' argument must be an array`);
-        parts.forEach(assertValidTablePart);
-    }
-}
 function validOperationMode(/** @type string */ value) {
     return ['normal', 'simplified'].includes(value);
 }
 function validUiFeature(/** @type string */ value) {
     return ['workbook-design', 'workbook-view-management'].includes(value);
 }
-/**
- * @typedef {string} MediaType - A media type
- *
- * See {@link https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types}
- */
 const MediaType = /** @type {Record<string, MediaType>} */ {
     CSV: 'text/csv',
     EXCEL: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
@@ -588,6 +582,7 @@ function assertSupportedMediaType(
  * @param {boolean} [params.hideMainHeaderAndFooter]
  * @param {boolean} [params.hideWorkbookToolBar]
  * @param {GlobalId} [params.highlightGlobalId]
+ * @param {string} [params.labelSet]
  * @param {string} [params.locationFinder]
  * @param {Extent} [params.mapExtent]
  * @param {MediaType} [params.mediaType]
@@ -598,7 +593,7 @@ function assertSupportedMediaType(
  * @param {ExternalLinkKey} [params.webApplication]
  * @return {URLSearchParams}
  */
-function createParams({ action, expandNavigator, fileName, geometryType, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, locationFinder, mapExtent, mediaType, minScale, parts, useMapSrs, webApplication, operationMode, disabledUiFeatures, }) {
+function createParams({ action, expandNavigator, fileName, geometryType, hideMainHeaderAndFooter, hideWorkbookToolBar, highlightGlobalId, labelSet, locationFinder, mapExtent, mediaType, minScale, parts, useMapSrs, webApplication, operationMode, disabledUiFeatures, }) {
     if (disabledUiFeatures) {
         disabledUiFeatures.forEach((feature) => assert(validUiFeature(feature), `Invalid UI feature: ${feature}`));
     }
@@ -608,6 +603,9 @@ function createParams({ action, expandNavigator, fileName, geometryType, hideMai
     if (operationMode) {
         assert(validOperationMode(operationMode), `Invalid operation mode: ${operationMode}`);
     }
+    if (parts) {
+        parts.forEach((part) => assert(validTablePart(part), `Invalid table part: ${part}`));
+    }
     return new URLSearchParams({
         ...(action && { action }),
         ...(disabledUiFeatures && {
@@ -619,6 +617,7 @@ function createParams({ action, expandNavigator, fileName, geometryType, hideMai
         ...(hideMainHeaderAndFooter && { hideMainHeaderAndFooter: 'true' }),
         ...(hideWorkbookToolBar && { hideWorkbookToolBar: 'true' }),
         ...(highlightGlobalId && { highlightGlobalId }),
+        ...(labelSet && { labelSet }),
         ...(locationFinder && { locationFinder }),
         ...(mapExtent && { mapExtent: mapExtent.join() }),
         ...(mediaType && { mediaType }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@disy/cadenza.js",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "license": "Apache-2.0",
   "repository": "github:DisyInformationssysteme/cadenza.js",
   "type": "module",
@@ -30,18 +30,18 @@
     "sandbox": "node ./sandbox.cjs"
   },
   "devDependencies": {
-    "@types/jest": "29.5.3",
+    "@types/jest": "29.5.8",
     "cross-env": "7.0.3",
     "gh-pages": "6.0.0",
     "http-server": "14.1.1",
-    "jest": "29.6.1",
-    "jest-environment-jsdom": "29.6.1",
-    "keep-a-changelog": "2.3.0",
+    "jest": "29.7.0",
+    "jest-environment-jsdom": "29.7.0",
+    "keep-a-changelog": "2.5.2",
     "npm-run-all": "4.1.5",
     "onchange": "7.1.0",
-    "prettier": "3.0.0",
+    "prettier": "3.1.0",
     "ts-jest": "29.1.1",
-    "typedoc": "0.24.8"
+    "typedoc": "0.25.3"
   },
   "volta": {
     "node": "16.13.1"

package/sandbox.cjs

@@ -1,7 +1,13 @@
 const { execSync } = require('child_process');
 const { URL } = require('url');
 
+const CADENZA_URL_PARAM = '--cadenza-url';
 const DEFAULT_CADENZA_URL = 'http://localhost:8080/cadenza';
-const cadenzaUrl = new URL((process.argv[2] === '--cadenza-url' && process.argv[3]) || process.env.CADENZA_URL || DEFAULT_CADENZA_URL);
 
-execSync(`npx http-server -a localhost -c-1 -d false --proxy ${cadenzaUrl.origin} --proxy-options.headers.Origin ${cadenzaUrl.origin} -o /sandbox.html${cadenzaUrl.pathname !== '/' ? `?contextPath=${cadenzaUrl.pathname}` : ''}`, { stdio: 'inherit' });
+const index = process.argv.indexOf(CADENZA_URL_PARAM);
+const cadenzaUrlFromArgs = index !== -1
+    ? process.argv[index + 1]
+    : process.argv.find(arg => arg.startsWith(CADENZA_URL_PARAM + '='))?.slice(CADENZA_URL_PARAM.length + 1);
+const cadenzaUrl = new URL(cadenzaUrlFromArgs || process.env.CADENZA_URL || DEFAULT_CADENZA_URL);
+
+execSync(`npx --yes http-server -a localhost -c-1 -d false --proxy ${cadenzaUrl.origin} --proxy-options.headers.Origin ${cadenzaUrl.origin} -o /sandbox.html${cadenzaUrl.pathname !== '/' ? `?contextPath=${cadenzaUrl.pathname}` : ''}`, { stdio: 'inherit' });

package/sandbox.html

@@ -82,10 +82,11 @@
           disabledUiFeatures: disabledUiFeatures && disabledUiFeatures.split(',')
         });
       },
-      showPage ({ page, expandNavigator, highlightGlobalId }) {
+      showPage ({ page, expandNavigator, highlightGlobalId, labelSet }) {
         cadenzaClient.show({ page: page }, {
           expandNavigator: (expandNavigator === 'on'),
-          highlightGlobalId
+          highlightGlobalId,
+          labelSet
         });
       },
       expandNavigator ({ expandNavigator }) {
@@ -247,6 +248,10 @@
     <label for="highlightGlobalId">Highlighted Global ID</label>
     <input name="highlightGlobalId" id="highlightGlobalId">
   </div>
+  <div>
+    <label for="labelSet">Label Set</label>
+    <input name="labelSet" id="labelSet">
+  </div>
 </template>
 
 <template data-action="expandNavigator">

package/apidoc/types/PageType.html

@@ -1,68 +0,0 @@
-<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>PageType | Cadenza JS</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/search.js" id="tsd-search-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
-<div class="tsd-toolbar-contents container">
-<div class="table-cell" id="tsd-search" data-base="..">
-<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"><path d="M15.7824 13.833L12.6666 10.7177C12.5259 10.5771 12.3353 10.499 12.1353 10.499H11.6259C12.4884 9.39596 13.001 8.00859 13.001 6.49937C13.001 2.90909 10.0914 0 6.50048 0C2.90959 0 0 2.90909 0 6.49937C0 10.0896 2.90959 12.9987 6.50048 12.9987C8.00996 12.9987 9.39756 12.4863 10.5008 11.6239V12.1332C10.5008 12.3332 10.5789 12.5238 10.7195 12.6644L13.8354 15.7797C14.1292 16.0734 14.6042 16.0734 14.8948 15.7797L15.7793 14.8954C16.0731 14.6017 16.0731 14.1267 15.7824 13.833ZM6.50048 10.499C4.29094 10.499 2.50018 8.71165 2.50018 6.49937C2.50018 4.29021 4.28781 2.49976 6.50048 2.49976C8.71001 2.49976 10.5008 4.28708 10.5008 6.49937C10.5008 8.70852 8.71314 10.499 6.50048 10.499Z" fill="var(--color-text)"></path></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
-<div class="field">
-<div id="tsd-toolbar-links"></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</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"><rect x="1" y="3" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="7" width="14" height="2" fill="var(--color-text)"></rect><rect x="1" y="11" width="14" height="2" fill="var(--color-text)"></rect></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="PageType.html">PageType</a></li></ul>
-<h1>Type alias PageType</h1></div>
-<div class="tsd-signature"><span class="tsd-kind-type-alias">Page<wbr/>Type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;welcome&quot;</span></div>
-<div class="tsd-comment tsd-typography"><p>A Cadenza well-known page name</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/23b23d8/src/cadenza.js#L70">src/cadenza.js:70</a></li></ul></aside></div>
-<div class="col-sidebar">
-<div class="page-menu">
-<div class="tsd-navigation settings">
-<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
-<h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><path d="M4.93896 8.531L12 15.591L19.061 8.531L16.939 6.409L12 11.349L7.06098 6.409L4.93896 8.531Z" fill="var(--color-text)" id="icon-chevronDown"></path></svg>Settings</h3></summary>
-<div class="tsd-accordion-details">
-<div class="tsd-filter-visibility">
-<h4 class="uppercase">Member Visibility</h4><form>
-<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-private" name="private"/><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>Private</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></form></div>
-<div class="tsd-theme-toggle">
-<h4 class="uppercase">Theme</h4><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 class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-namespace)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.33 16V7.24H10.77L13.446 14.74C13.43 14.54 13.41 14.296 13.386 14.008C13.37 13.712 13.354 13.404 13.338 13.084C13.33 12.756 13.326 12.448 13.326 12.16V7.24H14.37V16H12.93L10.266 8.5C10.282 8.692 10.298 8.936 10.314 9.232C10.33 9.52 10.342 9.828 10.35 10.156C10.366 10.476 10.374 10.784 10.374 11.08V16H9.33Z" fill="var(--color-text)"></path></g></svg><span>Cadenza JS</span></a>
-<ul class="tsd-small-nested-navigation">
-<li><a href="../classes/AbortError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-128"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-class)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.898 16.1201C11.098 16.1201 10.466 15.8961 10.002 15.4481C9.53803 15.0001 9.30603 14.3841 9.30603 13.6001V9.64012C9.30603 8.85612 9.53803 8.24012 10.002 7.79212C10.466 7.34412 11.098 7.12012 11.898 7.12012C12.682 7.12012 13.306 7.34812 13.77 7.80412C14.234 8.25212 14.466 8.86412 14.466 9.64012H13.386C13.386 9.14412 13.254 8.76412 12.99 8.50012C12.734 8.22812 12.37 8.09212 11.898 8.09212C11.426 8.09212 11.054 8.22412 10.782 8.48812C10.518 8.75212 10.386 9.13212 10.386 9.62812V13.6001C10.386 14.0961 10.518 14.4801 10.782 14.7521C11.054 15.0161 11.426 15.1481 11.898 15.1481C12.37 15.1481 12.734 15.0161 12.99 14.7521C13.254 14.4801 13.386 14.0961 13.386 13.6001H14.466C14.466 14.3761 14.234 14.9921 13.77 15.4481C13.306 15.8961 12.682 16.1201 11.898 16.1201Z" fill="var(--color-text)"></path></g></svg><span>Abort<wbr/>Error</span></a></li>
-<li><a href="../classes/CadenzaClient.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cadenza<wbr/>Client</span></a></li>
-<li><a href="../classes/CadenzaError.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cadenza<wbr/>Error</span></a></li>
-<li><a href="../interfaces/CadenzaEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-256"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)"></path></g></svg><span>Cadenza<wbr/>Event</span></a></li>
-<li><a href="../interfaces/ExternalLinkKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>External<wbr/>Link<wbr/>Key</span></a></li>
-<li><a href="../interfaces/Geometry.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Geometry</span></a></li>
-<li><a href="../interfaces/PageSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Page<wbr/>Source</span></a></li>
-<li><a href="../interfaces/WorkbookKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workbook<wbr/>Key</span></a></li>
-<li><a href="../interfaces/WorkbookViewKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Workbook<wbr/>View<wbr/>Key</span></a></li>
-<li><a href="../interfaces/WorksheetKey.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Worksheet<wbr/>Key</span></a></li>
-<li><a href="CadenzaErrorEvent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-4194304"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-type-alias)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M11.31 16V8.224H8.91V7.24H14.79V8.224H12.39V16H11.31Z" fill="var(--color-text)"></path></g></svg><span>Cadenza<wbr/>Error<wbr/>Event</span></a></li>
-<li><a href="EmbeddingTargetId.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Embedding<wbr/>Target<wbr/>Id</span></a></li>
-<li><a href="Extent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Extent</span></a></li>
-<li><a href="GeometryType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Geometry<wbr/>Type</span></a></li>
-<li><a href="GlobalId.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Global<wbr/>Id</span></a></li>
-<li><a href="MediaType.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Media<wbr/>Type</span></a></li>
-<li><a href="OperationMode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Operation<wbr/>Mode</span></a></li>
-<li><a href="PageType.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Page<wbr/>Type</span></a></li>
-<li><a href="TablePart.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Table<wbr/>Part</span></a></li>
-<li><a href="UiFeature.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Ui<wbr/>Feature</span></a></li>
-<li><a href="WorkbookSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Workbook<wbr/>Source</span></a></li>
-<li><a href="WorkbookViewSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Workbook<wbr/>View<wbr/>Source</span></a></li>
-<li><a href="WorksheetSource.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Worksheet<wbr/>Source</span></a></li>
-<li><a href="../functions/cadenza.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-64"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-function)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6"></rect><path d="M9.39 16V7.24H14.55V8.224H10.446V11.128H14.238V12.112H10.47V16H9.39Z" fill="var(--color-text)"></path></g></svg><span>cadenza</span></a></li></ul></nav></div></div></div>
-<div class="tsd-generator">
-<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>
-<div class="overlay"></div></body></html>