diff --git a/assets/search.js b/assets/search.js index e9032cab..7e6b186b 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7WbWXPbOBKA/4v8qijGSdtvU5nM1NROJqmaJPvgcrkoCZa5pkktRdnJuPzfl+AhdoMNCbS0L3Ek9IX+GhcJvUyK/Hkzubp+mTwk2XJypeV0ksWPZnI1WcRLk/0TT6aTbZFWn++22aJM8mzzvm2Z3ZePadW8SOPNxlRWJpPXaWeI8YudpQ+N/Ic0MVm5s9eqvUet+22e8z68s3m8Md+KNMDe2W0v2xsuN8t3yebdukie4tJUTeu4sPG58fr850WySrIg9zvR03lP7gr7vxDvO9HTeX8281/W6zRZxLYigqIYqJw6Fx9T8xhWX11Keo3TxbI08+0qKIZO8nS+N9v5ZlEk63qUBsXgahwTC9ecyT6aEcOTGp1v8Bg+JIgR8QZ/Z4X57zYpzPKP8LE4UDkq4+eyn2Q39/lzSAit3Mieu54+xetQZ43oEf7Mj3WcLf+Kn5JVXOZFiN+hyhH+F4WpgPxu8kdTFj9D3A80jun9MinH+Hbkj+FsUrMoP8//U/0bNJ24Ckf4Pgst59tBPR85js5WpmxG55cif0w2YeOaUDpZRGELrLOmhnjRSgm9c3N7W/5cB/U2z2Z59o7NdhoBbme1kjfpefbJbDbxKizbUPp04Nf5pvz4FLqFgNIni+HOlIv7X+MyDgkBCh8z1Go7QX3uJE/W32X+nKV5vAztsiN/TK87U2F7tV74dPXWrBKhRxgofboY0jxss9rIHbVVBQfCX+Z5UX4sCmIx75v2HgUV4/36XO1dy2K7oPYGjrkzLEvXD4hu73mW7gBsPEkXBgaDOoFi9B0Y9k34wN9wmj+I3/XrbJ0DHYcsLwNP55cRU31qPz7OzXKZZKuvcWFX6X7AW+ub94P2vdBc67+n+TxOB0a7r/fbUv3i+/FHaYosTv9Msod/mX6jl2TV93fxwgaKRcKflBSmWquSqlh+/gWPKQdMnw3UaAxu5J4gDBAD6ToUxEBtbBAwyf/Oi4d5nvsSDJpPmVzXbGhiYbQe58+tCJ3QgWMkPsapm8TNvTHlnix27adOI7I7Jo+7gN+cSOw6MJMhbmuZMX57hVGOqYHwPTHPBwZDK/L/GBDQ9NhB0UV+1MBAAYwYHAecP1XNIxzvxMc6ddeiTvLP+KcpvsRlv6dvFqVBe/Dq9KU6av2db4sFybNvDa+SNTzq+W2drd1DHkwNCOtwVpz4cUoCwqfs1sPMaxi0jrbcEd8bdS8wyv7ntSnqh/Cf8qVrGrWNsvot+a06oGwL1+Lu++BqGzztAvXRtYVXGtpq+izt32nuAtqzD2xFvkJv7V4QNI3KqN3UgIcR7Xa1/nKUHXtYJuLqvh5l62s8T82XuHDD2n0/ytpvSVrx+B4XiVXfODad1uD66Q4G6FEOIA/bj6+jgbW6lt6xg+eWpz2vcpamjJM0zF0jO96hC6MV+7VI0vTrfZFvV/c4hQ0Vn9go8F1I4Fn1t/WyOkru8egRPtbv54dAn63gsf4+xNnCpIE+gfCb/Nqz8T5Xu/a3WP8bPu4/iM8nfbTnvQApyaM9HkTok6Y830yr4b00PyZXL5MnU2zsy/GrCZ+J2WUleZeYdGkvaDTxVKr5Y/3O+qZt+27sYyAr0Yi8P59Mr8+n4nKm5c3N9LpTqL+vv6ilqtnimhFSDEnx6hOfCjlTgiMxjsRE9UkQxgSSktUnSRmTSExVnxRhTCEpXX3ShJRGUlH1KSKkIiR1UX26IKQukNSlLxeXOLHnvm4yh4BN9SWFADNgNtfsnLSIMTCbb0ZSxSSYzTjjlCBmwWzSGYWWYRzM5p1JShATYTb1jOLLMBR24e82BsMsAEYVA8NouAXAqHrgGA2vRwdVEtwZHzUbCiLHaLgFwKlhyTEabgFwiiHHaLgFwCmGHKPhFgCnGHKMhlsAnGLIMRpu888phhyT4fWYochwTEbY/HOKjMBkhM0/v6CqQmA0op67KDTCmbyE3yRmIywBcT7lFzOtHJsYjlB+SUxHWAaC4i0wHWEZCIq3wHSEZSDI6RjTEZaBkGSQGI+0EAQFXGI80jIQFHCJ6Uju9S0xHlkvLlVpsBnTEZZ01pcaDzVqJaYjld85piO13znGI2s8VLlJjEdaCJKaCSTGI/14JMajzr1RKsxHWQqSqjaF+SgLQVLVpjAeZRlIqtoUpqPq5Z+aXZSz/lsEktwBYDjKEpBUsSnMRlkCkppdFGajajZUBSnMRlkAkqKtMBpt868o2hqT0cw7Y2iMRlsAimKoMRptASiKocZotAWgKIYao9H13oxiqJ3dmQWgKIYao9EWgCI3chiNvvDnB7PRloCiaGvMJqrZULQjzCayABRFO8JoIgtAU7QjjCayADTFMMJoIgtAUwwjjCayADTFMMJoonrnTDGMnL2zBaAphlGDpj64VCeW0iz/aA4w1RGkuxL0MrltTzVs9978ZVJtn65eXl/7U4z9ZE3H9pW7ad6n96rVjmCnWm0EaFV7edQewaAe8GjlppNLj/LujnuvfN4r+1y2Wov2Pjvoa6/r62mru7SPT8rm8Yl5cswokLLoQBD2ut+qfVqwqE+aA3MahFXVV7C5/GFoCmQn4uGmtvV5f9jRS2DuQMaG1QGUxaFYrPKwN6BQqvG038Igdt0rV5PVXuXmYmTePA/wUVIgmDH2KEwS2NIjbHk4VRNLb0/57MFbKQATKGbBmuEovFVYX3Ja7V4AgKEFQmDeEGp1dzYAia0OKLRm1e3YnbkUcKl95dHe4u+1wJzlo9g93QWugJb2TVb9JTTQOUCae/21isv61hxQBh3kvjKBwxgBAZ6ZV7m7XFPWl2sSFLsA85LwWqhvcmf9TW4QARi+zMfHtC9RQK6BmvYVYnfvJE2yBydqUE7SNzlD9QeD8iZA0oWvHNuLlgAVXNN85V9rDSCDLHNflu7qVy1P/YsYkC7QX+2jRBWIAmuF9iWqUxyMPRC19k3utqLqS9fr7tI1KA4wPTPfiFrV17QcviDTwjeiuh+Q9GpgNMhmkmO+PjfKpvvxEZhmQZ89uvU9TAAXqHBfL+3NcJAYMNVwX4h59thdsAaaYMHlPiZ59wL5sX65DBIE1gHlq/vuh3IAB6DhUVo7cUrAQvkq3ipt2pfrQBW4U15/+aYcLJEcVDv3afaXXDKnfASIWVw2BSTbzatU7V8f4O5HRcOqBMSYb3+FNgCINxj5zDcSmp9fACWQB9Z2gPlwW+VH+/MgoA/30L48Oj9b67VBjfl8lnaGW9dvsMF0A9KvfdOrO0cJ0FXRDnrRstLtTkf7wtgmd911CVB+gJfy0bb3hfCUJUHOlA/zs5nH8PeXoPNA26fc3jhxpkowlUjRFqlu/irf1NKZcpdFMJNJbx9a3dTeYFrXN5xAFsDErXzTU2eBGPowDYfyYBk4HZCgGqSPOtQnQgD5VL4Bt7sC6LAApSMP6rrJB+NG+mbMnTIROICnyKXrZjpZJ2tT7Ycqoeub19f/AaS7w7p6PgAA"; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA7WbS3PbOBKA/4t8VRzjScm3qUxmamonk9ROkj2kXClKgm2uaVJLUnayrvz3JfgQu8GGBEbaSxwK/UJ/DRAgwZdZkT+Xs+svL7OHJNvMrrWcz7L40cyuZ+t4Y7L/xrP5bFek9fXtLltXSZ6Vr7uWy/vqMa2b12lclqa2Mpv9mPeGGF/sLb1p5d+kicmqvb1O7TVqPWzzig/hXazi0nwq0gB7F18H2cFwVW5eJeWrbZE8xZWpm7ZxYeNz4/X5z4vkLsmC3O9Fz+c9uS3s/0K870XP5/3ZrH7ZbtNkHduKCIpipHLuXLxNzWNYffUpGTTOF8vGrHZ3QTH0kufzXe5W5bpIts0oDYrB1TglFq45k0M0E4YnNTp/wmP4kCBGxE/4uyjMf3ZJYTZ/hI/FkcpJGb+SwyRb3ufPISF0chN77np6F29DnbWiJ/gz37Zxtvkrfkru4iovQvyOVU7pr6l+S9LKBHmGwif4XBemLoLfTf5oquJ7iOORxikZ3yTVFN+O/Em5Ts26er/6d/1v0BTmKpzg+yJ0CH0djaETx+7FnanaGeFDkT8mZdhcQiidL6JtXlb/rCcrU4bdUbH82eIIW1w464kQL1opofduvn6tvm+Dsp5nl3n2il3uNQLcXjZK3lTn2TtTlvFdGHUofV7cb59Cl09Q+mwx3Jpqff9rXMUhIUDhU4Z8Yyeoz73k2fq7yZ+zNI83oV125E/pdW8qbJ06CJ+v3tq7Vej2DUqfL4Y0D1uot3InLdPBZviXVV5Ub4uCWMgMTQe3wYrxYZ1Qr9urYrem1kWOuQssS9cPiO7gXp7uAGw8SxdGBoM6gWL0bZYOTfjA33iaP4rf9etsGwIdh9xeRp6ulhFTQ2rfPq7MZpNkdx/jwq4WhgFvrZevR+0HobnWf0/zVZyOjPY/H7alhpvv22/1cjmL0z+T7OEfZlhwJln9+228toFikfCnRIWp71VJXSzf/4JbtCOmL0ZqNAY3ck8QBoiBdB0LYqQ2NQiY5H/lxcMqz30JBs3nTK5rNjSxMFqP8+dOhE7oyDESn+LUTWJ5b0x1IIt9+7nTiOxOyeM+4J9OJHYdmMkQt43MFL+DwiTH1ED4nJjnI4OhE/l/DAhoeuqg6CM/aWCgACYMjiPOn+rmCY734lOduveiXvLP+LspPsTVsKZvb0qj9uC704d6q/V3vivWJM+hNbxKtnCr57d1sXU3eTA1IKzjWXHixykJCJ+y2wwzr2HQOtlyT/xg1IPAJPvvt6ZoXkC8yzeuadQ2yeqn5Ld6g7IrXIv734OrbfTUDdRH3xZeaWip6bN0eKW5D+jAOrAT+Qi9dWtB0DQpo3ZRAx5GdMvV5sdJduxmmYir/3mSrY/xKjUf4sINa//7JGvtU+LPcZFY9dKx6bQG10+/MUCPcgB52H56HY2sNbX0ih3dtzwdeI21MVWcpGHuWtnpDl0YndivRZKmH++LfHd3j1PYUvGJTQLfhwSemX/abuqt5AGPHuFT/b5/CPTZCZ7q702crU0a6BMI/5Rfuzc+5Grf/jPW/4avHY7i80mf7PkgQEryZI9HEfqkKc8383p4b8y32fXL7MkUpT0YcD3jl+JyWUveJibd2MMpbTy1av7YvK+/6do+G/sYyEq0Iq+vZvMvV3OxvFwsb27mX3qF5vfmh0aqni2+MEKKISleX/G5kJfRgiMxjsREfSUIYwJJyfpKUsYkElP1lSKMKSSl6ytNSGkkFdVXESEVIalFfbUgpBZIaunLxRIn9srXTeYQsKleUggwA2Zzza5IixgDs/lmJFVMgtmMM04JYhbMJp1RaBnGwWzemaQEMRFmU88ovgxDYTb7jELMMBe29OcHo+EWAKPqgWM0vBkdVElwZ3w0bCiIHKPhFgCnhiXHaLgFwCmGHKPhFgCnGHKMhlsAnGLIMRpuAXCKIcdouAXAKYYco+HNmKEYckxG2PxziozAZITNP6fICExGNFMXRUY4c1czeZHlIzAaYQEICo3AaITym8RshCUg+JwvLpdXEktiOCLyS2I6wjIQ5HSM6QjLQFC8BaYjLQNB8ZaYjrQMhKaClBiPtBAEBVxiPLLBQwGXzt1F+n1jPLLBU5cGu5QswpIYj7QMJDVqJaYjI79zTEcu/M4xHmkhSKrcJMajmjsONRMojEf58SiMR3FvlArzUZaCpKpNYT6quf1T1aac+79lIMkVAKajGjrU7KIwHWURSKrYFIajLAFJFZvCbFTDhppdFGajLQFFVZDGbLQFoCjaGqPRNv+Koq0xGS28M4bGaLQFoCiGGqPRzdqMYqid1ZkFoCiGGqPRFoAiF3IYjbYAFMVQYzTaAlAUQ43RRFfe/ESYTdSwoWhHmE1kCWiKdoTZRBaApmhHGE1kAWiKdoTRRBaAphhGGE3UrJwphpGzdrYANMUwwmgiC0BTDCOMJrIANLkeb9E0W6F6D1SZzR/tlqje1PSHjF5mX7t9Ur2O6nZnL7N6+XT98uPHsC+yV9Z0bF/im/YNPVBdDqr1QoBWtUdx7aYO6gGPVm4+W3qU918MDMog3KvDWuvu64BBlw267LDuxj6QqdoHMubJMaNBDJGv350he5Dxrnv+sG72rmNzAphT4ebyh7EpkNq6poNN7ZonCGNzIGGRrzZ6c251CKAsjsVilcfuJXCvj1hwldViUNZH6qs98pm3Txh8lCIQzBR7FCYNbC0m2PJxUsBe5LMHz7kATKCYhWiHo/BWYXNs6m7/SgEMLcCKeVk16u5sABIrfEO67nbszlwK9Fr7XHbfRAxaEKNXp31eDFyBmS7yTR3DsTbQOUCa+6qmV9w05/CAMugg95UJHMYICFBmvp6a/rhO1RzXSVDsAsxLwuu+ORefDefiQQRgMmK+CcB0r2VArkElaV8h9idZ0iR7cKIGgKVvcobqDwblTYC8SV85dkc3ASoQNPdlu9EaQQZZ5r4qvm1e3jwNr3ZAukB/tY8SVSAK4NG+RPWKo7EHotY+traimuPk2/44OSgOEDb3pfmuOfjl8AWZFr4R1X+OM6gBLdlOcszntVU2/adcYJoFffboNic7AVxwExK+ecOeNQeJAVMN92HJs8f+yDZwBm643Mck719JPzavqwFRcB/QvtT0nx0CHKCDHqWtE6cEeVS+RFqlsntdD1TB4FS+ucGeJR/dIjlcdB7SLPpPDgASQJH7KA5HbjKn9ATor2Rt8cmuCGXU/lV+s+3nXeOKBnXCfNpo8YC6BGJivlmjNNVt9+UR0ATEmS+R7ecsQAkUF+vW/Mw3eK3yo/3EC+jDlbuvzpxPDwdtgM/X1crOq9vmTTwYEnDA+yZ1d2YUoNCE7tZTHWXdra8i3/jaJbf9sQ8QBui89pG2557wRCkBKOXL2bNZxfAbWuAVaPuUu5MzzgQNClOqrswXXZn7JrTelHszBuiktw+dbmpPYm2bk1ogC2DiV75JsbdATDjgNqV8JdCrWwZOBySoBuWjDvWJEEA+lW/M7I8yOjUASkce1XVjB4NW+ubpvTIROICnyIF3M59tk62pV2G10JebHz/+Bx8+g6A+QAAA"; \ No newline at end of file diff --git a/classes/AbortError.html b/classes/AbortError.html index 40663013..0807407c 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

