@disy/cadenza.js 10.2.2 → 10.2.4

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.
Files changed (55) hide show
  1. package/CHANGELOG.md +25 -0
  2. package/apidoc/assets/navigation.js +1 -1
  3. package/apidoc/assets/search.js +1 -1
  4. package/apidoc/classes/AbortError.html +3 -3
  5. package/apidoc/classes/CadenzaClient.html +123 -38
  6. package/apidoc/classes/CadenzaError.html +5 -5
  7. package/apidoc/functions/cadenza.html +3 -3
  8. package/apidoc/index.html +2 -2
  9. package/apidoc/interfaces/CadenzaClientOptions.html +5 -5
  10. package/apidoc/interfaces/CadenzaEvent.html +4 -4
  11. package/apidoc/interfaces/Distance.html +2 -2
  12. package/apidoc/interfaces/ExternalLinkKey.html +4 -4
  13. package/apidoc/interfaces/Feature.html +11 -7
  14. package/apidoc/interfaces/FeatureCollection.html +5 -3
  15. package/apidoc/interfaces/Geometry.html +6 -4
  16. package/apidoc/interfaces/GeometryExtentStrategy.html +6 -0
  17. package/apidoc/interfaces/LayerDataExtentStrategy.html +7 -0
  18. package/apidoc/interfaces/LayerDefinition.html +7 -0
  19. package/apidoc/interfaces/LocationFinderExtentStrategy.html +6 -0
  20. package/apidoc/interfaces/PageSource.html +3 -3
  21. package/apidoc/interfaces/StaticExtentStrategy.html +6 -0
  22. package/apidoc/modules.html +9 -4
  23. package/apidoc/types/CadenzaActionEvent.html +2 -2
  24. package/apidoc/types/CadenzaChangeSelectionEvent.html +2 -2
  25. package/apidoc/types/CadenzaDrillThroughEvent.html +2 -2
  26. package/apidoc/types/CadenzaEditGeometryCancelEvent.html +2 -2
  27. package/apidoc/types/CadenzaEditGeometryOkEvent.html +2 -2
  28. package/apidoc/types/CadenzaEditGeometryUpdateEvent.html +2 -2
  29. package/apidoc/types/CadenzaErrorEvent.html +2 -2
  30. package/apidoc/types/CadenzaEventByType.html +1 -1
  31. package/apidoc/types/CadenzaEventType.html +2 -2
  32. package/apidoc/types/CadenzaObjectInfoEvent.html +2 -2
  33. package/apidoc/types/CadenzaReloadEvent.html +2 -2
  34. package/apidoc/types/CadenzaSelectObjectsCancelEvent.html +2 -2
  35. package/apidoc/types/CadenzaSelectObjectsOkEvent.html +2 -2
  36. package/apidoc/types/{ZoomTarget.html → Coordinate.html} +2 -2
  37. package/apidoc/types/CustomValidityType.html +2 -2
  38. package/apidoc/types/DataType.html +2 -2
  39. package/apidoc/types/EmbeddingTargetId.html +2 -2
  40. package/apidoc/types/Extent.html +2 -2
  41. package/apidoc/types/ExtentStrategy.html +5 -0
  42. package/apidoc/types/FilterVariables.html +2 -2
  43. package/apidoc/types/GeometryType.html +2 -2
  44. package/apidoc/types/GlobalId.html +2 -2
  45. package/apidoc/types/LengthUnit.html +1 -1
  46. package/apidoc/types/OpaqueString.html +2 -2
  47. package/apidoc/types/OperationMode.html +2 -2
  48. package/apidoc/types/TablePart.html +2 -2
  49. package/apidoc/types/UiFeature.html +2 -2
  50. package/apidoc/types/WorkbookLayerPath.html +2 -2
  51. package/cadenza.d.ts +198 -130
  52. package/cadenza.js +245 -122
  53. package/package.json +1 -1
  54. package/sandbox.html +129 -41
  55. package/apidoc/interfaces/GeometryZoomTarget.html +0 -4
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@disy/cadenza.js",
3
- "version": "10.2.2",
3
+ "version": "10.2.4",
4
4
  "license": "Apache-2.0",
5
5
  "repository": "github:DisyInformationssysteme/cadenza.js",
6
6
  "type": "module",
package/sandbox.html CHANGED
@@ -39,6 +39,7 @@
39
39
  display: flex;
40
40
  flex-direction: column;
41
41
  gap: var(--gap);
