From 98d1a5c9319944b0056676cba3ddfbdbe96d181d Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 30 Jan 2024 11:12:48 +0000 Subject: [PATCH] Updates --- assets/search.js | 2 +- classes/AbortError.html | 4 +-- classes/CadenzaClient.html | 41 ++++++++++++---------- classes/CadenzaError.html | 6 ++-- functions/cadenza.html | 2 +- index.html | 1 + interfaces/CadenzaEvent.html | 6 ++-- interfaces/ExternalLinkKey.html | 6 ++-- interfaces/Geometry.html | 4 +-- interfaces/PageSource.html | 4 +-- interfaces/WorkbookKey.html | 6 ++-- interfaces/WorkbookViewKey.html | 8 ++--- interfaces/WorksheetKey.html | 8 ++--- types/CadenzaChangeExtentEvent.html | 2 +- types/CadenzaDrillThroughEvent.html | 2 +- types/CadenzaEditGeometryCancelEvent.html | 2 +- types/CadenzaEditGeometryOkEvent.html | 2 +- types/CadenzaEditGeometryUpdateEvent.html | 2 +- types/CadenzaErrorEvent.html | 2 +- types/CadenzaEventByType.html | 2 +- types/CadenzaEventType.html | 2 +- types/CadenzaSelectObjectsCancelEvent.html | 2 +- types/CadenzaSelectObjectsOkEvent.html | 2 +- types/CadenzaSelectObjectsUpdateEvent.html | 2 +- types/DataType.html | 2 +- types/EmbeddingTargetId.html | 2 +- types/Extent.html | 2 +- types/FilterVariables.html | 2 +- types/GeometryType.html | 2 +- types/GlobalId.html | 2 +- types/OperationMode.html | 2 +- types/TablePart.html | 2 +- types/UiFeature.html | 2 +- types/WorkbookLayerPath.html | 2 +- types/WorkbookSource.html | 2 +- types/WorkbookViewSource.html | 2 +- types/WorksheetSource.html | 2 +- 37 files changed, 76 insertions(+), 70 deletions(-) diff --git a/assets/search.js b/assets/search.js index 9509b515..5e7f237c 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7Wb3XPbNhLA/xf5VVFEfJHyWy9NO51r2kyb5B4yHg8lwTbPtKijaDs5T/73I0BS3AUXFGTpXuJI3C/sbxcEKPBlUhbPu8nl15fJfbZZTy6VmE426YOeXE5W6Vpv/ptOppPHMq8/3zxuVlVWbHZv2yuzu+ohry+v8nS307WVyeTHtDMUsWRv6V0j/y7P9Kba22vV3qKr4zbnrA/vYpnu9OcyD7B3cd3L9oar3fpNtnuzLbOntNL1pW1amvjceH3+izK7zTZB7vei5/Oe3ZTmfyHe96Ln8/6slz9tt3m2Sk1FBEUxUDl3Lt7n+iGsvrqU9Brni2Wtl4+3QTF0kufzvXtc7lZltrVdGhSDq3FKLEyxSPTRHNGeVHe+wmN4SxAd8Qp/F6X+z2NW6vVv4b04UDkp43PRT7K7u+I5JIRW7siRu54+pNtQZ43oCf70t226Wf+RPmW3aVWUIX6HKqeMV1e/ZHmlgzxD4RN8rkpdF8GvunjQVfk9xPFA45SMr7PqGN+O/Em5zvWq+nP57/rfoCnMVTjB90VoC10PeujE3r241VUzI3wsi4dsFzaXEErni2hb7Kq/6slK78LuqFj+bHGELS6c9USIFyUlV3s319fV921Q1ovNrNi8iWaNxhsW5nhm1bzJDlxCnbxseu2ga8+zazDswEGbZF2MDvuD3u3S29AYeunz1vn7p9B1I5Q+Www3ulrd/ZxWaUgIUPiUuc7aCRpzJ3m28a6L501epOvQITvyp4y6MxW2QO+Fz1dvzW06dN8Kpc8XQ16E7VAauZP2J+ApwE/LoqzelyWxgusvje7/ZcT6BVK9YanKxxW1IHTMXWBZun5AdKMPMegBwItnGcLAYNAgUIy+XeLYpA/8DSf6g/hdv85+KdBxyA1m4Gm+iCPZp/b9w1Kv19nm9lNammVS3/DG+u7t4PooNNf6r3mxTPOB0e7rcVuyvwG//1bvEzZp/nu2uf+n7lfa2ab+/iZdmUCxSPjjsVLX96qsLpbvf8C96QHTFwM1GoMbuScIDcRAug4FMVA7NgiY5H8V5f2yKHwJBpfPmVzXbGhiYbQe58+tCJ3QgWMkfoxTN4m7O62rkSx218+dRmT3mDzuA351IrHrwEyGuLUyx/jtFY5yTDXCl0w/H2iGVuT/0RDQ9LFN0UV+UmOgAI5ojgPOn+rLRzjeix/r1L0XdZK/p991+TGt+jV9c1MaXA++O32st1p/F4/liuTZXw2vki3c6vltXWzdTR5MDQjrcFac+HFKAsKn7No28xoGV4+23BEfjboXOMr+n1td2l9ePhRr1zS6dpTVz9kv9QblsXQt7r8PrrbB40ZQH9218EpDS02fpfGV5j6gkXVgK/IJemvXguDSURk1ixrwMKJdrtovj7JjNstEXN3XR9n6lC5z/TEt3bD23x9lrXk8/iUtM6O+c2w6V4+y3G0OzAMaYuzu5Vfb/gdFfCgQXPtQlapaeP30HhhYs33wJjq453oa+e1xras0y8PcNbLHO/QgeXeXbm510yI4hQjMQOw1+H8uszz/dFcWj7d3I74GYq8qNfCjyuftut5yj3j0CJ/q98/7QJ+t4Kn+3qWblc4DfQLhV/k1zxDGXO2vv8b63/B3qYP4fNInex4FSEme7PEgQp805flqWk8la/1tcvkyedLlzpwcuZywGZ8tasmbTOdrc3qpiadWLR7sgY6r9toXbR6XGYlG5O18Mv06n4r5TCSLq6vp107DXrBfWLF6avoaUWIREmP1JzblcsaTCIkxJMbrT5yyxpGYqD8JyppAYrL+JClrEomp+pOixBQSi+tPMSUWI7Gk/pRQYgkSW/gSssDpnfuGGjkcTL4XJAhMIjIZj+akSQwjMkmPaLiYR2TyHjFSEiOJTOojEnGEqUQm+5EgJTGYyACISNARZhMZBhHJOsJ4ooU/S5gQMxwisjAYRsRsr5C1wZxusYwWZL9gRsyAYGScDDNiwm8TM2LSbxMzYgYEIyuEYUbMgGBkhTDMiBkQjKwQhhkx20NkhTDMiBsQjKwQjhlxA4KRFcIxI26nNJI7dyY1y4jkzjEjbkAwsos5ZsQNCE4y4pgRNyA4yYhjRjz228SMuAHB2ZQtZnLOsSRmxBd+ScxIGBCc5C4wI2FAcJK7wIyEAcFJ7gIzEvbOo6g4hXPvMSA4yV1gRsIyIrkLzEgov3fMSFhGdRez2TxSWBIzEgaEIO/gAjMSC793zEjOvd4lZiQNCEFWncSMpAEhyJlBYkbSz0hiRlL443SWCAaEIKtOYkbSgBBk1UnMSBoQgl54YEbSMiJnG4kZSQNCkFUnMSNlVwxk1SnMSFlG5GyjMCNlQEiylhRmpAwISXJXmJEyICTJXWFGSnrnEOWs5AwISdJUmJEyICRJU2FGyoCQJE2FGSkDQtIrScwoNiAkvZjEjGIDQpI0Y8wotoxImjFmFBsQiqQZY0ax8GY+xoxiA0KR3GPMKLbLbZJ77Cy4DQhF0owxo9iAUCTNGDOKDQhF0owxo8SAUCTNBDNKDAhF0kwwo8SAUPTuADNKLCOSZoIZJQZETNJMGkZ2Z1hvCSu9/q3ZIdZ7vO502svkut021iu+drP6MqnXjpcvP6aTer1X//3RbxfNJ+MiNWdAdHPAA5hY9CbqBQutao6wm70u1AOeG8cLj/L+TZteGYQ9H9da2eda2j7X0s2uuzejQBB1IY4bal/P6bWjXjka112bB15V88BrGAQHQcTjhsxJ4tv2+c7KPhsYmlO9ueRAcqC54n5oSoLIDtCBph7tE5qhOQHMJQfMuWXGQbb5AVRWeeg+Bok5AGyoDCou5gHKy+9ur0nQKDELMDEwkAADBwbQnPsumqdInkqJwZgSX+dS9qhSAYNLDuQH2fLVChhr4k0WPPMFSgWMi8tmbuHexrJHCG/3P6+B9gblGnkrzqq7UxuoNO4Lvh52OiAMGk75OqR9MQpwBGXh1Wl+fwAJBv0U+2b8/ognGByYX7ivCjvFtT2TCpTBALlvcoJTCQIClCPfSHV3dK2yR9cyFDsHU63wurcvx2z6l2NABOB+Efk6Rrc/UQKsoJKUN/D2uFaebe6dqAFgMea1U7/XKG8c5E34yrE9xgxQgaCZb/K3WgPIIMvMV8U39ofMp/5nTpAuWNA+SlSBSIBH+RLVKQ56D0StfO1uKsq+U7Lt3ikBxQHCZt6w7SFIhy/ItPB1VPdOXq8GtZpJLvJ5bZR19z4nmAXAmD269pQzgAsmZu6b6M2bGCAx4N7A2rUe8+EpNg/dawzAKZismC/Qojum8WCPcACy4H6gfPXfvYMMsICBepS2TpwC5FP6Kt8o7dojLEAVNKn0zRHm/YrBrZLBlfSYZtm9fwTQAJrMV3r9MbSNU4IcjFe02weh2r+L5q/0Ja9713NY2aBeIl9QaBGBhgRiinwMdrq6aV9DBJqAeOS7JTbvtgElUFxRW9yRb7o0yg/mfU+gD3cRvlQ57yH32nCV5NGtzPy6tadTQEvAxvdF686QHBQaT9p1VUtZteus2NfXj9lNdxQKhAEGr3yDN2cB8YQpACjpA/Wslyl8oR54Bdo+5fY0mTNRg8IUcVve8/avb+CdKfemDNCJQ2Hk5nTi1p5eBFkANwDpmxQ7C8SEA25X0lcCnbph4AxAgGqQvlkV6hMhgHwqX6Pvj/c6NQBKRx7UdWMHTSt8jbNXJgIH8BR5072aTrbZVtersVro69WPH/8DkzWr1ktEAAA="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7WcS3PbOBKA/4t8VRSBeJD2bTaTmZraySQ1eewh5XJREmxzTYtakrbjdeW/LwCSYjfZkCBLexmPxH6hv24QoMC8TMriqZpcfH+Z3GXr1eRCielknd7rycVkma70+r/pZDp5KHPz+fphvayzYl29ba/Mbuv73Fxe5mlVaWNlMvk57QyxKNlaetfIv8szva639lq1t+jqbpvzqA/vbJFW+muZB9g7u+ple8N1tXqTVW82ZfaY1tpc2qSljW8Yr89/UWY32TrI/Vb0dN6z69L+X4j3rejpvD/pxS+bTZ4tU1sRQVGMVE6di/e5vg+rry4lvcbpYlnpxcNNUAyd5Ol8Vw+LallmG9elQTEMNY6JJVIRE300B7Qn1Z2v8BjeEkRHvMLfWan/85CVevVHeC+OVI7K+Fz0k2x1WzyFhNDKHTjyoacP6SbUWSN6hD/9Y5OuV3+lj9lNWhdliN+xyjHj1fVvWV7rIM9Q+Difn3Wul6HT60D+CM/LUpvy+10X97oun0N8jzSOYb3K6kN8D+SPyrhN38fFv81/gybPocIRvs9Cm/dq1L1HzhpnN7pu5qJPZXGfVWGzGKF0uog2RVX/baZJXYXdy7H8yeII67tXdJuSkqutm6ur+nkTlPViPSvWb9is0XgThTmeOTVvsgMXb0cv2F47aON5dgWGHThom6yzncP+oKsqvQmNoZc+bZ2/fwxdsULpk8Vwrevl7a9pnYaEAIWPmeucnaAxd5InG++qeFrnRboKHfJA/phRd6bCtga98OnqrblNh+6YofTpYsiLsL1RI3fUzgg8f/hlUZT1+7Ik1o79pZ1PHiSL+gWS2SrV5cOSWooOzJ1hWbp+QHQ7H5/QA4AXTzKEkcGgQaAYffvTXZM+8Dee6PfiH/od7NQCHYfcYEae5ucxk31q398v9GqVrW++pKVdJvUNb61Xb0fXd0IbWv89LxZpPjLafb3bluxvwO9/mB3KOs3/zNZ3/9T9Sjtbm++v06UNFIuEP5grtblXZaZYnv+Cu+I9ps9GajSGYeSeIDQQA+naF8RI7dAgYJL/VZR3i6LwJRhcPmVyh2ZDEwuj9Th/akXohI4cI/FDnA6TWN1qXe/IYnf91GlEdg/J4zbgVycSuw7MZIhbJ3OI317hIMdUI3zL9NOeZmhF/h8NAU0f2hRd5Ec1BgrggObY4/zRXD7A8Vb8UKfDe1En+Wf6rMtPad2v6Zub0uh68N3pk9lqfS4eyiXJs78aXiUbuNXz2zrbDDd5MDUgrP1ZGcSPUxIQPmXXtZnXMLh6sOWO+M6oe4GD7H/c6NL95vOhWA1No2sHWf2a/WY2KA/l0OL2++BqGz1uBPXRXQuvNLTU9FnavdLcBrRjHdiKfIHe2rUguHRQRu2iBjyMaJer7suD7NjNMhFX9/VBtr6ki1x/SsthWNvvD7LWPJj/lpaZVa8GNgdXD7LcbQ7sAxpi7MPLr7b9D4r4WCC49qEqVbXw+vE9MLLm+uAN27vnetzxq+dK12mWh7lrZA936EHy7jZd3+imRXAKEZiR2Gvw/1pmef7ltiwebm53+BqJvarUwI8qXzcrs+Xe4dEjfKzfj3eBPlvBY/29S9dLnQf6BMKv8mufIexytb3+Guuf4e9Se/H5pI/2vBMgJXm0x70IfdKU58upmUpW+sfk4mXyqMvK/q56MYlmfHZuJK8zna/suakmHqNa3LujJJfttW/aPi6zEo3I2/lk+n0+FfOZmovLy+n3TsNdcF84MTM1fWeUGENikfkUTbmciXOFxCIkxs0nTlnjSEyYT4KyJpCYNJ8kZU0iMWU+KUpMIbHYfIopsRiJJeZTQoklSOzcl5BznN65b6hswMHm+5wEgUkwm3E2J01iGMwmndFwMQ9m884iUhIjYTb1jETMMBVms88EKYnBMAuAkaAZZsMsA0ayZhgPsxgYiZthQtHcm88II4pcr5C1EQ26xTEiaUaYUWRBRLR3zCiyICJGSmJGkfTbxIwi5beJGUUWRERWSIQZRRZERFZIhBlFrofICokwI25BRGSFcMyIWxARWSEcM+JuSiMrhA8mNceI5M4xI+4Ykdw5ZsQtCE7Ozxwz4hYEJxlxzIhbEJxkxDEjnvhtYkbcguB8Gp3PFEuwJGYk5l5JgRkJC4KT3AVmJCwITnIXmJFwdx6SuxjceywIHpNxYkbCMSK5C8xIOEYkd4EZidjvHTMSFoQwXRzNGGdYEjMSFoQg53mBGcm517vEjCTzepeYkbQgBFl1EjOSFoQgZwaJGUk/IzlYIkh/nJiRtCAEWXUSM5IWhKAXHpiRdIzIqpOYkXSMyNlGYkbKrRjIqlOYkXKMyKpTmJGyICQ52yjMSFkQkqwlhRkpC0KS3BVmpNw6juSuBis55Z1DFGakLAhJ0lSYkbIgJElTYUbKgpD0ShIzii0ISS8mMaPYgpAkzRgzih0jkmaMGcUWhCJpxphRbEEokmaMGcXSm/kYM4rdcpvkHg8W3BaEIrnHmFFsQSiSZowZxRaEImnGmFFiQSiSZoIZJRaEImkmmFFiQSh6d4AZJY4RSTPBjBILIiZpJphRYkHEJM2kYeT2kGbzWOvVH81e0uwGu3NsL5OrdoNpVnzttvZlYtaOFy8/pxOz3jN/f/YbS/vJukjtaRHdHAXpTZily9aEWbDQqvaYvd0VQ9fAc+P43KO8fRuoVwY+57u1lu4JmHZPwHSzP+/NmJLc2jGFuNtQ+wpRrw1yx3brruyjsbp5NDYOQoAgkt2G7Jnjm/ZJ0NI9RRibi3tzyZ64oLnibmxKAVN78gxNPbhnOWNzEgx0D+xxmYF64XtQOeWx+wSMJtpjYaQMYMciQHnxPOw1BYrWzM77TQwNmFtCb2DPAJoT4kXzvMlTKTEYU+LrXMoeUSoxGFyyJz/Ilq9WwFgTb7Lg6TBQKmBcXDVzC/c2ljtseLP9IQ60NyhX5q04pz6c2kClcV/wZtjpiDBoOOXrkPblLZB7UBZeneaXCpBg0E+xb8bvD4OCwQF33FeFneLKnV4FymCA3Dc5wakEAQHKzMdTd4fcanfILUOxczDVCq979wLPun+BB0QAksZ8Va7bHzMBVlBJyht4e7Arz9Z3g6hBOQlfn0L1O43yxkHehK8c2wPPABUImvsmf6c1ggyyHPmq+Nr95PnY/yAK0gXGG/soUQUiwe1c+RLVKY56D0StfH1kK8q9fbLp3j4BxQHCjrxhu+OSA74g08LXUd17g70arOVmkmM+TI2y7t45BbMAGLNH152HBnDBxMx9LWDf2QAq4N4Q8SbUyIenWN93LzwAC3Cx6GNTdAc67t1hD0AW3A+Ur/6796QBFjBQj9JmEKcAc6P0Vb5VqtrDLkAVoJC+OcK+iTG6VUYg0GiXZtm9qQRqFtCMfKXXH1hbD0qQg/GKtghF3PyV8/avr0i691HHlQ2CYr5GQosINCQQE/MxqHR93b4qCTRBIpmvPo1m1b/tCJRBOzJfLzWv0AEl0Bms3QVFvia2yvf2hVagD7cgviIdvGjda8P1sEe3tpPzxh2CAf0EFxy+aIfTK4ftdN6WSlsiql2kxb6kP2TX3YkrEAaYFJSvyOyRQzzbCgBK+kA96UUK/8UA4BVo+5TbQ2sDv4C1SNreYO3ffaaGd3TQIcI7hlY3t4cgN+6QJIgGjsM3o3YWiNkK1I7ylUCnbhkMBiBANUhf4UL9cQgS5FP5pq7tKeIBC1A6cq/uMHbQdMI3wWyVidwBeIqc3i6nk0220WYpZ4S+X/78+T9zQ1D1LEUAAA=="; \ No newline at end of file diff --git a/classes/AbortError.html b/classes/AbortError.html index 27314f58..a16f2208 100644 --- a/classes/AbortError.html +++ b/classes/AbortError.html @@ -1,4 +1,4 @@ -AbortError | Cadenza JS

