@disy/cadenza.js 10.2.2 → 10.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +12 -0
- package/apidoc/assets/navigation.js +1 -1
- package/apidoc/assets/search.js +1 -1
- package/apidoc/classes/AbortError.html +3 -3
- package/apidoc/classes/CadenzaClient.html +31 -29
- package/apidoc/classes/CadenzaError.html +5 -5
- package/apidoc/functions/cadenza.html +3 -3
- package/apidoc/index.html +2 -2
- package/apidoc/interfaces/CadenzaClientOptions.html +5 -5
- package/apidoc/interfaces/CadenzaEvent.html +4 -4
- package/apidoc/interfaces/Distance.html +2 -2
- package/apidoc/interfaces/ExternalLinkKey.html +4 -4
- package/apidoc/interfaces/Feature.html +11 -7
- package/apidoc/interfaces/FeatureCollection.html +5 -3
- package/apidoc/interfaces/Geometry.html +6 -4
- package/apidoc/interfaces/GeometryZoomTarget.html +3 -3
- package/apidoc/interfaces/PageSource.html +3 -3
- package/apidoc/modules.html +3 -2
- package/apidoc/types/CadenzaActionEvent.html +2 -2
- package/apidoc/types/CadenzaChangeSelectionEvent.html +2 -2
- package/apidoc/types/CadenzaDrillThroughEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryCancelEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryOkEvent.html +2 -2
- package/apidoc/types/CadenzaEditGeometryUpdateEvent.html +2 -2
- package/apidoc/types/CadenzaErrorEvent.html +2 -2
- package/apidoc/types/CadenzaEventByType.html +1 -1
- package/apidoc/types/CadenzaEventType.html +2 -2
- package/apidoc/types/CadenzaObjectInfoEvent.html +2 -2
- package/apidoc/types/CadenzaReloadEvent.html +2 -2
- package/apidoc/types/CadenzaSelectObjectsCancelEvent.html +2 -2
- package/apidoc/types/CadenzaSelectObjectsOkEvent.html +2 -2
- package/apidoc/types/Coordinate.html +2 -0
- package/apidoc/types/CustomValidityType.html +2 -2
- package/apidoc/types/DataType.html +2 -2
- package/apidoc/types/EmbeddingTargetId.html +2 -2
- package/apidoc/types/Extent.html +2 -2
- package/apidoc/types/FilterVariables.html +2 -2
- package/apidoc/types/GeometryType.html +2 -2
- package/apidoc/types/GlobalId.html +2 -2
- package/apidoc/types/LengthUnit.html +1 -1
- package/apidoc/types/OpaqueString.html +2 -2
- package/apidoc/types/OperationMode.html +2 -2
- package/apidoc/types/TablePart.html +2 -2
- package/apidoc/types/UiFeature.html +2 -2
- package/apidoc/types/WorkbookLayerPath.html +2 -2
- package/apidoc/types/ZoomTarget.html +2 -2
- package/cadenza.d.ts +56 -24
- package/cadenza.js +21 -13
- package/package.json +1 -1
- package/sandbox.html +10 -8
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkbookLayerPath | Cadenza JS - v10.2.
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>WorkbookLayerPath | Cadenza JS - v10.2.3-dev</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" 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"><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.2.3-dev</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"><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="WorkbookLayerPath.html">WorkbookLayerPath</a></li></ul><h1>Type alias WorkbookLayerPath</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Workbook<wbr/>Layer<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><div class="tsd-comment tsd-typography"><p>Identifies a layer within a workbook map view
|
|
2
2
|
using the print names of the layer and - if the layer is grouped - its ancestors</p>
|
|
3
|
-
</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/
|
|
3
|
+
</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/1dba0036030d2e00a6ec752cd499709262d3e484/src/cadenza.js#L93">src/cadenza.js:93</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"><use href="../assets/icons.svg#icon-chevronDown"></use></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"><use href="../assets/icons.svg#icon-1"></use></svg><span>Cadenza JS - v10.2.3-dev</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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>
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZoomTarget | Cadenza JS - v10.2.
|
|
2
|
-
</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/
|
|
1
|
+
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ZoomTarget | Cadenza JS - v10.2.3-dev</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" 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"><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.2.3-dev</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"><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="ZoomTarget.html">ZoomTarget</a></li></ul><h1>Type alias ZoomTarget</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Zoom<wbr/>Target</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/GeometryZoomTarget.html" class="tsd-signature-type tsd-kind-interface">GeometryZoomTarget</a></div><div class="tsd-comment tsd-typography"><p>An object describing a target to zoom to</p>
|
|
2
|
+
</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/1dba0036030d2e00a6ec752cd499709262d3e484/src/cadenza.js#L135">src/cadenza.js:135</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"><use href="../assets/icons.svg#icon-chevronDown"></use></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"><use href="../assets/icons.svg#icon-1"></use></svg><span>Cadenza JS - v10.2.3-dev</span></a><ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".."><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>
|
package/cadenza.d.ts
CHANGED
|
@@ -48,8 +48,9 @@ export class CadenzaClient {
|
|
|
48
48
|
*
|
|
49
49
|
* @param {PageSource | EmbeddingTargetId} source - The source to show
|
|
50
50
|
* @param {object} [options]
|
|
51
|
-
* @param {DataType} [options.dataType] - Set to 'pdf' for
|
|
52
|
-
* to show the report PDF directly
|
|
51
|
+
* @param {DataType} [options.dataType] - Set to 'pdf' for embedding targets of type report and of views with view
|
|
52
|
+
* type of "JasperReports report" to show the generated report PDF directly (without any Cadenza headers or
|
|
53
|
+
* footers).
|
|
53
54
|
* @param {UiFeature[]} [options.disabledUiFeatures] - Cadenza UI features to disable
|
|
54
55
|
* @param {boolean} [options.expandNavigator] - Indicates if the navigator should be expanded.
|
|
55
56
|
* @param {FilterVariables} [options.filter] - Filter variables
|
|
@@ -206,7 +207,7 @@ export class CadenzaClient {
|
|
|
206
207
|
*/
|
|
207
208
|
removeSelection(layer: WorkbookLayerPath | string, values: unknown[][], ...args: any[]): Promise<void>;
|
|
208
209
|
/**
|
|
209
|
-
* @typedef
|
|
210
|
+
* @typedef LayerDefinition
|
|
210
211
|
* @property {string} name - The layer's name.
|
|
211
212
|
* @property {'geojson'} type - The layer's type.
|
|
212
213
|
* @property {FeatureCollection} content - The layer's content in geojson format.
|
|
@@ -276,7 +277,7 @@ export class CadenzaClient {
|
|
|
276
277
|
* @param {OperationMode} [options.operationMode] - The mode in which a workbook should be operated
|
|
277
278
|
* @param {ZoomTarget} [options.zoomTarget] - A target Cadenza should zoom to
|
|
278
279
|
* @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
|
|
279
|
-
* @param {
|
|
280
|
+
* @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).
|
|
280
281
|
* @return {Promise<void>} A `Promise` for when the iframe is loaded
|
|
281
282
|
* @throws For invalid arguments
|
|
282
283
|
* @fires
|
|
@@ -295,7 +296,20 @@ export class CadenzaClient {
|
|
|
295
296
|
operationMode?: OperationMode | undefined;
|
|
296
297
|
zoomTarget?: GeometryZoomTarget | undefined;
|
|
297
298
|
signal?: AbortSignal | undefined;
|
|
298
|
-
additionalLayers?:
|
|
299
|
+
additionalLayers?: {
|
|
300
|
+
/**
|
|
301
|
+
* - The layer's name.
|
|
302
|
+
*/
|
|
303
|
+
name: string;
|
|
304
|
+
/**
|
|
305
|
+
* - The layer's type.
|
|
306
|
+
*/
|
|
307
|
+
type: 'geojson';
|
|
308
|
+
/**
|
|
309
|
+
* - The layer's content in geojson format.
|
|
310
|
+
*/
|
|
311
|
+
content: FeatureCollection;
|
|
312
|
+
}[] | undefined;
|
|
299
313
|
} | undefined, ...args: any[]): Promise<void>;
|
|
300
314
|
/**
|
|
301
315
|
* Set custom validity state of the geometry editor in addition to the default validation state (including errors and
|
|
@@ -358,8 +372,9 @@ export class CadenzaClient {
|
|
|
358
372
|
*
|
|
359
373
|
* @param {EmbeddingTargetId} source - The workbook view to fetch data from.
|
|
360
374
|
* @param {DataType} dataType - The data type you want to get back from the server.
|
|
361
|
-
* Currently, `"csv"`, `"excel"` and `"json"` are supported for
|
|
362
|
-
* and `"pdf"` for
|
|
375
|
+
* Currently, `"csv"`, `"excel"` and `"json"` are supported for embedding targets of type view with a view type of
|
|
376
|
+
* table and indicator. `"pdf"` is supported for embedding targets of type report and of type view with a view type
|
|
377
|
+
* of "JasperReports report".
|
|
363
378
|
* @param {object} [options] - Options
|
|
364
379
|
* @param {FilterVariables} [options.filter] - Filter variables
|
|
365
380
|
* @param {TablePart[]} [options.parts] - Table parts to export; If not specified, all parts are exported.
|
|
@@ -420,8 +435,9 @@ export class CadenzaClient {
|
|
|
420
435
|
*
|
|
421
436
|
* @param {EmbeddingTargetId} source - The workbook view to fetch data from.
|
|
422
437
|
* @param {DataType} dataType - The data type you want to get back from the server.
|
|
423
|
-
* Currently, `"csv"`, `"excel"` and `"json"` are supported for
|
|
424
|
-
* and `"pdf"` for
|
|
438
|
+
* Currently, `"csv"`, `"excel"` and `"json"` are supported for embedding targets of type view with a view type of
|
|
439
|
+
* table and indicator. `"pdf"` is supported for embedding targets of type report and of type view with a view type
|
|
440
|
+
* of "JasperReports report".
|
|
425
441
|
* @param {object} [options] - Options
|
|
426
442
|
* @param {string} [options.fileName] - The file name to use; The file extension is appended by Cadenza.
|
|
427
443
|
* @param {FilterVariables} [options.filter] - Filter variables
|
|
@@ -475,7 +491,7 @@ export class CadenzaClient {
|
|
|
475
491
|
* @typedef {CadenzaEvent<'action', {context: string}>} CadenzaActionEvent - When the user executed a POST message action, which is defined on an external link in the Cadenza management center.
|
|
476
492
|
*/
|
|
477
493
|
/**
|
|
478
|
-
* @typedef {CadenzaEvent<'change:selection', undefined | {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaChangeSelectionEvent - When the user changed the selection.
|
|
494
|
+
* @typedef {CadenzaEvent<'change:selection', undefined | {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaChangeSelectionEvent - When the user changed the selection. `undefined` if no objects were selected.
|
|
479
495
|
*
|
|
480
496
|
* For a selection in a workbook map view with activated feature info, the values also include the simplified geometries of the selected objects.
|
|
481
497
|
*/
|
|
@@ -488,13 +504,13 @@ export class CadenzaClient {
|
|
|
488
504
|
* <p>
|
|
489
505
|
* See also: <a href="../index.html#md:json-representation-of-cadenza-object-data">JSON Representation of Cadenza Object Data</a>
|
|
490
506
|
*/
|
|
491
|
-
/** @typedef {CadenzaEvent<'editGeometry:update',
|
|
492
|
-
/** @typedef {CadenzaEvent<'editGeometry:ok',
|
|
507
|
+
/** @typedef {CadenzaEvent<'editGeometry:update', FeatureCollection | Feature | undefined>} CadenzaEditGeometryUpdateEvent - When the user changed the geometry. `FeatureCollection` if multiple features are present on the edit layer, but the original defined type is not multi-geometry. This is also the case if the dialog was instantiated from a geometry and the original defined type is inherited. `undefined` if no feature is present on the edit layer. */
|
|
508
|
+
/** @typedef {CadenzaEvent<'editGeometry:ok', Feature>} CadenzaEditGeometryOkEvent - When the user submitted the geometry. */
|
|
493
509
|
/** @typedef {CadenzaEvent<'editGeometry:cancel'>} CadenzaEditGeometryCancelEvent - When the user cancelled the geometry editing. */
|
|
494
510
|
/** @typedef {CadenzaEvent<'error', {type: string, message?: string}>} CadenzaErrorEvent - An error event that is mapped to a {@link CadenzaError} */
|
|
495
511
|
/** @typedef {CadenzaEvent<'objectInfo', {layer: WorkbookLayerPath, objectInfos: {selectionIndex: number, elements: {attributePrintName: string, formattedValue: string}[]}}>} CadenzaObjectInfoEvent - When the user opened the object info flyout. */
|
|
496
512
|
/**
|
|
497
|
-
* @typedef {CadenzaEvent<'selectObjects:ok', {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaSelectObjectsOkEvent - When the user submitted the selection.
|
|
513
|
+
* @typedef {CadenzaEvent<'selectObjects:ok', undefined | {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaSelectObjectsOkEvent - When the user submitted the selection. `undefined` if no objects were selected.
|
|
498
514
|
*
|
|
499
515
|
* For a selection in a workbook map view with activated feature info, the values also include the simplified geometries of the selected objects.
|
|
500
516
|
*/
|
|
@@ -623,6 +639,10 @@ export type Distance = {
|
|
|
623
639
|
lengthUnit: LengthUnit;
|
|
624
640
|
};
|
|
625
641
|
export type LengthUnit = 'm' | 'km';
|
|
642
|
+
/**
|
|
643
|
+
* - A tuple with an x and y value
|
|
644
|
+
*/
|
|
645
|
+
export type Coordinate = [number, number];
|
|
626
646
|
/**
|
|
627
647
|
* - A [GeoJSON](https://geojson.org/) geometry object
|
|
628
648
|
*/
|
|
@@ -631,6 +651,10 @@ export type Geometry = {
|
|
|
631
651
|
* - The type of the geometry
|
|
632
652
|
*/
|
|
633
653
|
type: GeometryType;
|
|
654
|
+
/**
|
|
655
|
+
* - The coordinates of the geometry
|
|
656
|
+
*/
|
|
657
|
+
coordinates: Coordinate | Coordinate[] | Coordinate[][] | Coordinate[][][];
|
|
634
658
|
};
|
|
635
659
|
/**
|
|
636
660
|
* - A GeoJSON geometry type
|
|
@@ -678,6 +702,10 @@ export type FilterVariables = Record<string, string | string[] | number | Date |
|
|
|
678
702
|
* - A adapted [GeoJSON](https://geojson.org/) feature object.
|
|
679
703
|
*/
|
|
680
704
|
export type Feature = {
|
|
705
|
+
/**
|
|
706
|
+
* - The object's type
|
|
707
|
+
*/
|
|
708
|
+
type: 'Feature';
|
|
681
709
|
/**
|
|
682
710
|
* - The id of the feature
|
|
683
711
|
*/
|
|
@@ -695,7 +723,11 @@ export type Feature = {
|
|
|
695
723
|
*/
|
|
696
724
|
area?: number | undefined;
|
|
697
725
|
/**
|
|
698
|
-
* - The
|
|
726
|
+
* - The circumference of a `Polygon` feature
|
|
727
|
+
*/
|
|
728
|
+
circumference?: number | undefined;
|
|
729
|
+
/**
|
|
730
|
+
* - The length of a `LineString` feature
|
|
699
731
|
*/
|
|
700
732
|
length?: number | undefined;
|
|
701
733
|
};
|
|
@@ -703,6 +735,10 @@ export type Feature = {
|
|
|
703
735
|
* - A adapted [GeoJSON](https://geojson.org/) feature collection object
|
|
704
736
|
*/
|
|
705
737
|
export type FeatureCollection = {
|
|
738
|
+
/**
|
|
739
|
+
* - The object's type
|
|
740
|
+
*/
|
|
741
|
+
type: 'FeatureCollection';
|
|
706
742
|
/**
|
|
707
743
|
* - The features within this collection
|
|
708
744
|
*/
|
|
@@ -737,7 +773,7 @@ export type CadenzaActionEvent = CadenzaEvent<'action', {
|
|
|
737
773
|
context: string;
|
|
738
774
|
}>;
|
|
739
775
|
/**
|
|
740
|
-
* - When the user changed the selection.
|
|
776
|
+
* - When the user changed the selection. `undefined` if no objects were selected.
|
|
741
777
|
*
|
|
742
778
|
* For a selection in a workbook map view with activated feature info, the values also include the simplified geometries of the selected objects.
|
|
743
779
|
*/
|
|
@@ -759,17 +795,13 @@ export type CadenzaDrillThroughEvent = CadenzaEvent<'drillThrough', {
|
|
|
759
795
|
values: unknown[][];
|
|
760
796
|
}>;
|
|
761
797
|
/**
|
|
762
|
-
* - When the user changed the geometry.
|
|
798
|
+
* - When the user changed the geometry. `FeatureCollection` if multiple features are present on the edit layer, but the original defined type is not multi-geometry. This is also the case if the dialog was instantiated from a geometry and the original defined type is inherited. `undefined` if no feature is present on the edit layer.
|
|
763
799
|
*/
|
|
764
|
-
export type CadenzaEditGeometryUpdateEvent = CadenzaEvent<'editGeometry:update',
|
|
765
|
-
geometry: Geometry;
|
|
766
|
-
}>;
|
|
800
|
+
export type CadenzaEditGeometryUpdateEvent = CadenzaEvent<'editGeometry:update', FeatureCollection | Feature | undefined>;
|
|
767
801
|
/**
|
|
768
802
|
* - When the user submitted the geometry.
|
|
769
803
|
*/
|
|
770
|
-
export type CadenzaEditGeometryOkEvent = CadenzaEvent<'editGeometry:ok',
|
|
771
|
-
geometry: Geometry;
|
|
772
|
-
}>;
|
|
804
|
+
export type CadenzaEditGeometryOkEvent = CadenzaEvent<'editGeometry:ok', Feature>;
|
|
773
805
|
/**
|
|
774
806
|
* - When the user cancelled the geometry editing.
|
|
775
807
|
*/
|
|
@@ -795,11 +827,11 @@ export type CadenzaObjectInfoEvent = CadenzaEvent<'objectInfo', {
|
|
|
795
827
|
};
|
|
796
828
|
}>;
|
|
797
829
|
/**
|
|
798
|
-
* - When the user submitted the selection.
|
|
830
|
+
* - When the user submitted the selection. `undefined` if no objects were selected.
|
|
799
831
|
*
|
|
800
832
|
* For a selection in a workbook map view with activated feature info, the values also include the simplified geometries of the selected objects.
|
|
801
833
|
*/
|
|
802
|
-
export type CadenzaSelectObjectsOkEvent = CadenzaEvent<'selectObjects:ok', {
|
|
834
|
+
export type CadenzaSelectObjectsOkEvent = CadenzaEvent<'selectObjects:ok', undefined | {
|
|
803
835
|
layer: string[];
|
|
804
836
|
values: unknown[][];
|
|
805
837
|
}>;
|
package/cadenza.js
CHANGED
|
@@ -105,9 +105,11 @@ globalThis.cadenza = Object.assign((/** @type Parameters<cadenza> */ ...args) =>
|
|
|
105
105
|
/**
|
|
106
106
|
* @typedef {'m'|'km'} LengthUnit
|
|
107
107
|
*/
|
|
108
|
+
/** @typedef {[number, number]} Coordinate - A tuple with an x and y value */
|
|
108
109
|
/**
|
|
109
110
|
* @typedef Geometry - A [GeoJSON](https://geojson.org/) geometry object
|
|
110
111
|
* @property {GeometryType} type - The type of the geometry
|
|
112
|
+
* @property {Coordinate | Coordinate[] | Coordinate[][] | Coordinate[][][]} coordinates - The coordinates of the geometry
|
|
111
113
|
*/
|
|
112
114
|
/**
|
|
113
115
|
* @typedef {'Point'|'MultiPoint'|'LineString'|'MultiLineString'|'Polygon'|'MultiPolygon'} GeometryType - A GeoJSON geometry type
|
|
@@ -138,14 +140,17 @@ globalThis.cadenza = Object.assign((/** @type Parameters<cadenza> */ ...args) =>
|
|
|
138
140
|
*/
|
|
139
141
|
/**
|
|
140
142
|
* @typedef Feature - A adapted [GeoJSON](https://geojson.org/) feature object.
|
|
143
|
+
* @property {'Feature'} type - The object's type
|
|
141
144
|
* @property {any[]} objectId - The id of the feature
|
|
142
145
|
* @property {Geometry} geometry - The geometry
|
|
143
146
|
* @property {Record<string, string>} properties - The formated properties
|
|
144
147
|
* @property {number} [area] - The area of a `Polygon` feature
|
|
145
|
-
* @property {number} [
|
|
148
|
+
* @property {number} [circumference] - The circumference of a `Polygon` feature
|
|
149
|
+
* @property {number} [length] - The length of a `LineString` feature
|
|
146
150
|
*/
|
|
147
151
|
/**
|
|
148
152
|
* @typedef FeatureCollection - A adapted [GeoJSON](https://geojson.org/) feature collection object
|
|
153
|
+
* @property {'FeatureCollection'} type - The object's type
|
|
149
154
|
* @property {Feature[]} features - The features within this collection
|
|
150
155
|
*/
|
|
151
156
|
/** @typedef {'error'|'warning'|'info'|'success'} CustomValidityType - The type of custom validity used for disclose on visual presentation and form submission behavior */
|
|
@@ -242,8 +247,9 @@ export class CadenzaClient {
|
|
|
242
247
|
*
|
|
243
248
|
* @param {PageSource | EmbeddingTargetId} source - The source to show
|
|
244
249
|
* @param {object} [options]
|
|
245
|
-
* @param {DataType} [options.dataType] - Set to 'pdf' for
|
|
246
|
-
* to show the report PDF directly
|
|
250
|
+
* @param {DataType} [options.dataType] - Set to 'pdf' for embedding targets of type report and of views with view
|
|
251
|
+
* type of "JasperReports report" to show the generated report PDF directly (without any Cadenza headers or
|
|
252
|
+
* footers).
|
|
247
253
|
* @param {UiFeature[]} [options.disabledUiFeatures] - Cadenza UI features to disable
|
|
248
254
|
* @param {boolean} [options.expandNavigator] - Indicates if the navigator should be expanded.
|
|
249
255
|
* @param {FilterVariables} [options.filter] - Filter variables
|
|
@@ -458,7 +464,7 @@ export class CadenzaClient {
|
|
|
458
464
|
});
|
|
459
465
|
}
|
|
460
466
|
/**
|
|
461
|
-
* @typedef
|
|
467
|
+
* @typedef LayerDefinition
|
|
462
468
|
* @property {string} name - The layer's name.
|
|
463
469
|
* @property {'geojson'} type - The layer's type.
|
|
464
470
|
* @property {FeatureCollection} content - The layer's content in geojson format.
|
|
@@ -522,7 +528,7 @@ export class CadenzaClient {
|
|
|
522
528
|
* @param {OperationMode} [options.operationMode] - The mode in which a workbook should be operated
|
|
523
529
|
* @param {ZoomTarget} [options.zoomTarget] - A target Cadenza should zoom to
|
|
524
530
|
* @param {AbortSignal} [options.signal] - A signal to abort the iframe loading
|
|
525
|
-
* @param {
|
|
531
|
+
* @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).
|
|
526
532
|
* @return {Promise<void>} A `Promise` for when the iframe is loaded
|
|
527
533
|
* @throws For invalid arguments
|
|
528
534
|
* @fires
|
|
@@ -787,8 +793,9 @@ export class CadenzaClient {
|
|
|
787
793
|
*
|
|
788
794
|
* @param {EmbeddingTargetId} source - The workbook view to fetch data from.
|
|
789
795
|
* @param {DataType} dataType - The data type you want to get back from the server.
|
|
790
|
-
* Currently, `"csv"`, `"excel"` and `"json"` are supported for
|
|
791
|
-
* and `"pdf"` for
|
|
796
|
+
* Currently, `"csv"`, `"excel"` and `"json"` are supported for embedding targets of type view with a view type of
|
|
797
|
+
* table and indicator. `"pdf"` is supported for embedding targets of type report and of type view with a view type
|
|
798
|
+
* of "JasperReports report".
|
|
792
799
|
* @param {object} [options] - Options
|
|
793
800
|
* @param {FilterVariables} [options.filter] - Filter variables
|
|
794
801
|
* @param {TablePart[]} [options.parts] - Table parts to export; If not specified, all parts are exported.
|
|
@@ -890,8 +897,9 @@ export class CadenzaClient {
|
|
|
890
897
|
*
|
|
891
898
|
* @param {EmbeddingTargetId} source - The workbook view to fetch data from.
|
|
892
899
|
* @param {DataType} dataType - The data type you want to get back from the server.
|
|
893
|
-
* Currently, `"csv"`, `"excel"` and `"json"` are supported for
|
|
894
|
-
* and `"pdf"` for
|
|
900
|
+
* Currently, `"csv"`, `"excel"` and `"json"` are supported for embedding targets of type view with a view type of
|
|
901
|
+
* table and indicator. `"pdf"` is supported for embedding targets of type report and of type view with a view type
|
|
902
|
+
* of "JasperReports report".
|
|
895
903
|
* @param {object} [options] - Options
|
|
896
904
|
* @param {string} [options.fileName] - The file name to use; The file extension is appended by Cadenza.
|
|
897
905
|
* @param {FilterVariables} [options.filter] - Filter variables
|
|
@@ -1143,7 +1151,7 @@ function array(/** @type unknown */ value) {
|
|
|
1143
1151
|
* The extent is transformed according to the `useMapSrs` option.
|
|
1144
1152
|
*/
|
|
1145
1153
|
/**
|
|
1146
|
-
* @typedef {CadenzaEvent<'change:selection', undefined | {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaChangeSelectionEvent - When the user changed the selection.
|
|
1154
|
+
* @typedef {CadenzaEvent<'change:selection', undefined | {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaChangeSelectionEvent - When the user changed the selection. `undefined` if no objects were selected.
|
|
1147
1155
|
*
|
|
1148
1156
|
* For a selection in a workbook map view with activated feature info, the values also include the simplified geometries of the selected objects.
|
|
1149
1157
|
*/
|
|
@@ -1156,13 +1164,13 @@ function array(/** @type unknown */ value) {
|
|
|
1156
1164
|
* <p>
|
|
1157
1165
|
* See also: <a href="../index.html#md:json-representation-of-cadenza-object-data">JSON Representation of Cadenza Object Data</a>
|
|
1158
1166
|
*/
|
|
1159
|
-
/** @typedef {CadenzaEvent<'editGeometry:update',
|
|
1160
|
-
/** @typedef {CadenzaEvent<'editGeometry:ok',
|
|
1167
|
+
/** @typedef {CadenzaEvent<'editGeometry:update', FeatureCollection | Feature | undefined>} CadenzaEditGeometryUpdateEvent - When the user changed the geometry. `FeatureCollection` if multiple features are present on the edit layer, but the original defined type is not multi-geometry. This is also the case if the dialog was instantiated from a geometry and the original defined type is inherited. `undefined` if no feature is present on the edit layer. */
|
|
1168
|
+
/** @typedef {CadenzaEvent<'editGeometry:ok', Feature>} CadenzaEditGeometryOkEvent - When the user submitted the geometry. */
|
|
1161
1169
|
/** @typedef {CadenzaEvent<'editGeometry:cancel'>} CadenzaEditGeometryCancelEvent - When the user cancelled the geometry editing. */
|
|
1162
1170
|
/** @typedef {CadenzaEvent<'error', {type: string, message?: string}>} CadenzaErrorEvent - An error event that is mapped to a {@link CadenzaError} */
|
|
1163
1171
|
/** @typedef {CadenzaEvent<'objectInfo', {layer: WorkbookLayerPath, objectInfos: {selectionIndex: number, elements: {attributePrintName: string, formattedValue: string}[]}}>} CadenzaObjectInfoEvent - When the user opened the object info flyout. */
|
|
1164
1172
|
/**
|
|
1165
|
-
* @typedef {CadenzaEvent<'selectObjects:ok', {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaSelectObjectsOkEvent - When the user submitted the selection.
|
|
1173
|
+
* @typedef {CadenzaEvent<'selectObjects:ok', undefined | {layer: WorkbookLayerPath, values: unknown[][]}>} CadenzaSelectObjectsOkEvent - When the user submitted the selection. `undefined` if no objects were selected.
|
|
1166
1174
|
*
|
|
1167
1175
|
* For a selection in a workbook map view with activated feature info, the values also include the simplified geometries of the selected objects.
|
|
1168
1176
|
*/
|
package/package.json
CHANGED
package/sandbox.html
CHANGED
|
@@ -219,7 +219,7 @@
|
|
|
219
219
|
hideMainHeaderAndFooter,
|
|
220
220
|
hideWorkbookToolBar,
|
|
221
221
|
highlightGlobalId,
|
|
222
|
-
|
|
222
|
+
requestAsPdf,
|
|
223
223
|
labelSet,
|
|
224
224
|
locationFinder,
|
|
225
225
|
mapExtent,
|
|
@@ -243,7 +243,7 @@
|
|
|
243
243
|
hideMainHeaderAndFooter: (hideMainHeaderAndFooter === 'on'),
|
|
244
244
|
hideWorkbookToolBar: (hideWorkbookToolBar === 'on'),
|
|
245
245
|
highlightGlobalId,
|
|
246
|
-
...(
|
|
246
|
+
...(requestAsPdf === 'on' && { dataType: 'pdf' }),
|
|
247
247
|
labelSet,
|
|
248
248
|
locationFinder,
|
|
249
249
|
mapExtent: mapExtent && mapExtent.split(',').map(Number),
|
|
@@ -440,8 +440,8 @@
|
|
|
440
440
|
</div>
|
|
441
441
|
<div>
|
|
442
442
|
<label>
|
|
443
|
-
<input type="checkbox" name="
|
|
444
|
-
Show
|
|
443
|
+
<input type="checkbox" name="requestAsPdf" id="requestAsPdf"/>
|
|
444
|
+
Show as PDF (Reports)
|
|
445
445
|
</label>
|
|
446
446
|
</div>
|
|
447
447
|
</template>
|
|
@@ -476,7 +476,7 @@
|
|
|
476
476
|
</div>
|
|
477
477
|
<div>
|
|
478
478
|
<label for="geometry">Geometry (GeoJSON)</label>
|
|
479
|
-
<textarea name="geometry" id="geometry" rows="5"></textarea>
|
|
479
|
+
<textarea name="geometry" id="geometry" rows="5" placeholder="{"coordinates":[[[9.598504509838506,52.70992820638244],[8.899110702389294,51.72257425885121],[10.906499617840836,51.725944168909365],[9.598504509838506,52.70992820638244]]],"type":"Polygon"}"></textarea>
|
|
480
480
|
</div>
|
|
481
481
|
</template>
|
|
482
482
|
|
|
@@ -503,7 +503,7 @@
|
|
|
503
503
|
</div>
|
|
504
504
|
<div>
|
|
505
505
|
<label for="geometry">Additional layers (GeoJSON)</label>
|
|
506
|
-
<textarea name="additionalLayers" id="additionalLayers" rows="10"></textarea>
|
|
506
|
+
<textarea name="additionalLayers" id="additionalLayers" rows="10" placeholder="[ { type: "geojson", name: "Stuttgart", content: { "type": "FeatureCollection", "features": [ { "type": "Feature", "properties": {}, "geometry": { "coordinates": [ [ [ 9.019743777219759, 48.939075160317145 ], [ 9.060437807540097, 48.70393235548886 ], [ 9.734017619469824, 48.7841975772329 ], [ 9.019743777219759, 48.939075160317145 ] ] ], "type": "Polygon" } } ] } } ]"></textarea>
|
|
507
507
|
</div>
|
|
508
508
|
<div>
|
|
509
509
|
<label for="geometryType">Geometry type</label>
|
|
@@ -535,11 +535,13 @@
|
|
|
535
535
|
</div>
|
|
536
536
|
<div>
|
|
537
537
|
<label for="geometry">Additional layers (GeoJSON)</label>
|
|
538
|
-
<
|
|
538
|
+
<button>Add example</button>
|
|
539
|
+
<textarea name="additionalLayers" id="additionalLayers" rows="10" placeholder="[ { type: "geojson", name: "Stuttgart", content: { "type": "FeatureCollection", "features": [ { "type": "Feature", "properties": {}, "geometry": { "coordinates": [ [ [ 9.019743777219759, 48.939075160317145 ], [ 9.060437807540097, 48.70393235548886 ], [ 9.734017619469824, 48.7841975772329 ], [ 9.019743777219759, 48.939075160317145 ] ] ], "type": "Polygon" } } ] } } ]"></textarea>
|
|
539
540
|
</div>
|
|
540
541
|
<div>
|
|
541
542
|
<label for="geometry">Geometry (GeoJSON) *</label>
|
|
542
|
-
<textarea name="geometry" id="geometry" rows="5" required></textarea>
|
|
543
|
+
<textarea name="geometry" id="geometry" rows="5" required placeholder="{"coordinates":[[[9.598504509838506,52.70992820638244],[8.899110702389294,51.72257425885121],[10.906499617840836,51.725944168909365],[9.598504509838506,52.70992820638244]]],"type":"Polygon"}"></textarea>
|
|
544
|
+
<small></small>
|
|
543
545
|
</div>
|
|
544
546
|
<div>
|
|
545
547
|
<label>
|