42
+ overflow: scroll;
42
43
  }
43
44
  fieldset > div {
44
45
  display: flex;
@@ -121,7 +122,7 @@
121
122
  settingsContainer.append(
122
123
  document.createElement('hr'),
123
124
  commonSettingsTemplate.content.cloneNode(true));
124
- })
125
+ });
125
126
  }
126
127
 
127
128
  const data = localStorage.getItem(`cadenzajs-sandbox-${action}`);
@@ -193,7 +194,7 @@
193
194
  localStorage.setItem(`cadenzajs-sandbox-${action}`, JSON.stringify(data));
194
195
  };
195
196
 
196
- actionSelect.classList.toggle('show-unpublished', urlParams.has('showUnpublished'))
197
+ actionSelect.classList.toggle('show-unpublished', urlParams.has('showUnpublished'));
197
198
  actionSelect.value = urlParams.get('action') || 'show';
198
199
  actionSelect.onchange();
199
200
 
@@ -219,17 +220,15 @@
219
220
  hideMainHeaderAndFooter,
220
221
  hideWorkbookToolBar,
221
222
  highlightGlobalId,
222
- jasperReportAsPdf,
223
+ requestAsPdf,
223
224
  labelSet,
224
- locationFinder,
225
- mapExtent,
226
225
  minScale,
227
226
  parts,
228
227
  layers,
229
228
  simplifiedOperationMode,
230
229
  useMapSrs,
231
230
  fullGeometries,
232
- zoomToGeometry,
231
+ extentStrategy,
233
232
  distance,
234
233
  lengthUnit,
235
234
  additionalLayers
@@ -243,17 +242,15 @@
243
242
  hideMainHeaderAndFooter: (hideMainHeaderAndFooter === 'on'),
244
243
  hideWorkbookToolBar: (hideWorkbookToolBar === 'on'),
245
244
  highlightGlobalId,
246
- ...(jasperReportAsPdf === 'on' && { dataType: 'pdf' }),
245
+ ...(requestAsPdf === 'on' && { dataType: 'pdf' }),
247
246
  labelSet,
248
- locationFinder,
249
- mapExtent: mapExtent && mapExtent.split(',').map(Number),
250
247
  minScale: minScale && Number(minScale),
251
248
  parts: parts && parts.split(','),
252
249
  operationMode: (simplifiedOperationMode === 'on' ? 'simplified' : 'normal' ),
253
250
  layers: layers ? JSON.parse(layers) : undefined,
254
251
  useMapSrs: useMapSrs === 'on',
255
252
  fullGeometries: fullGeometries === 'on',
256
- zoomTarget: zoomToGeometry === 'on' ? { type: 'geometry' } : undefined,
253
+ extentStrategy: extentStrategy && JSON.parse(extentStrategy),
257
254
  buffer: distance ? { value: Number(distance), lengthUnit: lengthUnit ? lengthUnit : 'm' } : undefined,
258
255
  additionalLayers: additionalLayers && JSON.parse(additionalLayers)
259
256
  };
@@ -399,14 +396,6 @@
399
396
  Use map SRS
400
397
  </label>
401
398
  </div>
402
- <div>
403
- <label for="mapExtent">Map extent coordinates</label>
404
- <input name="mapExtent" id="mapExtent" placeholder="minX,minY,maxX,maxY">
405
- </div>
406
- <div>
407
- <label for="locationFinder">Location finder search query</label>
408
- <input name="locationFinder" id="locationFinder">
409
- </div>
410
399
  </template>
411
400
 
412
401
  <template id="common-data">
@@ -440,8 +429,8 @@
440
429
  </div>
441
430
  <div>
442
431
  <label>
443
- <input type="checkbox" name="jasperReportAsPdf" id="jasperReportAsPdf"/>
444
- Show Jasper Report as PDF
432
+ <input type="checkbox" name="requestAsPdf" id="requestAsPdf"/>
433
+ Show as PDF (Reports)
445
434
  </label>
446
435
  </div>
447
436
  </template>
@@ -469,15 +458,11 @@
469
458
  </div>
470
459
  </template>
471
460
 
472
- <template data-action="showMap" data-common="zoomTo,map,showWorkbook,disabledUiFeatures,filter,show">
461
+ <template data-action="showMap" data-common="additionalLayers,extentStrategy,map,showWorkbook,disabledUiFeatures,filter,show">
473
462
  <div>