Class AbortError

Hierarchy

  • DOMException
    • AbortError

Constructors

constructor +AbortError | Cadenza JS

Class AbortError

Hierarchy

  • DOMException
    • AbortError

Constructors

constructor

Properties

ABORT_ERR DATA_CLONE_ERR DOMSTRING_SIZE_ERR @@ -54,7 +54,7 @@ URL_MISMATCH_ERR VALIDATION_ERR WRONG_DOCUMENT_ERR -

Constructors

constructor

Properties

Readonly ABORT_ERR

ABORT_ERR: 20

Readonly DATA_CLONE_ERR

DATA_CLONE_ERR: 25

Readonly DOMSTRING_SIZE_ERR

DOMSTRING_SIZE_ERR: 2

Readonly HIERARCHY_REQUEST_ERR

HIERARCHY_REQUEST_ERR: 3

Readonly INDEX_SIZE_ERR

INDEX_SIZE_ERR: 1

Readonly INUSE_ATTRIBUTE_ERR

INUSE_ATTRIBUTE_ERR: 10

Readonly INVALID_ACCESS_ERR

INVALID_ACCESS_ERR: 15

Readonly INVALID_CHARACTER_ERR

INVALID_CHARACTER_ERR: 5

Readonly INVALID_MODIFICATION_ERR

