@disy/cadenza.js 1.8.0 → 2.1.0

package/CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 2.1.0 - 2023-11-29
+### Added
+- Documentation for the `'drillThrough'` event for `CadenzaClient#show` and `CadenzaClient#showMap`
+
+## 2.0.0 - 2023-11-23
+### Changed
+- Replaced `mediaType` with `dataType` throughout the whole library.
+
 ## 1.8.0 - 2023-11-21
 ### Added
 - Common map options for "Show map" in the sandbox

package/README.md

@@ -90,11 +90,11 @@ cadenzaClient.show('{embeddingTargetId}', {
 
 #### Show the Generated PDF of a "JasperReports report" View Directly
 
-Views of type "JasperReports report" can be shown in an iframe like any other view. Additionally, there is an option to show only the generated PDF without any Cadenza footers or headers. This is done by setting the "mediaType" option to "application/pdf".
+Views of type "JasperReports report" can be shown in an iframe like any other view. Additionally, there is an option to show only the generated PDF without any Cadenza footers or headers. This is done by setting the "dataType" option to "pdf".
 
 ```javascript
 cadenzaClient.show('{embeddingTargetId}', {
-  mediaType: 'application/pdf'
+  dataType: 'pdf'
 });
 ```
 
@@ -254,7 +254,7 @@ cadenzaClient.expandNavigator();
 Fetch data from a workbook view in CSV format.
 
 ```javascript
-const response = await cadenzaClient.fetchData('{embeddingTargetId}', 'text/csv');
+const response = await cadenzaClient.fetchData('{embeddingTargetId}', 'csv');
 
 const text = await response.text();
 ...
@@ -265,10 +265,9 @@ const text = await response.text();
 Fetch data from a workbook view in JSON format and include only the data values and the aggregation totals. (Do not include the column names.)
 
 ```javascript
-const response = await cadenzaClient.fetchData(
-  '{embeddingTargetId}',
-  'application/json',
-  { parts: ['values', 'totals'] });
+const response = await cadenzaClient.fetchData('{embeddingTargetId}', 'json', {
+  parts: ['values', 'totals']
+});
 
 const tableData = await response.json();
 ...
@@ -283,11 +282,7 @@ Download data from a workbook view in Excel format. This triggers the browser's
 ```javascript
 const button = document.createElement('button');
 button.textContent = 'Download Excel';
-
-button.onclick = (event) => {
-  cadenzaClient.downloadData('{embeddingTargetId}',
-    'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet');
-};
+button.onclick = () => cadenzaClient.downloadData('{embeddingTargetId}', 'excel');
 ```
 
 ## The Development Sandbox
@@ -301,6 +296,13 @@ To run it ...
 
 The command starts a proxy server that serves the `sandbox.html` and `cadenza.js` files and proxies all other requests to the Cadenza server. Since that way the sandbox and Cadenza run on the same origin, embedding and `postMessage` communication just work.
 
+Alternatively ...
+
+* Set the system variable `"net.disy.cadenza.sandbox"` in Cadenza to enable the sandbox.
+* Now, `sandbox.html` is served on http://localhost:8080/cadenza/sandbox (replace with custom Cadenza url `/sandbox` as needed).
+
+`cadenza.js` is automatically served when Cadenza starts.
+
 ### The Sandbox UI
 
 `npm run sandbox` also opens the sandbox in a new browser window. Select the Cadenza JS method you want to play with in the select box at the top. For each method there are controls to define the parameters. Hit "Go!" to call the method.

package/apidoc/assets/navigation.js

@@ -1 +1 @@
-window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA43TUU/CMBAH8O+yZyJCBJU3Q8AYJZKI+GB8uK0HNJSWdAeChu/uELZ17Vj32v/1l1t39/kbEO4o6AUPodI00FrpoBGsgRbJWSQgjjFu5tnVglYiKVhyyYJeq313aGRCHxjKH+gLjpJcpBDXcC70YqZ1lG2hGS4J9QwiA9o67bQ7XQMa7JIrEsQLl8tn3JdaVk0V94hqhaTLnTSsAsYwxze10RGWEnlchXwovQyVuvhBRl6HmXL89lHnGh8XLxCpykoLqiBzSKwJoP3amqKyCbi+v2112uYUrEJkjMv5BPQc6YnZolPgFZOZcRs7nfruDrlI3mQKmkMoMLYRK/Zp6dRNkss2ZWZeR6gQhPs06bnv/ggZh7ImssAnvK5RA3ElR4o5SiH0SZPjy41BOz8oC3zCOx8i0EY7fWSBT0g3x972E1NM61rHLaz28oo65v82XgaN2KdFp5XMldlGRsffFTfPUVHo3hy+/gDzq95pvwYAAA=="
+window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA43TUU/CMBAH8O+yZyJCBJU3g2CMGklEfDA+3LZjaygt6Q4EDd/dIWzr2rHutf+7X7ru7vPXI9ySN/DufKlopJRUXstbAcXpWcAhSTBpF9lFTEueFiyYCL1Bp3uzb+XCEEIUPzDkDAXZSClu4Jy5i542UTalyzBBqOYQaNDGuk6319eg0TZtEcCfmVg84a7SMmrquAeUSyRV7WRhHTCBCN/kWgVYSRRxHfIh1cKX8uwHaXkTZsbw20WdalxcEiNSnZUV1EH6kBgTQLuVMUVVE3B5e93pdTXxHgimaasJZeeu/tHSxzBkIpqCipAeQxOyCpxiOnP2hx1PXb1jxtM3nYFi4HNMTMSIXVo2tVXvo2dOh0sfuP002bmr/3WFCohJ8SJD6yKl0CVND989AWU9bx64hHc2RqC1su6RBy4h2xtz149MOW1qHXaw3isqmpj/u3ge1GKXFhwXslDmaxEcflfSPkVloX+1//oD/NjxH70GAAA="

package/apidoc/assets/search.js

@@ -1 +1 @@
-window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7WbW3PbNhaA/4v8qijCjbb81um6nc5u2sw0zT5kPB5KhB2OJVIlKTupx/99AV7PAQ9kMNI+ORTODec7uJBAXmZF/lzOrr+8zB7TLJldR3I+y+Kdnl3PNnGis3/i2Xx2KLbm+f6Qbao0z8r3bcvia7XbmubNNi5LbazMZq/zzhDjV72lnxv5n7epzqreXqv2HrUet7nkQ3gX67jUfxXbAHsXd4PsYLgqk3dp+W5fpE9xpU3TPi5sfG68Pv95kT6kWZD7XvR83tP7wv4rxHsvej7vz3r9036/TTexrYigKEYq587FzVbvwuqrS8mgcb5YEr0+PATF0Emez3d5WJebIt3XozQoBlfjlFh4xJkcopkwPKnR+QMew4cEMSJ+wN9Fof8+pIVOfgsfiyOVkzK+lMMkW37Nn0NCaOUm9tz19CHehzprRE/wp7/t4yz5PX5KH+IqL0L8jlVO8L8ptAHyq853uiq+h7gfaZzS+yStpvh25E/wfBFaUnejmjqxli8edNWMkI9FvkvLsLFFKJ0torBFzlnXQrxESomod3N3V33fB/U2zxZ59o4teo0At4tayZv0PPugyzJ+CMs2lD4f+H1eVjdPocs4lD5bDPe62nz9V1zFISFA4VOGWm0nqM+d5Nn6m+TP2TaPk9AuO/Kn9LozFbZfGoTPV2/NTB36GgGlzxfDNg/bMDZyJ20XwUvZT+u8qG6KglhQh6ajr2OK8WGNNPvHqjhsqPXZMXeBZen6AdEdfaekOwAbz9KFkcGgTqAYfZv2YxM+8Dee5t/E7/p1tq+BjkOWl5Gn5eqSqSG1N7u1TpI0e/gUF3aVHga8tV6+H7UfheZa/3Wbr+PtyGj383Fbalh8b75Vusji7X/S7PHfethspZn5/T7e2ECxSPjXikKbtSo1xfL9d/iq8Ibpi5EajcGN3BOEBmIgXW8FMVKbGgRM8n/z4nGd574Eg+ZzJtc1G5pYGK3H+XMrQid05BiJT3HqJrH8qnV1JItd+7nTiOxOyWMf8A8nErsOzGSI21pmit9BYZJjaiB8TvXzG4OhFfl/DAhoeuqg6CI/aWCgACYMjjecP5nmCY578alOIdGP5mXoz/xQbMiMD63hHPfwZcxv62LvvobB4EFY/jW066ETf7OS4sZJa3M/ELyGQetkyx2To1EPApPs/7HXRf2p+kOeuKZR2ySrf6W/mFeIQ+Fa7H8P3q2MvgmB+ujawisNbQZ9lo7vBfuAjuzUWpFP0Fu7WwNNkzJqtx3gc0G7oax/nGTng07SmAis/32StU/xeqs/xoUbWP/7JGu/pFtD5HNcpFa9dGw6rcEV1G3e0ecWwB62n15JI2thbxZPRw48El3F6TbMWS87yZ0LAr7v4Lw1KEbtVN5u5ybURH+bXb/MnnRR2uOw6xlfiMXKSN6nepvYI9nGp1HNd/Up1W3b9lnbl04r0Yi8X87mX5ZzcbWQ4vZ2/qVTqH+vf6ilmHlihBRDUtw88bkQC8E5EuNITJgnQRgTSEqaJ0kZk0hMmSdFGFNIKjJPESEVIalL83RJSF0iqSvzdEVIXSGplS8XK5zYpa+bzCFgU72iEGAGzOaaLUmLGAOz+WYkVUyC2YwzTgliFswmnVFoGcbBbN6ZpAQxEXbp7w2mwmz6GVUJDINhFgCjioFhNNwCYFQ9cIyG16ODKgnujI+aDQWRYzTcAuDUsOQYDbcAOMWQYzTcAuAUQ47RcAuAUww5RsNt/jnFkGMy3OafU2Q4JsPrMUOR4ZiMsPnnl1RVCIxGWACcQiMwGsH9Jp3Zq2azmvPLhZQSS2I4QvolMR1hGQiKt8B0hGUgKN4C0xGWgaB4C0xHWAZCkEFiPMJCEBRwgfFIy0BQwCWmI5nXt8R4pGUgojlfLVbqEktiPLJeXahRK531RfqdYzpS+Z1jPLLGQ5WbxHhkjYeaCSTGI/14JMYjV/4oMR9VrzlUtSnMR1kIkqo2hfEoy0BS1aYwHWUZSGp2UZiOqpd/qtiUs/5bApLcAWA2yhKQ1OyiMBtlCUiqghRmoywASdFWGI1aeScChdFENRqqLiKMJrIAFMUwwmgiC0BRDCOMJrIAFMUwwmgiC0BRDCOMJqr3ZhTDyNmdRd78RJhNZAkoinaE2USWgCK3fA2beh9tNtCVTn5r9tNmR9ydh7/M7tpNtln/2+37y8ws+9cvr6/Dpto+WdOxPW/SzWHSoMojoLryqNrbS/YdAOoBNSs3n/mU+0uWg/JyUPZF22pt2guVoK+DLjuuO+7r1aArQpT1k+NcgWwZRMctjJQlUFY+ZXjoBkIHhMWySbjgPhv1Ge5D//UEJE+A7HlDqNVd3iB4s3WiNdv7foMWiNqv07y1gjwpkCevWn9UDmIEvTP7wOOKSX22D5RhRftSY28ekXkF2WE+z7o7AqzqI8AUxS7AmBBe9/Wdr2y48wUiAOGbFx6ffuXWJHAb+YZEdzq2TbNHJ2rQb+GbAKD6o0Z5EyBq4UPdXgcBqMAcwH19rbVGkEF3zUuKR7P+2PQ0fIoC6QIVFvk8UwUiwdSjfBNHp+hO72apHbz6JkxbUfXVsH13NQwUBxhRzOu9Pkx2+IJMC19dd1dNQcCDlmzmKuYLu1HW3TXlwQacaT269W0RABf0kvt6ubPfOt0EK9DNyDer2ptvIKUgPuar/DzbdRfIgCYoBe4bcnn3+X1Xf5oHqQV+lS8x3WV8ABJw9CjtnTglGJvKlxSrVLZHE0AV5FP5umhvto3WSAZKnfucDod4mVN4Avbzqik9ydq/bSlKX2l0F5fH9QyCYr7uNBdEQU/AVMPaLRLzTXFWeWcvEQN9uNHxMXMutw/aoMZ83a3s7Lavv9+DkQCgRz6v7vDhID9CtJuTNttq1fyNfLV6SO+74yJQQGDjoHxJsyeaeLqSIOfKN+M863UM/5cG6DzQ9im3J27ONAkGpWxZS9X+9U0OnSl3SQRRSG8fWl1i6IERoHwAO3WbQdc9YCl9mYf6RAgwj8cSWZ+LOpkEhSt9JdPrurGDqpHH+l4rE4GDdUuRq7t5H9une212Mkboy+3r6/8A+E3J9142AAA=";
+window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7WbW3PbNhaA/wv9qijCjbb81um6nc5u2sw0zT5kPB5KhB2OJVIlKTupx/99AV7Ec8ADGYy0Tw6Fc8P5Di4kkJeoLJ6r6PrLS/SY5Wl0HctZlCdbHV1H6yTV+T9JNIv25cY83+/zdZ0VefW+a5l/rbcb07zeJFWljZUoep31hhi/Olj6uZX/eZPpvD7Y69Teo9bjNhd8CO9ilVT6r3ITYO/ibpAdDNdV+i6r3u3K7CmptWnaJaWNz43X578os4csD3J/ED2f9+y+tP8K8X4QPZ/3Z736abfbZOvEVkRQFCOVc+fiZqO3YfXVp2TQOF8sqV7tH4Ji6CXP57var6p1me2aURoUg6txSiw85kwO0UwYntTo/AGP4UOCGBE/4O+i1H/vs1Knv4WPxZHKSRlfyGGSrb4WzyEhdHITe+56+pDsQp21oif40992SZ7+njxlD0ldlCF+xyon+F+X2gD5VRdbXZffQ9yPNE7pfZrVU3w78id4vggtqbtRTZ1YyxcPum5HyMey2GZV2NgilM4WUdgi56xrIV5ipUR8cHN3V3/fBfW2yOdF/o7NDxoBbueNkjfpRf5BV1XyEJZtKH0+8Luiqm+eQpdxKH22GO51vf76r6ROQkKAwqcMtcZOUJ97ybP1Ny2e802RpKFdduRP6XVvKmy/NAifr97amTr0NQJKny+GTRG2YWzlTtougpeyn1ZFWd+UJbGgDk1HX8cU48MaafaPdblfU+uzY+4Cy9L1A6I7+k5JdwA2nqULI4NBnUAx+jbtxyZ84G88zb+J3/XrbF8DHYcsLyNPi+UlU0Nqb7YrnaZZ/vApKe0qPQx4a716P2o/Cs21/uumWCWbkdH+5+O21LD43nyrdZknm/9k+eO/9bDZynLz+32ytoFikfCvFaU2a1VmiuX77/BV4Q3TFyM1GoMbuScIDcRAut4KYqQ2NQiY5P8W5eOqKHwJBs3nTK5rNjSxMFqP8+dOhE7oyDESn+LUTWL1Vev6SBb79nOnEdmdksdDwD+cSOw6MJMhbhuZKX4HhUmOqYHwOdPPbwyGTuT/MSCg6amDoo/8pIGBApgwON5w/mSaJzg+iE91Col+NC9Dfxb7ck1mfGgN57iDL2N+Wxc79zUMBg/C8q+hfQ+d+NuVFDdOWpsPA8FrGLROttwzORr1IDDJ/h87XTafqj8UqWsatU2y+lf2i3mF2JeuxcPvwbuV0TchUB99W3iloc2gz9LxveAhoCM7tU7kE/TW7dZA06SM2m0H+FzQbSibHyfZsa+zRFz9z5NsfUpWG/0xKd2wDr9PsvZLtjE8PidlZtUrx6bTGlw//dYdfWwB5GH76XU0shb2XvF05Lgj1XWSbcKcHWQnuXNBwLcdnLcWxaidytvtzISa6m/R9Uv0pMvKHoZdR3wu5ksjeZ/pTWoPZFufRrXYNmdUt13bZ21fOa1EK/J+Ec2+LGbiai7F7e3sS6/Q/N780Egx88QIKYakuHniMyHmgnMkxpGYME+CMCaQlDRPkjImkZgyT4owppBUbJ5iQipGUpfm6ZKQukRSV+bpipC6QlJLXy6WOLELXzeZQ8CmekkhwAyYzTVbkBYxBmbzzUiqmASzGWecEsQsmE06o9AyjIPZvDNJCWIi7NLfG0yF2fQzqhIYBsMsAEYVA8NouAXAqHrgGA1vRgdVEtwZHw0bCiLHaLgFwKlhyTEabgFwiiHHaLgFwCmGHKPhFgCnGHKMhtv8c4ohx2S4zT+nyHBMhjdjhiLDMRlh888vqaoQGI2wADiFRmA0gvtNOrNXw2Y545dzKSWWxHCE9EtiOsIyEBRvgekIy0BQvAWmIywDQfEWmI6wDIQgg8R4hIUgKOAC45GWgaCAS0xHMq9vifFIy0DEM76cL9UllsR4ZLO6UKNWOuuL9DvHdKTyO8d4ZIOHKjeJ8cgGDzUTSIxH+vFIjEcu/VFiPqpZc6hqU5iPshAkVW0K41GWgaSqTWE6yjKQ1OyiMB3VLP9UsSln/bcEJLkDwGyUJSCp2UVhNsoSkFQFKcxGWQCSoq0wGrX0TgQKo4kbNFRdxBhNbAEoimGM0cQWgKIYxhhNbAEoimGM0cQWgKIYxhhN3OzNKIaxszuLvfmJMZvYElAU7RiziS0BRW75WjbNPtpsoGud/tbup82OuD8Nf4nuuk22Wf+77ftLZJb965fX12FTbZ+s6cSeNun2KGlQ5TFQXXpU7d0l+w4A9YCalZtFPuXDFctBeTEo+6LttNbddUrQ10GXHdcd9/Vq0BUhyvrJca5Atgyi4xZGyhIoK58yPHIDoQPCYtEmXHCfjeYE9+Hw7QQkT4DseUNo1F3eIHizdaI106RO3NpUAFjsi7i7Jjhoge56nXWvu8CVAq68aocTdtA5kBazgTyumDZXAoAyHAq+nNoLSyQQkFbm86z7k8O6OTnMUOwCDCbhdd9cFcuHq2IgAhC+eVPy6dduMQO3sW8s9Ydqmyx/dKIG/Ra+mQOqP2qUNwGiFj7U3S0SgArUIvf1tdEaQQbdNW83Hs3mK9XT8A0LpAtUWOzzTBWIBHOW8s04vaI79swaPXj1zbS2opobZbv+RhkoDjCimNd7cwbt8AWZFr667m+ogoAHLdlOcswXdqus+9vNgw04RXt0m0smAC7oJff10l57A4kBXpivfot8298eA5oAKPcNnKL/9r5tvsuDBAG/yte9/iY+wAFoeJR2TpwSjDDlm7etUtWdSwBVAF/5umivtY2WSAYKlvucDid4uVM+Avbzqi0gybq/XUFJH+D+1vK4KkFQzNed9nYo6AmYMFi3Q2K+icoqb+0NYqAP9zk+Zs7N9kEb1Jivu7Wdo3bN53swTQHosc+rO8twkB8hur1Jl221bP/GvlrdZ/f9WREoILD8K1/S7HEmnnQkyLnyzRvPepXA/6IBOg+0fcrdcZsz2YFBKTvWUnV/fZNDb8pd2EAU0tuHTpcYemAEKB/AXt1m0HUPWEpf5qE+EQLM47FENoeiTiZB4UpfyRx03dhB1chjfW+UicDB6qPINdq8ju2ynTb7ESP05fb19X90Jv+WWzYAAA==";