474
463
  <label for="embeddingTargetId">Embedding target ID of the map view *</label>
475
464
  <input name="embeddingTargetId" id="embeddingTargetId" required>
476
465
  </div>
477
- <div>
478
- <label for="geometry">Geometry (GeoJSON)</label>
479
- <textarea name="geometry" id="geometry" rows="5"></textarea>
480
- </div>
481
466
  </template>
482
467
 
483
468
  <template data-action="setCustomValidity">
@@ -496,15 +481,11 @@
496
481
 
497
482
  <template data-action="setFilter" data-common="filter"></template>
498
483
 
499
- <template data-action="createGeometry" data-common="map,disabledUiFeatures,filter">
484
+ <template data-action="createGeometry" data-common="additionalLayers,extentStrategy,map,disabledUiFeatures,filter">
500
485
  <div>
501
486
  <label for="embeddingTargetId">Embedding target ID of the map view *</label>
502
487
  <input name="embeddingTargetId" id="embeddingTargetId" required>
503
488
  </div>
504
- <div>
505
- <label for="geometry">Additional layers (GeoJSON)</label>
506
- <textarea name="additionalLayers" id="additionalLayers" rows="10"></textarea>
507
- </div>
508
489
  <div>
509
490
  <label for="geometryType">Geometry type</label>
510
491
  <select name="geometryType" id="geometryType">
@@ -528,18 +509,30 @@
528
509
  </div>
529
510
  </template>
530
511
 
531
- <template data-action="editGeometry" data-common="zoomTo,map,disabledUiFeatures,filter">
512
+ <template data-action="editGeometry" data-common="extentStrategy,map,disabledUiFeatures,filter">
532
513
  <div>
533
514
  <label for="embeddingTargetId">Embedding target ID of the map view *</label>
534
515
  <input name="embeddingTargetId" id="embeddingTargetId" required>
535
516
  </div>
536
- <div>
537
- <label for="geometry">Additional layers (GeoJSON)</label>
538
- <textarea name="additionalLayers" id="additionalLayers" rows="10"></textarea>
539
- </div>
540
517
  <div>
541
518
  <label for="geometry">Geometry (GeoJSON) *</label>
542
519
  <textarea name="geometry" id="geometry" rows="5" required></textarea>
520
+ <small>
521
+ <strong>Example:</strong>
522
+ <pre>
523
+ {
524
+ "coordinates":[
525
+ [
526
+ [9.598504509838506,52.70992820638244],
527
+ [8.899110702389294,51.72257425885121],
528
+ [10.906499617840836,51.725944168909365],
529
+ [9.598504509838506,52.70992820638244]
530
+ ]
531
+ ],
532
+ "type":"Polygon"
533
+ }
534
+ </pre>
535
+ </small>
543
536
  </div>
544
537
  <div>
545
538
  <label>
@@ -553,7 +546,7 @@
553
546
  </div>
554
547
  </template>
555
548
 
556
- <template data-action="selectObjects" data-common="map,filter">
549
+ <template data-action="selectObjects" data-common="extentStrategy,map,filter">
557
550
  <div>
558
551
  <label for="embeddingTargetId">Embedding target ID of the map view *</label>
559
552
  <input name="embeddingTargetId" id="embeddingTargetId" required>
@@ -622,12 +615,107 @@
622
615
  </div>
623
616
  </template>
624
617
 
625
- <template id="common-zoomTo">
618
+ <template id="common-additionalLayers">
626
619
  <div>