INVALID_MODIFICATION_ERR: 13

Readonly INVALID_NODE_TYPE_ERR

INVALID_NODE_TYPE_ERR: 24

Readonly INVALID_STATE_ERR

INVALID_STATE_ERR: 11

Readonly NAMESPACE_ERR

NAMESPACE_ERR: 14

Readonly NETWORK_ERR

NETWORK_ERR: 19

Readonly NOT_FOUND_ERR

NOT_FOUND_ERR: 8

Readonly NOT_SUPPORTED_ERR

NOT_SUPPORTED_ERR: 9

Readonly NO_DATA_ALLOWED_ERR

NO_DATA_ALLOWED_ERR: 6

Readonly NO_MODIFICATION_ALLOWED_ERR

NO_MODIFICATION_ALLOWED_ERR: 7

Readonly QUOTA_EXCEEDED_ERR

QUOTA_EXCEEDED_ERR: 22

Readonly SECURITY_ERR

SECURITY_ERR: 18

Readonly SYNTAX_ERR

SYNTAX_ERR: 12

Readonly TIMEOUT_ERR

TIMEOUT_ERR: 23

Readonly TYPE_MISMATCH_ERR

TYPE_MISMATCH_ERR: 17

Readonly URL_MISMATCH_ERR

URL_MISMATCH_ERR: 21