Properties

ABORT_ERR: 20
DATA_CLONE_ERR: 25
DOMSTRING_SIZE_ERR: 2
HIERARCHY_REQUEST_ERR: 3
INDEX_SIZE_ERR: 1
INUSE_ATTRIBUTE_ERR: 10
INVALID_ACCESS_ERR: 15
INVALID_CHARACTER_ERR: 5
INVALID_MODIFICATION_ERR: 13
INVALID_NODE_TYPE_ERR: 24
INVALID_STATE_ERR: 11
NAMESPACE_ERR: 14
NETWORK_ERR: 19
NOT_FOUND_ERR: 8
NOT_SUPPORTED_ERR: 9
NO_DATA_ALLOWED_ERR: 6
NO_MODIFICATION_ALLOWED_ERR: 7
QUOTA_EXCEEDED_ERR: 22
SECURITY_ERR: 18
SYNTAX_ERR: 12
TIMEOUT_ERR: 23
TYPE_MISMATCH_ERR: 17
URL_MISMATCH_ERR: 21
VALIDATION_ERR: 16
WRONG_DOCUMENT_ERR: 4
cause?: unknown
code: number

Deprecated

MDN Reference

+

Constructors

Properties

ABORT_ERR: 20
DATA_CLONE_ERR: 25
DOMSTRING_SIZE_ERR: 2
HIERARCHY_REQUEST_ERR: 3
INDEX_SIZE_ERR: 1
INUSE_ATTRIBUTE_ERR: 10
INVALID_ACCESS_ERR: 15
INVALID_CHARACTER_ERR: 5
INVALID_MODIFICATION_ERR: 13
INVALID_NODE_TYPE_ERR: 24
INVALID_STATE_ERR: 11
NAMESPACE_ERR: 14
NETWORK_ERR: 19
NOT_FOUND_ERR: 8
NOT_SUPPORTED_ERR: 9
NO_DATA_ALLOWED_ERR: 6
NO_MODIFICATION_ALLOWED_ERR: 7
QUOTA_EXCEEDED_ERR: 22
SECURITY_ERR: 18
SYNTAX_ERR: 12
TIMEOUT_ERR: 23
TYPE_MISMATCH_ERR: 17
URL_MISMATCH_ERR: 21
VALIDATION_ERR: 16
WRONG_DOCUMENT_ERR: 4
cause?: unknown
code: number