627
- <label>
628
- <input type="checkbox" name="zoomToGeometry">
629
- Zoom to geometry
630
- </label>
620
+ <label for="geometry">Additional layers (GeoJSON)</label>
621
+ <textarea name="additionalLayers" id="additionalLayers" rows="10"></textarea>
622
+ <small>
623
+ <strong>Example:</strong>
624
+ <pre>
625
+ [
626
+ {
627
+ "type":"geojson",
628
+ "name":"freiburg",
629
+ "content":{
630
+ "type":"FeatureCollection",
631
+ "features":[
632
+ {
633
+ "type":"Feature",
634
+ "properties":{},
635
+ "geometry":{
636
+ "coordinates":[
637
+ [
638
+ [7.965977481550681,47.93787211649922],
639
+ [7.903787681150362,47.64741821336713],
640
+ [8.310793134690243,47.70344757260733],
641
+ [7.965977481550681,47.93787211649922]
642
+ ]
643
+ ],
644
+ "type":"Polygon"
645
+ }
646
+ }
647
+ ]
648
+ }
649
+ }
650
+ ]
651
+ </pre>
652
+ </small>
653
+ </div>
654
+ <div>
655
+ <label for="geometry">Geometry (GeoJSON)</label>
656
+ <textarea name="geometry" id="geometry" rows="5"></textarea>
657
+ <small>
658
+ <strong>Example:</strong>
659
+ <pre>
660
+ {
661
+ "coordinates":[
662
+ [
663
+ [9.598504509838506,52.70992820638244],
664
+ [8.899110702389294,51.72257425885121],
665
+ [10.906499617840836,51.725944168909365],
666
+ [9.598504509838506,52.70992820638244]
667
+ ]
668
+ ],
669
+ "type":"Polygon"
670
+ }
671
+ </pre>
672
+ </small>
673
+ </div>
674
+ </template>
675
+
676
+ <template id="common-extentStrategy">
677
+ <div>
678
+ <label for="extentStrategy">Extent Strategy</label>
679
+ <textarea name="extentStrategy" id="extentStrategy" rows="5"></textarea>
680
+ <small>
681
+ <p>Optional JSON Object</p>
682
+ <p>
683
+ Hints for some types:
684
+ <ul>
685
+ <li>'geometry' of 'geometry': GeoJSON geometry</li>
686
+ <li>'extent' of 'static': [minX,minY,maxX,maxY]</li>
687
+ </ul>
688
+ </p>
689
+ <p>
690
+ Supported extent strategies as examples to use:
691
+ <ul>
692
+ <li><pre>{
693
+ "type": "geometry",
694
+ "geometry": {
695
+ "coordinates":[[
696
+ [9.598504509838506,52.70992820638244],
697
+ [8.899110702389294,51.72257425885121],
698
+ [10.906499617840836,51.725944168909365],
699
+ [9.598504509838506,52.70992820638244]]],
700
+ "type":"Polygon"
701
+ }
702
+ }</pre></li>
703
+ <li><pre>{
704
+ "type": "locationFinder",
705
+ "query": "Hamburg"
706
+ }</pre></li>
707
+ <li><pre>{
708
+ "type": "static",
709
+ "extent": [9.585571,53.38169,10.483704,53.859007]
710
+ }</pre></li>
711
+ <li><pre>{"type": "layerData"}</pre></li>
712
+ <li><pre>{
713
+ "type": "layerData",
714
+ "layers": ["Messstellen", ["Gewässer", "Gewässername"]]
715
+ }</pre></li>
716
+ </ul>
717
+ </p>
718
+ </small>
631
719
  </div>
632
720
  </template>
633
721
 
@@ -1,4 +0,0 @@
1
- <!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>GeometryZoomTarget | Cadenza JS - v10.2.1</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.1</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="GeometryZoomTarget.html">GeometryZoomTarget</a></li></ul><h1>Interface GeometryZoomTarget</h1></div><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><p>Instructs Cadenza to zoom to a provided {@Link Geometry}</p>
2
- </div><div class="tsd-comment tsd-typography"></div></section><div class="tsd-signature"><span class="tsd-signature-keyword">interface </span><span class="tsd-kind-interface">GeometryZoomTarget</span> <span class="tsd-signature-symbol">{ </span><br/><span>    </span><a class="tsd-kind-property" href="GeometryZoomTarget.html#type">type</a><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">&quot;geometry&quot;</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/fa74229ebaab18f488d5f235113de6d602bd9032/src/cadenza.js#L136">src/cadenza.js:136</a></li></ul></aside><section class="tsd-panel-group tsd-index-group"><section class="tsd-panel tsd-index-panel"><details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex="0"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../assets/icons.svg#icon-chevronSmall"></use></svg> Index</h5></summary><div class="tsd-accordion-details"><section class="tsd-index-section"><h3 class="tsd-index-heading">Properties</h3><div class="tsd-index-list"><a href="GeometryZoomTarget.html#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a>
3
- </div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Properties</h2><section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">type</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;geometry&quot;</span></div><div class="tsd-comment tsd-typography"><p>The type of the zoom target</p>
4
- </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/fa74229ebaab18f488d5f235113de6d602bd9032/src/cadenza.js#L137">src/cadenza.js:137</a></li></ul></aside></section></section></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><details open class="tsd-index-accordion tsd-page-navigation"><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>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#type" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-1024"></use></svg><span>type</span></a></div></details></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.1</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>