Readonly VALIDATION_ERR

VALIDATION_ERR: 16

Readonly WRONG_DOCUMENT_ERR

WRONG_DOCUMENT_ERR: 4

Optional cause

cause?: unknown

Readonly code

code: number

Deprecated

MDN Reference

+

Constructors

constructor

Properties

Readonly ABORT_ERR

ABORT_ERR: 20

Readonly DATA_CLONE_ERR

DATA_CLONE_ERR: 25

Readonly DOMSTRING_SIZE_ERR

DOMSTRING_SIZE_ERR: 2

Readonly HIERARCHY_REQUEST_ERR

HIERARCHY_REQUEST_ERR: 3

Readonly INDEX_SIZE_ERR

INDEX_SIZE_ERR: 1

Readonly INUSE_ATTRIBUTE_ERR

INUSE_ATTRIBUTE_ERR: 10

Readonly INVALID_ACCESS_ERR

INVALID_ACCESS_ERR: 15

Readonly INVALID_CHARACTER_ERR

INVALID_CHARACTER_ERR: 5

Readonly INVALID_MODIFICATION_ERR

INVALID_MODIFICATION_ERR: 13

Readonly INVALID_NODE_TYPE_ERR

INVALID_NODE_TYPE_ERR: 24

Readonly INVALID_STATE_ERR

INVALID_STATE_ERR: 11

Readonly NAMESPACE_ERR

NAMESPACE_ERR: 14

Readonly NETWORK_ERR

NETWORK_ERR: 19

Readonly NOT_FOUND_ERR

NOT_FOUND_ERR: 8

Readonly NOT_SUPPORTED_ERR

NOT_SUPPORTED_ERR: 9

Readonly NO_DATA_ALLOWED_ERR

NO_DATA_ALLOWED_ERR: 6

Readonly NO_MODIFICATION_ALLOWED_ERR

NO_MODIFICATION_ALLOWED_ERR: 7

Readonly QUOTA_EXCEEDED_ERR

QUOTA_EXCEEDED_ERR: 22

Readonly SECURITY_ERR

SECURITY_ERR: 18

Readonly SYNTAX_ERR

SYNTAX_ERR: 12

Readonly TIMEOUT_ERR

TIMEOUT_ERR: 23

Readonly TYPE_MISMATCH_ERR

TYPE_MISMATCH_ERR: 17

Readonly URL_MISMATCH_ERR

URL_MISMATCH_ERR: 21

Readonly VALIDATION_ERR

VALIDATION_ERR: 16

Readonly WRONG_DOCUMENT_ERR

WRONG_DOCUMENT_ERR: 4

Optional cause

cause?: unknown

Readonly code

code: number

Deprecated

MDN Reference

Readonly message

message: string

MDN Reference

Readonly name

name: string

MDN Reference

Optional stack

stack?: string

Static Readonly ABORT_ERR

ABORT_ERR: 20

Static Readonly DATA_CLONE_ERR

DATA_CLONE_ERR: 25

Static Readonly DOMSTRING_SIZE_ERR

DOMSTRING_SIZE_ERR: 2

Static Readonly HIERARCHY_REQUEST_ERR

HIERARCHY_REQUEST_ERR: 3

Static Readonly INDEX_SIZE_ERR

INDEX_SIZE_ERR: 1

Static Readonly INUSE_ATTRIBUTE_ERR

INUSE_ATTRIBUTE_ERR: 10

Static Readonly INVALID_ACCESS_ERR

INVALID_ACCESS_ERR: 15

Static Readonly INVALID_CHARACTER_ERR

INVALID_CHARACTER_ERR: 5

Static Readonly INVALID_MODIFICATION_ERR

INVALID_MODIFICATION_ERR: 13

Static Readonly INVALID_NODE_TYPE_ERR

INVALID_NODE_TYPE_ERR: 24

Static Readonly INVALID_STATE_ERR

INVALID_STATE_ERR: 11

Static Readonly NAMESPACE_ERR

NAMESPACE_ERR: 14

Static Readonly NETWORK_ERR

NETWORK_ERR: 19

Static Readonly NOT_FOUND_ERR

NOT_FOUND_ERR: 8

Static Readonly NOT_SUPPORTED_ERR

NOT_SUPPORTED_ERR: 9

Static Readonly NO_DATA_ALLOWED_ERR

NO_DATA_ALLOWED_ERR: 6

Static Readonly NO_MODIFICATION_ALLOWED_ERR

NO_MODIFICATION_ALLOWED_ERR: 7

Static Readonly QUOTA_EXCEEDED_ERR

QUOTA_EXCEEDED_ERR: 22

Static Readonly SECURITY_ERR

SECURITY_ERR: 18

Static Readonly SYNTAX_ERR

SYNTAX_ERR: 12

Static Readonly TIMEOUT_ERR

TIMEOUT_ERR: 23

Static Readonly TYPE_MISMATCH_ERR

TYPE_MISMATCH_ERR: 17

Static Readonly URL_MISMATCH_ERR

URL_MISMATCH_ERR: 21

Static Readonly VALIDATION_ERR

VALIDATION_ERR: 16

Static Readonly WRONG_DOCUMENT_ERR

