@disy/cadenza.js 1.0.0 → 1.1.0
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 +11 -0
- package/README.md +54 -5
- package/apidoc/assets/highlight.css +22 -22
- package/apidoc/assets/search.js +1 -1
- package/apidoc/classes/AbortError.html +7 -2
- package/apidoc/classes/CadenzaClient.html +258 -63
- package/apidoc/classes/CadenzaError.html +9 -4
- package/apidoc/functions/cadenza.html +13 -3
- package/apidoc/index.html +43 -18
- package/apidoc/interfaces/CadenzaEvent.html +8 -3
- package/apidoc/interfaces/ExternalLinkKey.html +103 -0
- package/apidoc/interfaces/Geometry.html +7 -2
- package/apidoc/interfaces/WorkbookKey.html +8 -3
- package/apidoc/interfaces/WorkbookViewKey.html +9 -4
- package/apidoc/interfaces/WorksheetKey.html +9 -4
- package/apidoc/modules.html +10 -0
- package/apidoc/types/CadenzaErrorEvent.html +6 -1
- package/apidoc/types/EmbeddingTargetId.html +6 -1
- package/apidoc/types/Extent.html +6 -1
- package/apidoc/types/GeometryType.html +6 -1
- package/apidoc/types/GlobalId.html +65 -0
- package/apidoc/types/MediaType.html +66 -0
- package/apidoc/types/OperationMode.html +65 -0
- package/apidoc/types/UiFeature.html +70 -0
- package/apidoc/types/WorkbookSource.html +6 -1
- package/apidoc/types/WorkbookViewSource.html +6 -1
- package/apidoc/types/WorksheetSource.html +6 -1
- package/cadenza.d.ts +130 -20
- package/cadenza.js +264 -93
- package/package.json +12 -5
- package/sandbox.html +342 -0
|
@@ -31,7 +31,7 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
|
|
|
31
31
|
<ul class="tsd-hierarchy">
|
|
32
32
|
<li><span class="target">CadenzaClient</span></li></ul></section><aside class="tsd-sources">
|
|
33
33
|
<ul>
|
|
34
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
34
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L86">src/cadenza.js:86</a></li></ul></aside>
|
|
35
35
|
<section class="tsd-panel-group tsd-index-group">
|
|
36
36
|
<section class="tsd-panel tsd-index-panel">
|
|
37
37
|
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
|
|
@@ -45,6 +45,7 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
|
|
|
45
45
|
<a href="CadenzaClient.html#_iframeElement" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>#iframe<wbr/>Element</span></a>
|
|
46
46
|
<a href="CadenzaClient.html#_origin" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>#origin</span></a>
|
|
47
47
|
<a href="CadenzaClient.html#_subscriptions" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>#subscriptions</span></a>
|
|
48
|
+
<a href="CadenzaClient.html#_webApplication" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>#web<wbr/>Application</span></a>
|
|
48
49
|
</div></section>
|
|
49
50
|
<section class="tsd-index-section">
|
|
50
51
|
<h3 class="tsd-index-heading">Accessors</h3>
|
|
@@ -54,13 +55,18 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
|
|
|
54
55
|
</div></section>
|
|
55
56
|
<section class="tsd-index-section">
|
|
56
57
|
<h3 class="tsd-index-heading">Methods</h3>
|
|
57
|
-
<div class="tsd-index-list"><a href="CadenzaClient.html#
|
|
58
|
+
<div class="tsd-index-list"><a href="CadenzaClient.html#_createUrl" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><g id="icon-2048"><rect fill="var(--color-icon-background)" stroke="#FF4DB8" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12"></rect><path d="M9.162 16V7.24H10.578L11.514 10.072C11.602 10.328 11.674 10.584 11.73 10.84C11.794 11.088 11.842 11.28 11.874 11.416C11.906 11.28 11.954 11.088 12.018 10.84C12.082 10.584 12.154 10.324 12.234 10.06L13.122 7.24H14.538V16H13.482V12.82C13.482 12.468 13.49 12.068 13.506 11.62C13.53 11.172 13.558 10.716 13.59 10.252C13.622 9.78 13.654 9.332 13.686 8.908C13.726 8.476 13.762 8.1 13.794 7.78L12.366 12.16H11.334L9.894 7.78C9.934 8.092 9.97 8.456 10.002 8.872C10.042 9.28 10.078 9.716 10.11 10.18C10.142 10.636 10.166 11.092 10.182 11.548C10.206 12.004 10.218 12.428 10.218 12.82V16H9.162Z" fill="var(--color-text)"></path></g></svg><span>#create<wbr/>Url</span></a>
|
|
59
|
+
<a href="CadenzaClient.html#_download" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>#download</span></a>
|
|
60
|
+
<a href="CadenzaClient.html#_fetch" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>#fetch</span></a>
|
|
61
|
+
<a href="CadenzaClient.html#_getIframePromise" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>#get<wbr/>Iframe<wbr/>Promise</span></a>
|
|
58
62
|
<a href="CadenzaClient.html#_log" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>#log</span></a>
|
|
59
63
|
<a href="CadenzaClient.html#_onMessage" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>#on<wbr/>Message</span></a>
|
|
60
64
|
<a href="CadenzaClient.html#_postEvent" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>#post<wbr/>Event</span></a>
|
|
61
65
|
<a href="CadenzaClient.html#_show" class="tsd-index-link tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>#show</span></a>
|
|
62
66
|
<a href="CadenzaClient.html#createGeometry" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>Geometry</span></a>
|
|
67
|
+
<a href="CadenzaClient.html#downloadData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>download<wbr/>Data</span></a>
|
|
63
68
|
<a href="CadenzaClient.html#editGeometry" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>edit<wbr/>Geometry</span></a>
|
|
69
|
+
<a href="CadenzaClient.html#fetchData" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>fetch<wbr/>Data</span></a>
|
|
64
70
|
<a href="CadenzaClient.html#on" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on</span></a>
|
|
65
71
|
<a href="CadenzaClient.html#show" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>show</span></a>
|
|
66
72
|
<a href="CadenzaClient.html#showMap" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>show<wbr/>Map</span></a>
|
|
@@ -72,37 +78,43 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
|
|
|
72
78
|
<div class="tsd-signature"><span class="tsd-kind-property">#base<wbr/>Url</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
73
79
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
74
80
|
<ul>
|
|
75
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
81
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L88">src/cadenza.js:88</a></li></ul></aside></section>
|
|
76
82
|
<section class="tsd-panel tsd-member tsd-is-private"><a id="_debug" class="tsd-anchor"></a>
|
|
77
83
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#debug</span><a href="#_debug" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
78
84
|
<div class="tsd-signature"><span class="tsd-kind-property">#debug</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
79
85
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
80
86
|
<ul>
|
|
81
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
87
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L103">src/cadenza.js:103</a></li></ul></aside></section>
|
|
82
88
|
<section class="tsd-panel tsd-member tsd-is-private"><a id="_iframe" class="tsd-anchor"></a>
|
|
83
89
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#iframe</span><a href="#_iframe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
84
90
|
<div class="tsd-signature"><span class="tsd-kind-property">#iframe</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">HTMLIFrameElement</span></div>
|
|
85
91
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
86
92
|
<ul>
|
|
87
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
93
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L94">src/cadenza.js:94</a></li></ul></aside></section>
|
|
88
94
|
<section class="tsd-panel tsd-member tsd-is-private"><a id="_iframeElement" class="tsd-anchor"></a>
|
|
89
95
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#iframe<wbr/>Element</span><a href="#_iframeElement" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
90
96
|
<div class="tsd-signature"><span class="tsd-kind-property">#iframe<wbr/>Element</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">HTMLIFrameElement</span></div>
|
|
91
97
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
92
98
|
<ul>
|
|
93
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
99
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L100">src/cadenza.js:100</a></li></ul></aside></section>
|
|
94
100
|
<section class="tsd-panel tsd-member tsd-is-private"><a id="_origin" class="tsd-anchor"></a>
|
|
95
101
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#origin</span><a href="#_origin" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
96
102
|
<div class="tsd-signature"><span class="tsd-kind-property">#origin</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
97
103
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
98
104
|
<ul>
|
|
99
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
105
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L91">src/cadenza.js:91</a></li></ul></aside></section>
|
|
100
106
|
<section class="tsd-panel tsd-member tsd-is-private"><a id="_subscriptions" class="tsd-anchor"></a>
|
|
101
107
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#subscriptions</span><a href="#_subscriptions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
102
108
|
<div class="tsd-signature"><span class="tsd-kind-property">#subscriptions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">event</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div>
|
|
103
109
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
104
110
|
<ul>
|
|
105
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
111
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L106">src/cadenza.js:106</a></li></ul></aside></section>
|
|
112
|
+
<section class="tsd-panel tsd-member tsd-is-private"><a id="_webApplication" class="tsd-anchor"></a>
|
|
113
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <code class="tsd-tag ts-flagReadonly">Readonly</code> <span>#web<wbr/>Application</span><a href="#_webApplication" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
114
|
+
<div class="tsd-signature"><span class="tsd-kind-property">#web<wbr/>Application</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/ExternalLinkKey.html" class="tsd-signature-type tsd-kind-interface">ExternalLinkKey</a></div>
|
|
115
|
+
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
116
|
+
<ul>
|
|
117
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L97">src/cadenza.js:97</a></li></ul></aside></section></section>
|
|
106
118
|
<section class="tsd-panel-group tsd-member-group">
|
|
107
119
|
<h2>Accessors</h2>
|
|
108
120
|
<section class="tsd-panel tsd-member tsd-is-private"><a id="_requiredIframe" class="tsd-anchor"></a>
|
|
@@ -112,7 +124,7 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
|
|
|
112
124
|
<li class="tsd-description">
|
|
113
125
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">HTMLIFrameElement</span></h4><aside class="tsd-sources">
|
|
114
126
|
<ul>
|
|
115
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
127
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L158">src/cadenza.js:158</a></li></ul></aside></li></ul></section>
|
|
116
128
|
<section class="tsd-panel tsd-member"><a id="baseUrl" class="tsd-anchor"></a>
|
|
117
129
|
<h3 class="tsd-anchor-link"><span>base<wbr/>Url</span><a href="#baseUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
118
130
|
<ul class="tsd-signatures">
|
|
@@ -123,7 +135,7 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
|
|
|
123
135
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
|
124
136
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
125
137
|
<ul>
|
|
126
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
138
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L140">src/cadenza.js:140</a></li></ul></aside></li></ul></section>
|
|
127
139
|
<section class="tsd-panel tsd-member"><a id="iframe" class="tsd-anchor"></a>
|
|
128
140
|
<h3 class="tsd-anchor-link"><span>iframe</span><a href="#iframe" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
129
141
|
<ul class="tsd-signatures">
|
|
@@ -134,24 +146,78 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
|
|
|
134
146
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">HTMLIFrameElement</span></h4>
|
|
135
147
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
136
148
|
<ul>
|
|
137
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
149
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L145">src/cadenza.js:145</a></li></ul></aside></li></ul></section></section>
|
|
138
150
|
<section class="tsd-panel-group tsd-member-group">
|
|
139
151
|
<h2>Methods</h2>
|
|
152
|
+
<section class="tsd-panel tsd-member tsd-is-private"><a id="_createUrl" class="tsd-anchor"></a>
|
|
153
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#create<wbr/>Url</span><a href="#_createUrl" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
154
|
+
<ul class="tsd-signatures tsd-is-private">
|
|
155
|
+
<li class="tsd-signature tsd-anchor-link" id="_createUrl._createUrl-1"><span class="tsd-kind-call-signature">#create<wbr/>Url</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">URL</span><a href="#_createUrl._createUrl-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
156
|
+
<li class="tsd-description">
|
|
157
|
+
<div class="tsd-parameters">
|
|
158
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
159
|
+
<ul class="tsd-parameter-list">
|
|
160
|
+
<li>
|
|
161
|
+
<h5><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></h5></li>
|
|
162
|
+
<li>
|
|
163
|
+
<h5><span class="tsd-kind-parameter">params</span>: <span class="tsd-signature-type ">URLSearchParams</span></h5></li></ul></div>
|
|
164
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">URL</span></h4><aside class="tsd-sources">
|
|
165
|
+
<ul>
|
|
166
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L525">src/cadenza.js:525</a></li></ul></aside></li></ul></section>
|
|
167
|
+
<section class="tsd-panel tsd-member tsd-is-private"><a id="_download" class="tsd-anchor"></a>
|
|
168
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#download</span><a href="#_download" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
169
|
+
<ul class="tsd-signatures tsd-is-private">
|
|
170
|
+
<li class="tsd-signature tsd-anchor-link" id="_download._download-1"><span class="tsd-kind-call-signature">#download</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#_download._download-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
171
|
+
<li class="tsd-description">
|
|
172
|
+
<div class="tsd-parameters">
|
|
173
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
174
|
+
<ul class="tsd-parameter-list">
|
|
175
|
+
<li>
|
|
176
|
+
<h5><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></h5></li>
|
|
177
|
+
<li>
|
|
178
|
+
<h5><span class="tsd-kind-parameter">params</span>: <span class="tsd-signature-type ">URLSearchParams</span></h5></li></ul></div>
|
|
179
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
180
|
+
<ul>
|
|
181
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L513">src/cadenza.js:513</a></li></ul></aside></li></ul></section>
|
|
182
|
+
<section class="tsd-panel tsd-member tsd-is-private"><a id="_fetch" class="tsd-anchor"></a>
|
|
183
|
+
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#fetch</span><a href="#_fetch" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
184
|
+
<ul class="tsd-signatures tsd-is-private">
|
|
185
|
+
<li class="tsd-signature tsd-anchor-link" id="_fetch._fetch-1"><span class="tsd-kind-call-signature">#fetch</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">params</span>, <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Response</span><span class="tsd-signature-symbol">></span><a href="#_fetch._fetch-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
186
|
+
<li class="tsd-description">
|
|
187
|
+
<div class="tsd-parameters">
|
|
188
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
189
|
+
<ul class="tsd-parameter-list">
|
|
190
|
+
<li>
|
|
191
|
+
<h5><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></h5>
|
|
192
|
+
<div class="tsd-comment tsd-typography">
|
|
193
|
+
<h4>Type</h4><p>string</p>
|
|
194
|
+
</div></li>
|
|
195
|
+
<li>
|
|
196
|
+
<h5><span class="tsd-kind-parameter">params</span>: <span class="tsd-signature-type ">URLSearchParams</span></h5>
|
|
197
|
+
<div class="tsd-comment tsd-typography">
|
|
198
|
+
<h4>Type</h4><p>URLSearchParams</p>
|
|
199
|
+
</div></li>
|
|
200
|
+
<li>
|
|
201
|
+
<h5><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">AbortSignal</span></h5>
|
|
202
|
+
<div class="tsd-comment tsd-typography">
|
|
203
|
+
<h4>Type</h4><p>AbortSignal | undefined</p>
|
|
204
|
+
</div></li></ul></div>
|
|
205
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Response</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
206
|
+
<ul>
|
|
207
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L471">src/cadenza.js:471</a></li></ul></aside></li></ul></section>
|
|
140
208
|
<section class="tsd-panel tsd-member tsd-is-private"><a id="_getIframePromise" class="tsd-anchor"></a>
|
|
141
209
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#get<wbr/>Iframe<wbr/>Promise</span><a href="#_getIframePromise" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
142
210
|
<ul class="tsd-signatures tsd-is-private">
|
|
143
|
-
<li class="tsd-signature tsd-anchor-link" id="_getIframePromise._getIframePromise-1"><span class="tsd-kind-call-signature">#get<wbr/>Iframe<wbr/>Promise</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol"
|
|
211
|
+
<li class="tsd-signature tsd-anchor-link" id="_getIframePromise._getIframePromise-1"><span class="tsd-kind-call-signature">#get<wbr/>Iframe<wbr/>Promise</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#_getIframePromise._getIframePromise-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
144
212
|
<li class="tsd-description">
|
|
145
213
|
<div class="tsd-parameters">
|
|
146
214
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
147
215
|
<ul class="tsd-parameter-list">
|
|
148
216
|
<li>
|
|
149
|
-
<h5><
|
|
150
|
-
<
|
|
151
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
152
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
217
|
+
<h5><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">AbortSignal</span></h5></li></ul></div>
|
|
218
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
153
219
|
<ul>
|
|
154
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
220
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L348">src/cadenza.js:348</a></li></ul></aside></li></ul></section>
|
|
155
221
|
<section class="tsd-panel tsd-member tsd-is-private"><a id="_log" class="tsd-anchor"></a>
|
|
156
222
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#log</span><a href="#_log" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
157
223
|
<ul class="tsd-signatures tsd-is-private">
|
|
@@ -161,12 +227,10 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
|
|
|
161
227
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
162
228
|
<ul class="tsd-parameter-list">
|
|
163
229
|
<li>
|
|
164
|
-
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span></h5>
|
|
165
|
-
<
|
|
166
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
167
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
230
|
+
<h5><code class="tsd-tag ts-flagRest">Rest</code> <span class="tsd-signature-symbol">...</span><span class="tsd-kind-parameter">args</span>: <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">[]</span></h5></li></ul></div>
|
|
231
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
168
232
|
<ul>
|
|
169
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
233
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L535">src/cadenza.js:535</a></li></ul></aside></li></ul></section>
|
|
170
234
|
<section class="tsd-panel tsd-member tsd-is-private"><a id="_onMessage" class="tsd-anchor"></a>
|
|
171
235
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#on<wbr/>Message</span><a href="#_onMessage" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
172
236
|
<ul class="tsd-signatures tsd-is-private">
|
|
@@ -176,12 +240,10 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
|
|
|
176
240
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
177
241
|
<ul class="tsd-parameter-list">
|
|
178
242
|
<li>
|
|
179
|
-
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type ">MessageEvent</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/CadenzaEvent.html" class="tsd-signature-type tsd-kind-interface">CadenzaEvent</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5>
|
|
180
|
-
<
|
|
181
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
182
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
243
|
+
<h5><span class="tsd-kind-parameter">event</span>: <span class="tsd-signature-type ">MessageEvent</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/CadenzaEvent.html" class="tsd-signature-type tsd-kind-interface">CadenzaEvent</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">never</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h5></li></ul></div>
|
|
244
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
183
245
|
<ul>
|
|
184
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
246
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L424">src/cadenza.js:424</a></li></ul></aside></li></ul></section>
|
|
185
247
|
<section class="tsd-panel tsd-member tsd-is-private"><a id="_postEvent" class="tsd-anchor"></a>
|
|
186
248
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#post<wbr/>Event</span><a href="#_postEvent" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
187
249
|
<ul class="tsd-signatures tsd-is-private">
|
|
@@ -191,40 +253,38 @@ When aborted, the result Promise is rejected with an <a href="AbortError.html" c
|
|
|
191
253
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
192
254
|
<ul class="tsd-parameter-list">
|
|
193
255
|
<li>
|
|
194
|
-
<h5><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></h5>
|
|
195
|
-
<div class="tsd-comment tsd-typography"></div></li>
|
|
256
|
+
<h5><span class="tsd-kind-parameter">type</span>: <span class="tsd-signature-type">string</span></h5></li>
|
|
196
257
|
<li>
|
|
197
|
-
<h5><span class="tsd-kind-parameter">detail</span>: <span class="tsd-signature-type">unknown</span></h5>
|
|
198
|
-
<
|
|
199
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
200
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
258
|
+
<h5><span class="tsd-kind-parameter">detail</span>: <span class="tsd-signature-type">unknown</span></h5></li></ul></div>
|
|
259
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><aside class="tsd-sources">
|
|
201
260
|
<ul>
|
|
202
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
261
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L441">src/cadenza.js:441</a></li></ul></aside></li></ul></section>
|
|
203
262
|
<section class="tsd-panel tsd-member tsd-is-private"><a id="_show" class="tsd-anchor"></a>
|
|
204
263
|
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>#show</span><a href="#_show" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
205
264
|
<ul class="tsd-signatures tsd-is-private">
|
|
206
|
-
<li class="tsd-signature tsd-anchor-link" id="_show._show-1"><span class="tsd-kind-call-signature">#show</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">
|
|
265
|
+
<li class="tsd-signature tsd-anchor-link" id="_show._show-1"><span class="tsd-kind-call-signature">#show</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">path</span>, <span class="tsd-kind-parameter">params</span>, <span class="tsd-kind-parameter">signal</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#_show._show-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
207
266
|
<li class="tsd-description">
|
|
208
267
|
<div class="tsd-parameters">
|
|
209
268
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
210
269
|
<ul class="tsd-parameter-list">
|
|
211
270
|
<li>
|
|
212
271
|
<h5><span class="tsd-kind-parameter">path</span>: <span class="tsd-signature-type">string</span></h5>
|
|
213
|
-
<div class="tsd-comment tsd-typography"
|
|
272
|
+
<div class="tsd-comment tsd-typography">
|
|
273
|
+
<h4>Type</h4><p>string</p>
|
|
274
|
+
</div></li>
|
|
214
275
|
<li>
|
|
215
|
-
<h5><span class="tsd-kind-parameter">
|
|
216
|
-
<div class="tsd-comment tsd-typography"
|
|
217
|
-
<
|
|
218
|
-
|
|
219
|
-
<
|
|
220
|
-
<
|
|
221
|
-
<
|
|
222
|
-
<
|
|
223
|
-
|
|
224
|
-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
225
|
-
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
276
|
+
<h5><span class="tsd-kind-parameter">params</span>: <span class="tsd-signature-type ">URLSearchParams</span></h5>
|
|
277
|
+
<div class="tsd-comment tsd-typography">
|
|
278
|
+
<h4>Type</h4><p>URLSearchParams</p>
|
|
279
|
+
</div></li>
|
|
280
|
+
<li>
|
|
281
|
+
<h5><span class="tsd-kind-parameter">signal</span>: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">AbortSignal</span></h5>
|
|
282
|
+
<div class="tsd-comment tsd-typography">
|
|
283
|
+
<h4>Type</h4><p>AbortSignal | undefined</p>
|
|
284
|
+
</div></li></ul></div>
|
|
285
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><aside class="tsd-sources">
|
|
226
286
|
<ul>
|
|
227
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
287
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L337">src/cadenza.js:337</a></li></ul></aside></li></ul></section>
|
|
228
288
|
<section class="tsd-panel tsd-member"><a id="createGeometry" class="tsd-anchor"></a>
|
|
229
289
|
<h3 class="tsd-anchor-link"><span>create<wbr/>Geometry</span><a href="#createGeometry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
230
290
|
<ul class="tsd-signatures">
|
|
@@ -281,7 +341,7 @@ That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
|
281
341
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>A Promise for when the iframe is loaded</p>
|
|
282
342
|
|
|
283
343
|
<div class="tsd-comment tsd-typography">
|
|
284
|
-
<h4>Throws</h4><p>For
|
|
344
|
+
<h4>Throws</h4><p>For invalid arguments</p>
|
|
285
345
|
|
|
286
346
|
<h4>Fires</h4><p><code>editGeometry:update</code> - When the user changed the geometry. The event includes the edited geometry.</p>
|
|
287
347
|
|
|
@@ -290,7 +350,51 @@ That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
|
290
350
|
<h4>Fires</h4><p><code>editGeometry:cancel</code> - When the user cancelled the geometry editing in Cadenza.</p>
|
|
291
351
|
</div><aside class="tsd-sources">
|
|
292
352
|
<ul>
|
|
293
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
353
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L283">src/cadenza.js:283</a></li></ul></aside></li></ul></section>
|
|
354
|
+
<section class="tsd-panel tsd-member"><a id="downloadData" class="tsd-anchor"></a>
|
|
355
|
+
<h3 class="tsd-anchor-link"><span>download<wbr/>Data</span><a href="#downloadData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
356
|
+
<ul class="tsd-signatures">
|
|
357
|
+
<li class="tsd-signature tsd-anchor-link" id="downloadData.downloadData-1"><span class="tsd-kind-call-signature">download<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span>, <span class="tsd-kind-parameter">mediaType</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><a href="#downloadData.downloadData-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
358
|
+
<li class="tsd-description">
|
|
359
|
+
<div class="tsd-comment tsd-typography"><p>Download data from a workbook view.</p>
|
|
360
|
+
<p><em>Note:</em> The file name, if not provided, is generated from the name of the workbook view and the current date.</p>
|
|
361
|
+
</div>
|
|
362
|
+
<div class="tsd-parameters">
|
|
363
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
364
|
+
<ul class="tsd-parameter-list">
|
|
365
|
+
<li>
|
|
366
|
+
<h5><span class="tsd-kind-parameter">source</span>: <a href="../types/WorkbookViewSource.html" class="tsd-signature-type tsd-kind-type-alias">WorkbookViewSource</a></h5>
|
|
367
|
+
<div class="tsd-comment tsd-typography"><p>The workbook view to download data from</p>
|
|
368
|
+
</div>
|
|
369
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
370
|
+
<li>
|
|
371
|
+
<h5><span class="tsd-kind-parameter">mediaType</span>: <span class="tsd-signature-type">string</span></h5>
|
|
372
|
+
<div class="tsd-comment tsd-typography"><p>The media type to use for the data. Allowed are:</p>
|
|
373
|
+
<ul>
|
|
374
|
+
<li>'application/json'</li>
|
|
375
|
+
<li>'application/pdf' (for Jasper Report views)</li>
|
|
376
|
+
<li>'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' (Excel)</li>
|
|
377
|
+
<li>'text/csv'</li>
|
|
378
|
+
</ul>
|
|
379
|
+
</div>
|
|
380
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
381
|
+
<li>
|
|
382
|
+
<h5><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">fileName</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h5>
|
|
383
|
+
<div class="tsd-comment tsd-typography"><p>Options</p>
|
|
384
|
+
</div>
|
|
385
|
+
<div class="tsd-comment tsd-typography"></div>
|
|
386
|
+
<ul class="tsd-parameters">
|
|
387
|
+
<li class="tsd-parameter">
|
|
388
|
+
<h5><span class="tsd-kind-property">file<wbr/>Name</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
|
389
|
+
<div class="tsd-comment tsd-typography"><p>The file name to use; The file extension is appended by Cadenza.</p>
|
|
390
|
+
</div>
|
|
391
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div>
|
|
392
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
393
|
+
<div class="tsd-comment tsd-typography">
|
|
394
|
+
<h4>Throws</h4><p>For invalid arguments</p>
|
|
395
|
+
</div><aside class="tsd-sources">
|
|
396
|
+
<ul>
|
|
397
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L506">src/cadenza.js:506</a></li></ul></aside></li></ul></section>
|
|
294
398
|
<section class="tsd-panel tsd-member"><a id="editGeometry" class="tsd-anchor"></a>
|
|
295
399
|
<h3 class="tsd-anchor-link"><span>edit<wbr/>Geometry</span><a href="#editGeometry" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
296
400
|
<ul class="tsd-signatures">
|
|
@@ -345,7 +449,7 @@ That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
|
345
449
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>A Promise for when the iframe is loaded</p>
|
|
346
450
|
|
|
347
451
|
<div class="tsd-comment tsd-typography">
|
|
348
|
-
<h4>Throws</h4><p>For
|
|
452
|
+
<h4>Throws</h4><p>For invalid arguments</p>
|
|
349
453
|
|
|
350
454
|
<h4>Fires</h4><p><code>editGeometry:update</code> - When the user changed the geometry. The event includes the edited geometry.</p>
|
|
351
455
|
|
|
@@ -354,7 +458,51 @@ That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
|
354
458
|
<h4>Fires</h4><p><code>editGeometry:cancel</code> - When the user cancelled the geometry editing in Cadenza.</p>
|
|
355
459
|
</div><aside class="tsd-sources">
|
|
356
460
|
<ul>
|
|
357
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
461
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L318">src/cadenza.js:318</a></li></ul></aside></li></ul></section>
|
|
462
|
+
<section class="tsd-panel tsd-member"><a id="fetchData" class="tsd-anchor"></a>
|
|
463
|
+
<h3 class="tsd-anchor-link"><span>fetch<wbr/>Data</span><a href="#fetchData" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
464
|
+
<ul class="tsd-signatures">
|
|
465
|
+
<li class="tsd-signature tsd-anchor-link" id="fetchData.fetchData-1"><span class="tsd-kind-call-signature">fetch<wbr/>Data</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">source</span>, <span class="tsd-kind-parameter">mediaType</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Response</span><span class="tsd-signature-symbol">></span><a href="#fetchData.fetchData-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li>
|
|
466
|
+
<li class="tsd-description">
|
|
467
|
+
<div class="tsd-comment tsd-typography"><p>Fetch data from a workbook view.</p>
|
|
468
|
+
</div>
|
|
469
|
+
<div class="tsd-parameters">
|
|
470
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
471
|
+
<ul class="tsd-parameter-list">
|
|
472
|
+
<li>
|
|
473
|
+
<h5><span class="tsd-kind-parameter">source</span>: <a href="../types/WorkbookViewSource.html" class="tsd-signature-type tsd-kind-type-alias">WorkbookViewSource</a></h5>
|
|
474
|
+
<div class="tsd-comment tsd-typography"><p>The workbook view to fetch data from</p>
|
|
475
|
+
</div>
|
|
476
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
477
|
+
<li>
|
|
478
|
+
<h5><span class="tsd-kind-parameter">mediaType</span>: <span class="tsd-signature-type">string</span></h5>
|
|
479
|
+
<div class="tsd-comment tsd-typography"><p>The media type to use for the data. Allowed are:</p>
|
|
480
|
+
<ul>
|
|
481
|
+
<li>'application/json'</li>
|
|
482
|
+
<li>'application/pdf' (for Jasper Report views)</li>
|
|
483
|
+
<li>'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' (Excel)</li>
|
|
484
|
+
<li>'text/csv'</li>
|
|
485
|
+
</ul>
|
|
486
|
+
</div>
|
|
487
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
488
|
+
<li>
|
|
489
|
+
<h5><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">AbortSignal</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
|
490
|
+
<div class="tsd-comment tsd-typography"><p>Options</p>
|
|
491
|
+
</div>
|
|
492
|
+
<div class="tsd-comment tsd-typography"></div>
|
|
493
|
+
<ul class="tsd-parameters">
|
|
494
|
+
<li class="tsd-parameter">
|
|
495
|
+
<h5><span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">AbortSignal</span></h5>
|
|
496
|
+
<div class="tsd-comment tsd-typography"><p>A signal to abort the data fetching</p>
|
|
497
|
+
</div>
|
|
498
|
+
<div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div>
|
|
499
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">Response</span><span class="tsd-signature-symbol">></span></h4><p>A Promise for the fetch response</p>
|
|
500
|
+
|
|
501
|
+
<div class="tsd-comment tsd-typography">
|
|
502
|
+
<h4>Throws</h4><p>For invalid arguments</p>
|
|
503
|
+
</div><aside class="tsd-sources">
|
|
504
|
+
<ul>
|
|
505
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L464">src/cadenza.js:464</a></li></ul></aside></li></ul></section>
|
|
358
506
|
<section class="tsd-panel tsd-member"><a id="on" class="tsd-anchor"></a>
|
|
359
507
|
<h3 class="tsd-anchor-link"><span>on</span><a href="#on" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
360
508
|
<ul class="tsd-signatures">
|
|
@@ -402,7 +550,7 @@ That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
|
402
550
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4></li></ul></li></ul>
|
|
403
551
|
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources">
|
|
404
552
|
<ul>
|
|
405
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
553
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L401">src/cadenza.js:401</a></li></ul></aside></li></ul></section>
|
|
406
554
|
<section class="tsd-panel tsd-member"><a id="show" class="tsd-anchor"></a>
|
|
407
555
|
<h3 class="tsd-anchor-link"><span>show</span><a href="#show" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
408
556
|
<ul class="tsd-signatures">
|
|
@@ -419,17 +567,38 @@ That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
|
419
567
|
</div>
|
|
420
568
|
<div class="tsd-comment tsd-typography"></div></li>
|
|
421
569
|
<li>
|
|
422
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">hideMainHeaderAndFooter</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">hideWorkbookToolBar</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">AbortSignal</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
|
570
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">disabledUiFeatures</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/UiFeature.html" class="tsd-signature-type tsd-kind-type-alias">UiFeature</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">hideMainHeaderAndFooter</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">hideWorkbookToolBar</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">highlightGlobalId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">mediaType</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">operationMode</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/OperationMode.html" class="tsd-signature-type tsd-kind-type-alias">OperationMode</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">AbortSignal</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
|
423
571
|
<div class="tsd-comment tsd-typography"></div>
|
|
424
572
|
<ul class="tsd-parameters">
|
|
425
573
|
<li class="tsd-parameter">
|
|
574
|
+
<h5><span class="tsd-kind-property">disabled<wbr/>Ui<wbr/>Features</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/UiFeature.html" class="tsd-signature-type tsd-kind-type-alias">UiFeature</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
575
|
+
<div class="tsd-comment tsd-typography"><p>Cadenza UI features to disable</p>
|
|
576
|
+
</div>
|
|
577
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
578
|
+
<li class="tsd-parameter">
|
|
426
579
|
<h5><span class="tsd-kind-property">hide<wbr/>Main<wbr/>Header<wbr/>And<wbr/>Footer</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h5>
|
|
427
|
-
<div class="tsd-comment tsd-typography"><p>Whether to hide the main Cadenza header and footer
|
|
580
|
+
<div class="tsd-comment tsd-typography"><p>Whether to hide the main Cadenza header and footer</p>
|
|
428
581
|
</div>
|
|
429
582
|
<div class="tsd-comment tsd-typography"></div></li>
|
|
430
583
|
<li class="tsd-parameter">
|
|
431
584
|
<h5><span class="tsd-kind-property">hide<wbr/>Workbook<wbr/>Tool<wbr/>Bar</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h5>
|
|
432
|
-
<div class="tsd-comment tsd-typography"><p>Whether to hide the workbook toolbar
|
|
585
|
+
<div class="tsd-comment tsd-typography"><p>Whether to hide the workbook toolbar</p>
|
|
586
|
+
</div>
|
|
587
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
588
|
+
<li class="tsd-parameter">
|
|
589
|
+
<h5><span class="tsd-kind-property">highlight<wbr/>Global<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
|
590
|
+
<div class="tsd-comment tsd-typography"><p>The ID of an item to highlight / expand in the navigator</p>
|
|
591
|
+
</div>
|
|
592
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
593
|
+
<li class="tsd-parameter">
|
|
594
|
+
<h5><span class="tsd-kind-property">media<wbr/>Type</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
|
595
|
+
<div class="tsd-comment tsd-typography"><p>Set to 'application/pdf' for views of type "JasperReports report"
|
|
596
|
+
to show the report PDF directly, without any Cadenza headers or footers.</p>
|
|
597
|
+
</div>
|
|
598
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
599
|
+
<li class="tsd-parameter">
|
|
600
|
+
<h5><span class="tsd-kind-property">operation<wbr/>Mode</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/OperationMode.html" class="tsd-signature-type tsd-kind-type-alias">OperationMode</a></h5>
|
|
601
|
+
<div class="tsd-comment tsd-typography"><p>The mode in which a workbook should be operated</p>
|
|
433
602
|
</div>
|
|
434
603
|
<div class="tsd-comment tsd-typography"></div></li>
|
|
435
604
|
<li class="tsd-parameter">
|
|
@@ -440,10 +609,10 @@ That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
|
440
609
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>A Promise for when the iframe is loaded</p>
|
|
441
610
|
|
|
442
611
|
<div class="tsd-comment tsd-typography">
|
|
443
|
-
<h4>Throws</h4><p>For
|
|
612
|
+
<h4>Throws</h4><p>For invalid arguments</p>
|
|
444
613
|
</div><aside class="tsd-sources">
|
|
445
614
|
<ul>
|
|
446
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
615
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L183">src/cadenza.js:183</a></li></ul></aside></li></ul></section>
|
|
447
616
|
<section class="tsd-panel tsd-member"><a id="showMap" class="tsd-anchor"></a>
|
|
448
617
|
<h3 class="tsd-anchor-link"><span>show<wbr/>Map</span><a href="#showMap" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
|
|
449
618
|
<ul class="tsd-signatures">
|
|
@@ -460,24 +629,34 @@ That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
|
460
629
|
</div>
|
|
461
630
|
<div class="tsd-comment tsd-typography"></div></li>
|
|
462
631
|
<li>
|
|
463
|
-
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">geometry</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Geometry.html" class="tsd-signature-type tsd-kind-interface">Geometry</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">hideMainHeaderAndFooter</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">hideWorkbookToolBar</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">locationFinder</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">mapExtent</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/Extent.html" class="tsd-signature-type tsd-kind-type-alias">Extent</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">AbortSignal</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useMapSrs</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
|
632
|
+
<h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">disabledUiFeatures</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/UiFeature.html" class="tsd-signature-type tsd-kind-type-alias">UiFeature</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">geometry</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Geometry.html" class="tsd-signature-type tsd-kind-interface">Geometry</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">hideMainHeaderAndFooter</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">hideWorkbookToolBar</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">highlightGlobalId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">locationFinder</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">mapExtent</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/Extent.html" class="tsd-signature-type tsd-kind-type-alias">Extent</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">operationMode</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/OperationMode.html" class="tsd-signature-type tsd-kind-type-alias">OperationMode</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">AbortSignal</span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">useMapSrs</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></h5>
|
|
464
633
|
<div class="tsd-comment tsd-typography"><p>Options</p>
|
|
465
634
|
</div>
|
|
466
635
|
<div class="tsd-comment tsd-typography"></div>
|
|
467
636
|
<ul class="tsd-parameters">
|
|
468
637
|
<li class="tsd-parameter">
|
|
638
|
+
<h5><span class="tsd-kind-property">disabled<wbr/>Ui<wbr/>Features</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/UiFeature.html" class="tsd-signature-type tsd-kind-type-alias">UiFeature</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
639
|
+
<div class="tsd-comment tsd-typography"><p>Cadenza UI features to disable</p>
|
|
640
|
+
</div>
|
|
641
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
642
|
+
<li class="tsd-parameter">
|
|
469
643
|
<h5><span class="tsd-kind-property">geometry</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Geometry.html" class="tsd-signature-type tsd-kind-interface">Geometry</a></h5>
|
|
470
644
|
<div class="tsd-comment tsd-typography"><p>A geometry to show on the map</p>
|
|
471
645
|
</div>
|
|
472
646
|
<div class="tsd-comment tsd-typography"></div></li>
|
|
473
647
|
<li class="tsd-parameter">
|
|
474
648
|
<h5><span class="tsd-kind-property">hide<wbr/>Main<wbr/>Header<wbr/>And<wbr/>Footer</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h5>
|
|
475
|
-
<div class="tsd-comment tsd-typography"><p>Whether to hide the main Cadenza header and footer
|
|
649
|
+
<div class="tsd-comment tsd-typography"><p>Whether to hide the main Cadenza header and footer</p>
|
|
476
650
|
</div>
|
|
477
651
|
<div class="tsd-comment tsd-typography"></div></li>
|
|
478
652
|
<li class="tsd-parameter">
|
|
479
653
|
<h5><span class="tsd-kind-property">hide<wbr/>Workbook<wbr/>Tool<wbr/>Bar</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></h5>
|
|
480
|
-
<div class="tsd-comment tsd-typography"><p>Whether to hide the workbook toolbar
|
|
654
|
+
<div class="tsd-comment tsd-typography"><p>Whether to hide the workbook toolbar</p>
|
|
655
|
+
</div>
|
|
656
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
657
|
+
<li class="tsd-parameter">
|
|
658
|
+
<h5><span class="tsd-kind-property">highlight<wbr/>Global<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
|
|
659
|
+
<div class="tsd-comment tsd-typography"><p>The ID of an item to highlight / expand in the navigator</p>
|
|
481
660
|
</div>
|
|
482
661
|
<div class="tsd-comment tsd-typography"></div></li>
|
|
483
662
|
<li class="tsd-parameter">
|
|
@@ -491,6 +670,11 @@ That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
|
491
670
|
</div>
|
|
492
671
|
<div class="tsd-comment tsd-typography"></div></li>
|
|
493
672
|
<li class="tsd-parameter">
|
|
673
|
+
<h5><span class="tsd-kind-property">operation<wbr/>Mode</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><a href="../types/OperationMode.html" class="tsd-signature-type tsd-kind-type-alias">OperationMode</a></h5>
|
|
674
|
+
<div class="tsd-comment tsd-typography"><p>The mode in which a workbook should be operated</p>
|
|
675
|
+
</div>
|
|
676
|
+
<div class="tsd-comment tsd-typography"></div></li>
|
|
677
|
+
<li class="tsd-parameter">
|
|
494
678
|
<h5><span class="tsd-kind-property">signal</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type ">AbortSignal</span></h5>
|
|
495
679
|
<div class="tsd-comment tsd-typography"><p>A signal to abort the iframe loading</p>
|
|
496
680
|
</div>
|
|
@@ -503,10 +687,10 @@ That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
|
503
687
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4><p>A Promise for when the iframe is loaded</p>
|
|
504
688
|
|
|
505
689
|
<div class="tsd-comment tsd-typography">
|
|
506
|
-
<h4>Throws</h4><p>For
|
|
690
|
+
<h4>Throws</h4><p>For invalid arguments</p>
|
|
507
691
|
</div><aside class="tsd-sources">
|
|
508
692
|
<ul>
|
|
509
|
-
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/
|
|
693
|
+
<li>Defined in <a href="https://github.com/DisyInformationssysteme/cadenza.js/blob/b4c918b/src/cadenza.js#L229">src/cadenza.js:229</a></li></ul></aside></li></ul></section></section></div>
|
|
510
694
|
<div class="col-sidebar">
|
|
511
695
|
<div class="page-menu">
|
|
512
696
|
<div class="tsd-navigation settings">
|
|
@@ -532,16 +716,22 @@ That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
|
532
716
|
<li><a href="#_iframeElement" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>#iframe<wbr/>Element</span></a></li>
|
|
533
717
|
<li><a href="#_origin" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>#origin</span></a></li>
|
|
534
718
|
<li><a href="#_subscriptions" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>#subscriptions</span></a></li>
|
|
719
|
+
<li><a href="#_webApplication" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>#web<wbr/>Application</span></a></li>
|
|
535
720
|
<li><a href="#_requiredIframe" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>#required<wbr/>Iframe</span></a></li>
|
|
536
721
|
<li><a href="#baseUrl" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>base<wbr/>Url</span></a></li>
|
|
537
722
|
<li><a href="#iframe" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-262144"></use></svg><span>iframe</span></a></li>
|
|
723
|
+
<li><a href="#_createUrl" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>#create<wbr/>Url</span></a></li>
|
|
724
|
+
<li><a href="#_download" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>#download</span></a></li>
|
|
725
|
+
<li><a href="#_fetch" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>#fetch</span></a></li>
|
|
538
726
|
<li><a href="#_getIframePromise" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>#get<wbr/>Iframe<wbr/>Promise</span></a></li>
|
|
539
727
|
<li><a href="#_log" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>#log</span></a></li>
|
|
540
728
|
<li><a href="#_onMessage" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>#on<wbr/>Message</span></a></li>
|
|
541
729
|
<li><a href="#_postEvent" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>#post<wbr/>Event</span></a></li>
|
|
542
730
|
<li><a href="#_show" class="tsd-is-private"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>#show</span></a></li>
|
|
543
731
|
<li><a href="#createGeometry" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>create<wbr/>Geometry</span></a></li>
|
|
732
|
+
<li><a href="#downloadData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>download<wbr/>Data</span></a></li>
|
|
544
733
|
<li><a href="#editGeometry" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>edit<wbr/>Geometry</span></a></li>
|
|
734
|
+
<li><a href="#fetchData" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>fetch<wbr/>Data</span></a></li>
|
|
545
735
|
<li><a href="#on" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>on</span></a></li>
|
|
546
736
|
<li><a href="#show" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>show</span></a></li>
|
|
547
737
|
<li><a href="#showMap" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>show<wbr/>Map</span></a></li></ul></div></details></div>
|
|
@@ -552,6 +742,7 @@ That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
|
552
742
|
<li><a href="CadenzaClient.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg><span>Cadenza<wbr/>Client</span></a></li>
|
|
553
743
|
<li><a href="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>
|
|
554
744
|
<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>
|
|
745
|
+
<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>
|
|
555
746
|
<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>
|
|
556
747
|
<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>
|
|
557
748
|
<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>
|
|
@@ -560,6 +751,10 @@ That's why the events use the <code>editGeometry</code> prefix.</p>
|
|
|
560
751
|
<li><a href="../types/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>
|
|
561
752
|
<li><a href="../types/Extent.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-4194304"></use></svg><span>Extent</span></a></li>
|
|
562
753
|
<li><a href="../types/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>
|
|
754
|
+
<li><a href="../types/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>
|
|
755
|
+
<li><a href="../types/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>
|
|
756
|
+
<li><a href="../types/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>
|
|
757
|
+
<li><a href="../types/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>
|
|
563
758
|
<li><a href="../types/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>
|
|
564
759
|
<li><a href="../types/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>
|
|
565
760
|
<li><a href="../types/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>
|