Deprecated

MDN Reference

message: string
name: string
stack?: string
ABORT_ERR: 20
DATA_CLONE_ERR: 25
DOMSTRING_SIZE_ERR: 2
HIERARCHY_REQUEST_ERR: 3
INDEX_SIZE_ERR: 1
INUSE_ATTRIBUTE_ERR: 10
INVALID_ACCESS_ERR: 15
INVALID_CHARACTER_ERR: 5
INVALID_MODIFICATION_ERR: 13
INVALID_NODE_TYPE_ERR: 24
INVALID_STATE_ERR: 11
NAMESPACE_ERR: 14
NETWORK_ERR: 19
NOT_FOUND_ERR: 8
NOT_SUPPORTED_ERR: 9
NO_DATA_ALLOWED_ERR: 6
NO_MODIFICATION_ALLOWED_ERR: 7
QUOTA_EXCEEDED_ERR: 22
SECURITY_ERR: 18
SYNTAX_ERR: 12
TIMEOUT_ERR: 23
TYPE_MISMATCH_ERR: 17
URL_MISMATCH_ERR: 21
VALIDATION_ERR: 16
WRONG_DOCUMENT_ERR: 4

Generated using TypeDoc

\ No newline at end of file diff --git a/classes/CadenzaClient.html b/classes/CadenzaClient.html index 731af057..bc62d34a 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

    Properties

    #baseUrl: string
    #debug: boolean
    #iframe: undefined | string | HTMLIFrameElement
    #iframeElement: undefined | HTMLIFrameElement
    #origin: string
    #subscriptions: [string, ((event) => void)][] = []
    #webApplication: undefined | ExternalLinkKey

    Accessors

    • get #requiredIframe(): HTMLIFrameElement
    • Returns HTMLIFrameElement

    • get baseUrl(): string
    • The base URL of the Cadenza server this client is requesting

      -

      Returns string

    • get iframe(): undefined | HTMLIFrameElement
    • The iframe this client is using for embedding Cadenza.

      -

      Returns undefined | HTMLIFrameElement

    Methods

    • Parameters

      • path: string
      • params: URLSearchParams

      Returns URL

    • Parameters

      • path: string
      • params: URLSearchParams

      Returns void

    • Parameters

      • path: string

        Type

        string

        +

    Properties

    #baseUrl: string
    #debug: boolean
    #iframe: undefined | string | HTMLIFrameElement
    #iframeElement: undefined | HTMLIFrameElement
    #origin: string
    #subscriptions: [string, ((event) => void)][] = []
    #webApplication: undefined | ExternalLinkKey

    Accessors

    Methods

    Returns Promise<void>

    Returns Promise<void>

    A Promise for when the iframe is loaded

    +

    Returns Promise<void>

    A Promise for when the iframe is loaded

    Returns Promise<void>

    A Promise for when the iframe is loaded

    +

    Returns Promise<void>

    A Promise for when the iframe is loaded

    Returns void

    Returns Promise<Response>

    A Promise for the fetch response

    Throws

    For invalid arguments

    -

    Returns Promise<void>

    A Promise for when the iframe is loaded

    Returns Promise<void>

    A Promise for when the iframe is loaded

    Throws

    For invalid arguments

    Fires

    CadenzaDrillThroughEvent

    -

    Returns Promise<void>

    A Promise for when the iframe is loaded

    Throws

    For invalid arguments

    Fires

    CadenzaDrillThroughEvent

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/classes/CadenzaError.html b/classes/CadenzaError.html index 2d589831..41ea776f 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

    Hierarchy

    • Error
      • CadenzaError

    Constructors

    Properties

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

    Methods

    Constructors

    • Parameters

      • type: string

        The technical identifier of the error

      • message: string

        A description of the error

        -

      Returns CadenzaError

    Properties

    #type: string
    cause?: unknown
    message: string
    name: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    +

    Returns CadenzaError

    Properties

    #type: string
    cause?: unknown
    message: string
    name: string
    stack?: string
    prepareStackTrace?: ((err, stackTraces) => any)

    Optional override for formatting stack traces

    Type declaration

    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      +
    stackTraceLimit: number

    Accessors

    Methods

    • Create .stack property on a target object

      Parameters

      • targetObject: object
      • Optional constructorOpt: Function

      Returns void

    Generated using TypeDoc

    \ No newline at end of file diff --git a/functions/cadenza.html b/functions/cadenza.html index f09d2b33..b53da12a 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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/CadenzaEvent.html b/interfaces/CadenzaEvent.html index 40816bd0..7624ea84 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

    • TYPE extends string

    • DETAIL = unknown

    Properties

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

    Type Parameters

    • TYPE extends string

    • DETAIL = unknown

    Properties

    Properties

    detail: DETAIL

    Optional event details (depending on the event type)

    -
    type: TYPE

    The event type

    -

    Generated using TypeDoc

    \ No newline at end of file +
    type: TYPE

    The event type

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/ExternalLinkKey.html b/interfaces/ExternalLinkKey.html index e6dc651e..39062bf6 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

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

    Properties

    externalLinkId: string

    The ID of the external link

    -
    repositoryName: string

    The name of the link's repository

    -

    Generated using TypeDoc

    \ No newline at end of file +
    repositoryName: string

    The name of the link's repository

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/Geometry.html b/interfaces/Geometry.html index 16b74b70..1e47e58f 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

    interface Geometry {
        type: GeometryType;
    }

    Properties

    Properties

    The type of the geometry

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/PageSource.html b/interfaces/PageSource.html index 68bed1bc..c4dfd55a 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

    interface PageSource {
        page: "welcome";
    }

    Properties

    Properties

    page: "welcome"

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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/WorkbookKey.html b/interfaces/WorkbookKey.html index 33799767..edfa15fc 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

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

    Properties

    repositoryName: string

    The name of the workbook's repository

    -
    workbookId: string

    The ID of the workbook

    -

    Generated using TypeDoc

    \ No newline at end of file +
    workbookId: string

    The ID of the workbook

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/WorkbookViewKey.html b/interfaces/WorkbookViewKey.html index 6340f813..ac4f1c3c 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

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

    Properties

    repositoryName: string

    The name of the workbook's repository

    -
    viewId: string

    The ID of the view

    -
    workbookId: string

    The ID of the workbook

    -

    Generated using TypeDoc

    \ No newline at end of file +
    viewId: string

    The ID of the view

    +
    workbookId: string

    The ID of the workbook

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/interfaces/WorksheetKey.html b/interfaces/WorksheetKey.html index fddbbeb4..db71fcf3 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

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

    Properties

    repositoryName: string

    The name of the workbook's repository

    -
    workbookId: string

    The ID of the workbook

    -
    worksheetId: string

    The ID of the worksheet

    -

    Generated using TypeDoc

    \ No newline at end of file +
    workbookId: string

    The ID of the workbook

    +
    worksheetId: string

    The ID of the worksheet

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CadenzaDrillThroughEvent.html b/types/CadenzaDrillThroughEvent.html index 26f62c77..d7bbecc5 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

    Generated using TypeDoc

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

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CadenzaEditGeometryCancelEvent.html b/types/CadenzaEditGeometryCancelEvent.html index bdb164e5..ab824d00 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.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CadenzaEditGeometryOkEvent.html b/types/CadenzaEditGeometryOkEvent.html index 2e9c8c24..1648a951 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CadenzaEditGeometryUpdateEvent.html b/types/CadenzaEditGeometryUpdateEvent.html index 894df801..5fb4a27c 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CadenzaErrorEvent.html b/types/CadenzaErrorEvent.html index 77c2e85e..717e63aa 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CadenzaSelectObjectsCancelEvent.html b/types/CadenzaSelectObjectsCancelEvent.html index cab15dab..12554708 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.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CadenzaSelectObjectsOkEvent.html b/types/CadenzaSelectObjectsOkEvent.html index 82ca8244..472a41f2 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/CadenzaSelectObjectsUpdateEvent.html b/types/CadenzaSelectObjectsUpdateEvent.html index cca73e5d..8efa6ff3 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

    Generated using TypeDoc

    \ No newline at end of file +

    Type declaration

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/DataType.html b/types/DataType.html index 9a8be514..1f652819 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.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/EmbeddingTargetId.html b/types/EmbeddingTargetId.html index f965282a..f2d27337 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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/Extent.html b/types/Extent.html index 8d4a0cca..f61858ff 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]

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/FilterVariables.html b/types/FilterVariables.html index 06dc9697..b5d78ef7 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>

    Filter variable names and values

    -

    Generated using TypeDoc

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

    Type alias FilterVariables

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

    Filter variable names and values

    +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/GeometryType.html b/types/GeometryType.html index 21d85ec8..d51e6dcb 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.

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/GlobalId.html b/types/GlobalId.html index a63d6a39..b3f05df8 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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/OperationMode.html b/types/OperationMode.html index cd3f59c5..f4d79a96 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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/TablePart.html b/types/TablePart.html index 23ac5c80..fca848e5 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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/UiFeature.html b/types/UiFeature.html index 2552b0ea..25a362d7 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'.)
  • -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/WorkbookLayerPath.html b/types/WorkbookLayerPath.html index 48a4ff76..03371cb2 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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/WorkbookSource.html b/types/WorkbookSource.html index 7e0aa54a..e4a35230 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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/WorkbookViewSource.html b/types/WorkbookViewSource.html index 58a9922e..0f54dfa4 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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file diff --git a/types/WorksheetSource.html b/types/WorksheetSource.html index 8d8444f1..a69f26b4 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

    -

    Generated using TypeDoc

    \ No newline at end of file +

    Generated using TypeDoc

    \ No newline at end of file