WRONG_DOCUMENT_ERR: 4

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/CadenzaClient.html b/classes/CadenzaClient.html index 17a8d7e4..23b93d0d 100644 --- a/classes/CadenzaClient.html +++ b/classes/CadenzaClient.html @@ -6,7 +6,7 @@
  • For methods that support the hideMainHeaderAndFooter and hideWorkbookToolBar parameters - the parameters cannot override the configuration of an embedding target.
  • For methods that support the locationFinder and mapExtent parameters - when both are given, the mapExtent takes precedence.
    • -

    Properties

    #baseUrl +

    Properties

    #baseUrl #debug #iframe #iframeElement @@ -34,19 +34,20 @@ on selectObjects setFilter +setSelection show showMap -

    Properties

    Private Readonly #baseUrl

    #baseUrl: string

    Private Readonly #debug

    #debug: boolean

    Private Readonly #iframe

    #iframe: undefined | string | HTMLIFrameElement

    Private #iframeElement

    #iframeElement: undefined | HTMLIFrameElement

    Private Readonly #origin

    #origin: string

    Private #subscriptions

    #subscriptions: [string, ((event) => void)][] = []

    Private Readonly #webApplication

    #webApplication: undefined | ExternalLinkKey

    Accessors

    Private #requiredIframe

    • get #requiredIframe(): HTMLIFrameElement

    • Returns HTMLIFrameElement

    baseUrl

    • get baseUrl(): string

    • The base URL of the Cadenza server this client is requesting

      -

      Returns string

    iframe

    • get iframe(): undefined | HTMLIFrameElement

    • The iframe this client is using for embedding Cadenza.

      -

      Returns undefined | HTMLIFrameElement

    Methods

    Private #createUrl

    • #createUrl(path, params): URL

    • Parameters

      • path: string
      • params: URLSearchParams

      Returns URL

    Private #download

    • #download(path, params): void

    • Parameters

      • path: string
      • params: URLSearchParams

      Returns void

    Private #fetch

    • #fetch(path, params, signal): Promise<Response>

    • Parameters

      • path: string

        Type

        string

        +

    Properties

    Private Readonly #baseUrl

    #baseUrl: string

    Private Readonly #debug

    #debug: boolean

    Private Readonly #iframe

    #iframe: undefined | string | HTMLIFrameElement

    Private #iframeElement

    #iframeElement: undefined | HTMLIFrameElement

    Private Readonly #origin

    #origin: string

    Private #subscriptions

    #subscriptions: [string, ((event) => void)][] = []

    Private Readonly #webApplication

    #webApplication: undefined | ExternalLinkKey

    Accessors

    Private #requiredIframe

    • get #requiredIframe(): HTMLIFrameElement

    • Returns HTMLIFrameElement

    baseUrl

    • get baseUrl(): string

    • The base URL of the Cadenza server this client is requesting

      +

      Returns string

    iframe

    • get iframe(): undefined | HTMLIFrameElement

    • The iframe this client is using for embedding Cadenza.

      +

      Returns undefined | HTMLIFrameElement

    Methods

    Private #createUrl

    • #createUrl(path, params): URL

    • Parameters

      • path: string
      • params: URLSearchParams

      Returns URL

    Private #download

    • #download(path, params): void

    • Parameters

      • path: string
      • params: URLSearchParams

      Returns void

    Private #fetch

    • #fetch(path, params, signal): Promise<Response>

    • Parameters

      • path: string

        Type

        string

      • params: URLSearchParams

        Type

        URLSearchParams

      • signal: undefined | AbortSignal

        Type

        AbortSignal | undefined

        -

      Returns Promise<Response>

    Private #getIframePromise

    • #getIframePromise(signal): Promise<void>

    • Parameters

      • signal: undefined | AbortSignal

      Returns Promise<void>

    Private #log

    • #log(...args): void

    • Parameters

      • Rest ...args: unknown[]

      Returns void

    Private #on

    • #on<TYPE, DETAIL>(type, subscriber): (() => void)

    • Type Parameters

      • TYPE extends string

      • DETAIL = unknown

      Parameters

      Returns (() => void)

      An unsubscribe function

      -
        • (): void

        • Returns void

    Private #onMessage

    • #onMessage(event): void

    • Parameters

      • event: MessageEvent<CadenzaEvent<never, never>>

        Type

        MessageEvent<CadenzaEvent<never, never>>

        -

      Returns void

    Private #postEvent

    • #postEvent(type, detail): void

    • Parameters

      • type: string
      • detail: unknown

      Returns void

    Private #postRequest

    • #postRequest(type, detail): Promise<void>

    • Parameters

      • type: string
      • detail: unknown

      Returns Promise<void>

    Private #show

    • #show(path, params, signal): Promise<void>

    • Parameters

      • path: string

        Type

        string

        +

      Returns Promise<Response>

    Private #getIframePromise

    • #getIframePromise(signal): Promise<void>

    • Parameters

      • signal: undefined | AbortSignal

      Returns Promise<void>

    Private #log

    • #log(...args): void

    • Parameters

      • Rest ...args: unknown[]

      Returns void

    Private #on

    • #on<TYPE, DETAIL>(type, subscriber): (() => void)

    • Type Parameters

      • TYPE extends string

      • DETAIL = unknown

      Parameters

      Returns (() => void)

      An unsubscribe function

      +
        • (): void

        • Returns void

    Private #onMessage

    • #onMessage(event): void

    • Parameters

      • event: MessageEvent<CadenzaEvent<never, never>>

        Type

        MessageEvent<CadenzaEvent<never, never>>

        +

      Returns void

    Private #postEvent

    • #postEvent(type, detail): void

    • Parameters

      • type: string
      • detail: unknown

      Returns void

    Private #postRequest

    • #postRequest(type, detail): Promise<void>

    • Parameters

      • type: string
      • detail: unknown

      Returns Promise<void>

    Private #show

    • #show(path, params, signal): Promise<void>

    • Parameters

      • path: string

        Type

        string

      • params: URLSearchParams

        Type

        URLSearchParams

      • signal: undefined | AbortSignal

        Type

        AbortSignal | undefined

        -

      Returns Promise<void>

    createGeometry

    • createGeometry(backgroundMapView, geometryType, options?): Promise<void>

    • Create a geometry.

      +

    Returns Promise<void>

    createGeometry

    downloadData

    • downloadData(source, dataType, options): void

    • Download data from a workbook view.

      +

    downloadData

    • downloadData(source, dataType, options): void

    • Download data from a workbook view.

      Note: The file name, if not provided, is generated from the name of the workbook view and the current date.

      Parameters

      • source: WorkbookViewSource

        The workbook view to download data from

      • dataType: DataType

        The data type you want to get back from the server

        @@ -72,7 +73,7 @@

        Fires

        • fileName: undefined | string

          The file name to use; The file extension is appended by Cadenza.

        • parts: undefined | TablePart[]

          Table parts to export; If not specified, all parts are exported.

      Returns void

      Throws

      For invalid arguments

      -

    editGeometry

    • editGeometry(backgroundMapView, geometry, options?): Promise<void>

    • Edit a geometry.

      +

    editGeometry

    • editGeometry(backgroundMapView, geometry, options?): Promise<void>

    • Edit a geometry.

      Parameters

    expandNavigator

    • expandNavigator(expanded?): void

    • Expand/collapse the navigator.

      +

    expandNavigator

    • expandNavigator(expanded?): void

    • Expand/collapse the navigator.

      Parameters

      • expanded: boolean = true

        The expansion state of the navigator

        -

      Returns void

    fetchData

    • fetchData(source, dataType, options?): Promise<Response>

    • Fetch data from a workbook view.

      +

    Returns void

    fetchData

    • fetchData(source, dataType, options?): Promise<Response>

    • Fetch data from a workbook view.

      Parameters

      • source: WorkbookViewSource

        The workbook view to fetch data from

      • dataType: DataType

        The data type you want to get back from the server

      • options: {
            parts: undefined | TablePart[];
            signal: undefined | AbortSignal;
        } = {}

        Options

        @@ -98,11 +99,11 @@

        Fires

      • signal: undefined | AbortSignal

        A signal to abort the data fetching

    Returns Promise<Response>

    A Promise for the fetch response

    Throws

    For invalid arguments

    -

    on

    on

    selectObjects

    • selectObjects(backgroundMapView, options?): Promise<void>

    • Select objects in a workbook map.

      +
        • (): void

        • Returns void

    selectObjects

    • selectObjects(backgroundMapView, options?): Promise<void>

    • Select objects in a workbook map.

      Parameters

    setFilter

    • setFilter(filter): Promise<void>

    • Set filter variables in the currently shown workbook.

      +

    setFilter

    • setFilter(filter): Promise<void>

    • Set filter variables in the currently shown workbook.

      Parameters

      Returns Promise<void>

      A Promise for when the filter variables were set.

      -

    show

    • show(source, options?): Promise<void>

    • Show a page, workbook, worksheet or workbook view in an iframe.

      +

    setSelection

    • setSelection(layerPath, values): Promise<void>

    • Set filter Selection in the currently shown map view.

      +

      Parameters

      • layerPath: WorkbookLayerPath

        The variable values

        +
      • values: string[]

        The variable values

        +

      Returns Promise<void>

      A Promise for when the filter variables were set.

      +

    show

    • show(source, options?): Promise<void>

    • Show a page, workbook, worksheet or workbook view in an iframe.

      Parameters

      • source: string | WorkbookKey | WorksheetKey | WorkbookViewKey | PageSource

        The source to show

      • Optional options: {
            dataType: undefined | DataType;
            disabledUiFeatures: undefined | UiFeature[];
            expandNavigator: undefined | boolean;
            filter: undefined | FilterVariables;
            hideMainHeaderAndFooter: undefined | boolean;
            hideWorkbookToolBar: undefined | boolean;
            highlightGlobalId: undefined | string;
            labelSet: undefined | string;
            operationMode: undefined | OperationMode;
            signal: undefined | AbortSignal;
        } = {}
        • dataType: undefined | DataType

          Set to 'pdf' for views of type "JasperReports report" to show the report PDF directly, without any Cadenza headers or footers.

          @@ -135,7 +140,7 @@

          Fires

      Returns Promise<void>

      A Promise for when the iframe is loaded

      Throws

      For invalid arguments

      Fires

      CadenzaDrillThroughEvent

      -

    showMap

    • showMap(mapView, options?): Promise<void>

    • Show a workbook map view in an iframe.

      +

    showMap

    • showMap(mapView, options?): Promise<void>

    • Show a workbook map view in an iframe.

      Parameters

      • mapView: WorkbookViewSource

        The workbook map view to show

      • Optional options: {
            disabledUiFeatures: undefined | UiFeature[];
            expandNavigator: undefined | boolean;
            filter: undefined | FilterVariables;
            geometry: undefined | Geometry;
            hideMainHeaderAndFooter: undefined | boolean;
            hideWorkbookToolBar: undefined | boolean;
            highlightGlobalId: undefined | string;
            locationFinder: undefined | string;
            mapExtent: undefined | Extent;
            operationMode: undefined | OperationMode;
            signal: undefined | AbortSignal;
            useMapSrs: undefined | boolean;
        } = {}

        Options

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/CadenzaError.html b/classes/CadenzaError.html index 86f09a68..9e3af10f 100644 --- a/classes/CadenzaError.html +++ b/classes/CadenzaError.html @@ -1,6 +1,6 @@ CadenzaError | Cadenza JS

    Class CadenzaError

    An Error implementation for errors in the communication with Cadenza.

    Note: For invalid parameters, the Cadenza client will throw "normal" Errors.

    -

    Hierarchy

    • Error
      • CadenzaError

    Constructors

    constructor +

    Hierarchy

    • Error
      • CadenzaError

    Constructors

    constructor

    Properties

    #type cause? message @@ -12,9 +12,9 @@

    Methods

    captureStackTrace

    Constructors

    constructor

    • new CadenzaError(type, message): CadenzaError

    • Parameters

      • type: string

        The technical identifier of the error

      • message: string

        A description of the error

        -

      Returns CadenzaError

    Properties

    Private #type

    #type: string

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns CadenzaError

    Properties

    Private #type

    #type: string

    Optional cause

    cause?: unknown

    message

    message: string

    name

    name: string

    Optional stack

    stack?: string

    Static Optional prepareStackTrace

    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

    See

    https://v8.dev/docs/stack-trace-api#customizing-stack-traces

    -

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    type

    Methods

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      +

    Static stackTraceLimit

    stackTraceLimit: number

    Accessors

    type

    Methods

    Static captureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/cadenza.html b/functions/cadenza.html index b971437a..5026fa95 100644 --- a/functions/cadenza.html +++ b/functions/cadenza.html @@ -9,4 +9,4 @@ target origin when posting events. This is required if Cadenza and your application are not running on the same origin.

    Returns CadenzaClient

    Throws

    For invalid arguments

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/index.html b/index.html index cbb6f8f0..a03169eb 100644 --- a/index.html +++ b/index.html @@ -40,6 +40,7 @@ 
    cadenzaClient.show('{embeddingTargetId}', {
      hideMainHeaderAndFooter: true,
      hideWorkbookToolBar: true,
      operationMode: 'simplified',
      disabledUiFeatures: ['workbook-design'],
      filter: {
        var1: 'foo'
      }
    });
    diff --git a/interfaces/CadenzaEvent.html b/interfaces/CadenzaEvent.html index e9887ec9..3de08189 100644 --- a/interfaces/CadenzaEvent.html +++ b/interfaces/CadenzaEvent.html @@ -1,6 +1,6 @@ CadenzaEvent | Cadenza JS

    Interface CadenzaEvent<TYPE, DETAIL>

    A Cadenza postMessage() event

    -
    interface CadenzaEvent<TYPE, DETAIL> {
        detail: DETAIL;
        type: TYPE;
    }

    Type Parameters

    Properties

    detail +
    interface CadenzaEvent<TYPE, DETAIL> {
        detail: DETAIL;
        type: TYPE;
    }

    Type Parameters

    Properties

    detail type

    Properties

    detail

    detail: DETAIL

    Optional event details (depending on the event type)

    -

    type

    type: TYPE

    The event type

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    type

    type: TYPE

    The event type

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/ExternalLinkKey.html b/interfaces/ExternalLinkKey.html index bf8b6bf6..55530151 100644 --- a/interfaces/ExternalLinkKey.html +++ b/interfaces/ExternalLinkKey.html @@ -1,6 +1,6 @@ ExternalLinkKey | Cadenza JS

    Interface ExternalLinkKey

    A tuple qualifying a Cadenza external link

    -
    interface ExternalLinkKey {
        externalLinkId: string;
        repositoryName: string;
    }

    Properties

    externalLinkId +
    interface ExternalLinkKey {
        externalLinkId: string;
        repositoryName: string;
    }

    Properties

    externalLinkId repositoryName

    Properties

    externalLinkId

    externalLinkId: string

    The ID of the external link

    -

    repositoryName

    repositoryName: string

    The name of the link's repository

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    repositoryName

    repositoryName: string

    The name of the link's repository

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/Geometry.html b/interfaces/Geometry.html index 32bfb79e..bf9d34a6 100644 --- a/interfaces/Geometry.html +++ b/interfaces/Geometry.html @@ -1,4 +1,4 @@ Geometry | Cadenza JS

    Interface Geometry

    A GeoJSON geometry object

    -
    interface Geometry {
        type: GeometryType;
    }

    Properties

    type +
    interface Geometry {
        type: GeometryType;
    }

    Properties

    type

    Properties

    type

    type: GeometryType

    The type of the geometry

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/PageSource.html b/interfaces/PageSource.html index ca9ec926..3dc79720 100644 --- a/interfaces/PageSource.html +++ b/interfaces/PageSource.html @@ -1,4 +1,4 @@ PageSource | Cadenza JS

    Interface PageSource

    A well-known Cadenza page

    -
    interface PageSource {
        page: "welcome";
    }

    Properties

    page +
    interface PageSource {
        page: "welcome";
    }

    Properties

    page

    Properties

    page

    page: "welcome"

    The name of the page (Only "welcome" is currently supported.)

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/WorkbookKey.html b/interfaces/WorkbookKey.html index 65ba523e..b28ca4e1 100644 --- a/interfaces/WorkbookKey.html +++ b/interfaces/WorkbookKey.html @@ -1,6 +1,6 @@ WorkbookKey | Cadenza JS

    Interface WorkbookKey

    A tuple qualifying a workbook

    -
    interface WorkbookKey {
        repositoryName: string;
        workbookId: string;
    }

    Properties

    repositoryName +
    interface WorkbookKey {
        repositoryName: string;
        workbookId: string;
    }

    Properties

    repositoryName workbookId

    Properties

    repositoryName

    repositoryName: string

    The name of the workbook's repository

    -

    workbookId

    workbookId: string

    The ID of the workbook

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    workbookId

    workbookId: string

    The ID of the workbook

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/WorkbookViewKey.html b/interfaces/WorkbookViewKey.html index 973764b2..437c1769 100644 --- a/interfaces/WorkbookViewKey.html +++ b/interfaces/WorkbookViewKey.html @@ -1,8 +1,8 @@ WorkbookViewKey | Cadenza JS

    Interface WorkbookViewKey

    A tuple qualifying a workbook view

    -
    interface WorkbookViewKey {
        repositoryName: string;
        viewId: string;
        workbookId: string;
    }

    Properties

    repositoryName +
    interface WorkbookViewKey {
        repositoryName: string;
        viewId: string;
        workbookId: string;
    }

    Properties

    repositoryName viewId workbookId

    Properties

    repositoryName

    repositoryName: string

    The name of the workbook's repository

    -

    viewId

    viewId: string

    The ID of the view

    -

    workbookId

    workbookId: string

    The ID of the workbook

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    viewId

    viewId: string

    The ID of the view

    +

    workbookId

    workbookId: string

    The ID of the workbook

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/WorksheetKey.html b/interfaces/WorksheetKey.html index 4bd47100..8da8bfde 100644 --- a/interfaces/WorksheetKey.html +++ b/interfaces/WorksheetKey.html @@ -1,8 +1,8 @@ WorksheetKey | Cadenza JS

    Interface WorksheetKey

    A tuple qualifying a worksheet

    -
    interface WorksheetKey {
        repositoryName: string;
        workbookId: string;
        worksheetId: string;
    }

    Properties

    repositoryName +
    interface WorksheetKey {
        repositoryName: string;
        workbookId: string;
        worksheetId: string;
    }

    Properties

    repositoryName workbookId worksheetId

    Properties

    repositoryName

    repositoryName: string

    The name of the workbook's repository

    -

    workbookId

    workbookId: string

    The ID of the workbook

    -

    worksheetId

    worksheetId: string

    The ID of the worksheet

    -

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file +

    workbookId

    workbookId: string

    The ID of the workbook

    +

    worksheetId

    worksheetId: string

    The ID of the worksheet

    +

    Settings

    Member Visibility

    Theme

    On This Page

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CadenzaChangeExtentEvent.html b/types/CadenzaChangeExtentEvent.html index 45d0fc95..5c9351c5 100644 --- a/types/CadenzaChangeExtentEvent.html +++ b/types/CadenzaChangeExtentEvent.html @@ -1,3 +1,3 @@ CadenzaChangeExtentEvent | Cadenza JS

    Type alias CadenzaChangeExtentEvent

    CadenzaChangeExtentEvent: CadenzaEvent<"change:extent", {
        extent: Extent;
    }>

    When the user moved the map. The extent is transformed according to the useMapSrs option.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CadenzaDrillThroughEvent.html b/types/CadenzaDrillThroughEvent.html index a2f27ac9..2d485b52 100644 --- a/types/CadenzaDrillThroughEvent.html +++ b/types/CadenzaDrillThroughEvent.html @@ -4,4 +4,4 @@ the attributes that were selected for the POST message content. If the drill-through was executed from a map view, each row includes the geometry of the selected object as the last value.

    -See also: JSON Representation of Cadenza Object Data

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +See also: JSON Representation of Cadenza Object Data

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CadenzaEditGeometryCancelEvent.html b/types/CadenzaEditGeometryCancelEvent.html index 24fc52ea..bf805866 100644 --- a/types/CadenzaEditGeometryCancelEvent.html +++ b/types/CadenzaEditGeometryCancelEvent.html @@ -1,2 +1,2 @@ CadenzaEditGeometryCancelEvent | Cadenza JS

    Type alias CadenzaEditGeometryCancelEvent

    CadenzaEditGeometryCancelEvent: CadenzaEvent<"editGeometry:cancel">

    When the user cancelled the geometry editing.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CadenzaEditGeometryOkEvent.html b/types/CadenzaEditGeometryOkEvent.html index f8b3e73d..c55f5997 100644 --- a/types/CadenzaEditGeometryOkEvent.html +++ b/types/CadenzaEditGeometryOkEvent.html @@ -1,2 +1,2 @@ CadenzaEditGeometryOkEvent | Cadenza JS

    Type alias CadenzaEditGeometryOkEvent

    CadenzaEditGeometryOkEvent: CadenzaEvent<"editGeometry:ok", {
        geometry: Geometry;
    }>

    When the user submitted the geometry.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CadenzaEditGeometryUpdateEvent.html b/types/CadenzaEditGeometryUpdateEvent.html index b24aedb5..71012525 100644 --- a/types/CadenzaEditGeometryUpdateEvent.html +++ b/types/CadenzaEditGeometryUpdateEvent.html @@ -1,2 +1,2 @@ CadenzaEditGeometryUpdateEvent | Cadenza JS

    Type alias CadenzaEditGeometryUpdateEvent

    CadenzaEditGeometryUpdateEvent: CadenzaEvent<"editGeometry:update", {
        geometry: Geometry;
    }>

    When the user changed the geometry.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CadenzaErrorEvent.html b/types/CadenzaErrorEvent.html index c4aa5d28..d054d900 100644 --- a/types/CadenzaErrorEvent.html +++ b/types/CadenzaErrorEvent.html @@ -1,2 +1,2 @@ CadenzaErrorEvent | Cadenza JS

    Type alias CadenzaErrorEvent

    CadenzaErrorEvent: CadenzaEvent<"error", {
        message?: string;
        type: string;
    }>

    An error event that is mapped to a CadenzaError

    -

    Type declaration

    • Optional message?: string
    • type: string

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CadenzaEventByType.html b/types/CadenzaEventByType.html index cd2bd9ed..c635986f 100644 --- a/types/CadenzaEventByType.html +++ b/types/CadenzaEventByType.html @@ -1 +1 @@ -CadenzaEventByType | Cadenza JS

    Type alias CadenzaEventByType<T>

    CadenzaEventByType<T>: T extends "change:extent"
        ? CadenzaChangeExtentEvent
        : T extends "drillThrough"
            ? CadenzaDrillThroughEvent
            : T extends "editGeometry:update"
                ? CadenzaEditGeometryUpdateEvent
                : T extends "editGeometry:ok"
                    ? CadenzaEditGeometryOkEvent
                    : T extends "editGeometry:cancel"
                        ? CadenzaEditGeometryCancelEvent
                        : T extends "selectObjects:update"
                            ? CadenzaEditGeometryUpdateEvent
                            : T extends "selectObjects:ok"
                                ? CadenzaEditGeometryOkEvent
                                : T extends "selectObjects:cancel"
                                    ? CadenzaEditGeometryCancelEvent
                                    : never

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +CadenzaEventByType | Cadenza JS

    Type alias CadenzaEventByType<T>

    CadenzaEventByType<T>: T extends "change:extent"
        ? CadenzaChangeExtentEvent
        : T extends "drillThrough"
            ? CadenzaDrillThroughEvent
            : T extends "editGeometry:update"
                ? CadenzaEditGeometryUpdateEvent
                : T extends "editGeometry:ok"
                    ? CadenzaEditGeometryOkEvent
                    : T extends "editGeometry:cancel"
                        ? CadenzaEditGeometryCancelEvent
                        : T extends "selectObjects:update"
                            ? CadenzaEditGeometryUpdateEvent
                            : T extends "selectObjects:ok"
                                ? CadenzaEditGeometryOkEvent
                                : T extends "selectObjects:cancel"
                                    ? CadenzaEditGeometryCancelEvent
                                    : never

    Type Parameters

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CadenzaEventType.html b/types/CadenzaEventType.html index 3bc672d7..7506af10 100644 --- a/types/CadenzaEventType.html +++ b/types/CadenzaEventType.html @@ -1,2 +1,2 @@ CadenzaEventType | Cadenza JS

    Type alias CadenzaEventType

    CadenzaEventType: "change:extent" | "drillThrough" | "editGeometry:ok" | "editGeometry:update" | "editGeometry:cancel" | "selectObjects:ok" | "selectObjects:update" | "selectObjects:cancel"

    An event type to subscribe to using CadenzaClient#on

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CadenzaSelectObjectsCancelEvent.html b/types/CadenzaSelectObjectsCancelEvent.html index c45b8bd7..d4f7dd77 100644 --- a/types/CadenzaSelectObjectsCancelEvent.html +++ b/types/CadenzaSelectObjectsCancelEvent.html @@ -1,2 +1,2 @@ CadenzaSelectObjectsCancelEvent | Cadenza JS

    Type alias CadenzaSelectObjectsCancelEvent

    CadenzaSelectObjectsCancelEvent: CadenzaEvent<"selectObjects:cancel">

    When the user cancelled the selection.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CadenzaSelectObjectsOkEvent.html b/types/CadenzaSelectObjectsOkEvent.html index 08e1e508..89312429 100644 --- a/types/CadenzaSelectObjectsOkEvent.html +++ b/types/CadenzaSelectObjectsOkEvent.html @@ -1,2 +1,2 @@ CadenzaSelectObjectsOkEvent | Cadenza JS

    Type alias CadenzaSelectObjectsOkEvent

    CadenzaSelectObjectsOkEvent: CadenzaEvent<"selectObjects:ok", {
        layer: WorkbookLayerPath;
        values: unknown[][];
    }>

    When the user submitted the selection.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CadenzaSelectObjectsUpdateEvent.html b/types/CadenzaSelectObjectsUpdateEvent.html index fa8e7104..340bc618 100644 --- a/types/CadenzaSelectObjectsUpdateEvent.html +++ b/types/CadenzaSelectObjectsUpdateEvent.html @@ -1,2 +1,2 @@ CadenzaSelectObjectsUpdateEvent | Cadenza JS

    Type alias CadenzaSelectObjectsUpdateEvent

    CadenzaSelectObjectsUpdateEvent: CadenzaEvent<"selectObjects:update", {
        layer: WorkbookLayerPath;
        values: unknown[][];
    }>

    When the user changed the selection.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/DataType.html b/types/DataType.html index e9b8acc8..bdc821d3 100644 --- a/types/DataType.html +++ b/types/DataType.html @@ -1,3 +1,3 @@ DataType | Cadenza JS

    Type alias DataType

    DataType: "csv" | "excel" | "json" | "pdf"

    A data type

    See JSON Representation of Cadenza Object Data for JSON data.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/EmbeddingTargetId.html b/types/EmbeddingTargetId.html index 04d6da24..c0aa50f0 100644 --- a/types/EmbeddingTargetId.html +++ b/types/EmbeddingTargetId.html @@ -1,2 +1,2 @@ EmbeddingTargetId | Cadenza JS

    Type alias EmbeddingTargetId

    EmbeddingTargetId: string

    The ID of an embedding target

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/Extent.html b/types/Extent.html index f3feacf5..078e52e0 100644 --- a/types/Extent.html +++ b/types/Extent.html @@ -1,2 +1,2 @@ Extent | Cadenza JS

    Type alias Extent

    Extent: [number, number, number, number]

    An array of numbers representing an extent: [minx, miny, maxx, maxy]

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/FilterVariables.html b/types/FilterVariables.html index ab923218..3f0d7edb 100644 --- a/types/FilterVariables.html +++ b/types/FilterVariables.html @@ -1,2 +1,2 @@ FilterVariables | Cadenza JS

    Type alias FilterVariables

    FilterVariables: Record<string, string | string[] | number | Date | null>

    Filter variable names and values

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/GeometryType.html b/types/GeometryType.html index 5bc0e41e..ba80e667 100644 --- a/types/GeometryType.html +++ b/types/GeometryType.html @@ -1,3 +1,3 @@ GeometryType | Cadenza JS

    Type alias GeometryType

    GeometryType: "Point" | "MultiPoint" | "LineString" | "MultiLineString" | "Polygon" | "MultiPolygon"

    A GeoJSON geometry type

    Note: The GeoJSON geometry type "GeometryCollection" is currently not supported.

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/GlobalId.html b/types/GlobalId.html index 1974ab62..1cba3f8d 100644 --- a/types/GlobalId.html +++ b/types/GlobalId.html @@ -1,2 +1,2 @@ GlobalId | Cadenza JS

    Type alias GlobalId

    GlobalId: string

    The ID of a navigator item

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/OperationMode.html b/types/OperationMode.html index 42aad2cb..635be6d5 100644 --- a/types/OperationMode.html +++ b/types/OperationMode.html @@ -1,2 +1,2 @@ OperationMode | Cadenza JS

    Type alias OperationMode

    OperationMode: "normal" | "simplified"

    The mode in which a workbook should be operated

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/TablePart.html b/types/TablePart.html index 79e46553..99a842cc 100644 --- a/types/TablePart.html +++ b/types/TablePart.html @@ -1,2 +1,2 @@ TablePart | Cadenza JS

    Type alias TablePart

    TablePart: "columns" | "values" | "totals"

    A part of a table to export

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/UiFeature.html b/types/UiFeature.html index de96a5ab..5e7e5b69 100644 --- a/types/UiFeature.html +++ b/types/UiFeature.html @@ -4,4 +4,4 @@
  • 'workbook-design' - The workbook designer
  • 'workbook-view-management' - Add/Edit/Remove workbook views (Is included in 'workbook-design'.)
    • -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/WorkbookLayerPath.html b/types/WorkbookLayerPath.html index 6902d98d..4c520196 100644 --- a/types/WorkbookLayerPath.html +++ b/types/WorkbookLayerPath.html @@ -1,3 +1,3 @@ WorkbookLayerPath | Cadenza JS

    Type alias WorkbookLayerPath

    WorkbookLayerPath: string[]

    Identifies a workbook layer within a view using the print names of the layer and - if the layer is grouped - its ancestors

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/WorkbookSource.html b/types/WorkbookSource.html index 019dcaf8..bfb36a4e 100644 --- a/types/WorkbookSource.html +++ b/types/WorkbookSource.html @@ -1,2 +1,2 @@ WorkbookSource | Cadenza JS

    Type alias WorkbookSource

    WorkbookSource: EmbeddingTargetId | WorkbookKey

    A workbook source

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/WorkbookViewSource.html b/types/WorkbookViewSource.html index 737c624f..0552d905 100644 --- a/types/WorkbookViewSource.html +++ b/types/WorkbookViewSource.html @@ -1,2 +1,2 @@ WorkbookViewSource | Cadenza JS

    Type alias WorkbookViewSource

    WorkbookViewSource: EmbeddingTargetId | WorkbookViewKey

    A workbook view source

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/WorksheetSource.html b/types/WorksheetSource.html index 46c652ad..bbe2f0a5 100644 --- a/types/WorksheetSource.html +++ b/types/WorksheetSource.html @@ -1,2 +1,2 @@ WorksheetSource | Cadenza JS

    Type alias WorksheetSource

    WorksheetSource: EmbeddingTargetId | WorksheetKey

    A worksheet source

    -

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    Generated using TypeDoc

    \ No newline at end of file