From 54f40455c2aabfd0c61d11f35fe38c0345de9f46 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 3 Oct 2023 09:24:11 +0000 Subject: [PATCH] Updates --- classes/AbortError.html | 4 +-- classes/CadenzaClient.html | 52 ++++++++++++++++----------------- classes/CadenzaError.html | 8 ++--- functions/cadenza.html | 2 +- index.html | 6 ++-- interfaces/CadenzaEvent.html | 6 ++-- interfaces/ExternalLinkKey.html | 6 ++-- interfaces/Geometry.html | 4 +-- interfaces/WorkbookKey.html | 6 ++-- interfaces/WorkbookViewKey.html | 8 ++--- interfaces/WorksheetKey.html | 8 ++--- types/CadenzaErrorEvent.html | 2 +- types/EmbeddingTargetId.html | 2 +- types/Extent.html | 2 +- types/GeometryType.html | 2 +- types/MediaType.html | 2 +- types/WorkbookSource.html | 2 +- types/WorkbookViewSource.html | 2 +- types/WorksheetSource.html | 2 +- 19 files changed, 62 insertions(+), 64 deletions(-) diff --git a/classes/AbortError.html b/classes/AbortError.html index b9e6b990..c965d7ec 100644 --- a/classes/AbortError.html +++ b/classes/AbortError.html @@ -22,7 +22,7 @@

Hierarchy

+
  • Defined in src/cadenza.js:714
    • @@ -100,7 +100,7 @@

    constructorReturns AbortError

    +
  • Defined in src/cadenza.js:715

    • Properties

    diff --git a/classes/CadenzaClient.html b/classes/CadenzaClient.html index 467e3e41..5003f71d 100644 --- a/classes/CadenzaClient.html +++ b/classes/CadenzaClient.html @@ -31,7 +31,7 @@

    Hierarchy

    • CadenzaClient
    +
  • Defined in src/cadenza.js:77
    • @@ -78,43 +78,43 @@

    Private
    #baseUrl: string

    +
  • Defined in src/cadenza.js:79

    • Private Readonly #debug

    #debug: boolean
    +
  • Defined in src/cadenza.js:94

    • Private Readonly #iframe

    #iframe: undefined | string | HTMLIFrameElement
    +
  • Defined in src/cadenza.js:85

    • Private #iframeElement

    #iframeElement: undefined | HTMLIFrameElement
    +
  • Defined in src/cadenza.js:91

    • Private Readonly #origin

    #origin: string
    +
  • Defined in src/cadenza.js:82

    • Private #subscriptions

    #subscriptions: [string, ((event) => void)][] = []
    +
  • Defined in src/cadenza.js:97

    • Private Readonly #webApplication

    #webApplication: undefined | ExternalLinkKey
    +
  • Defined in src/cadenza.js:88

    • Accessors

    @@ -124,7 +124,7 @@

    Private

  • Returns HTMLIFrameElement

    • +
  • Defined in src/cadenza.js:149

    • baseUrl

    +
  • Defined in src/cadenza.js:131

    • iframe

    +
  • Defined in src/cadenza.js:136

    • Methods

    @@ -166,7 +166,7 @@
    Optional Returns URL
    +
  • Defined in src/cadenza.js:518

    • Private #download

    +
  • Defined in src/cadenza.js:502

    • Private #fetch

    +
  • Defined in src/cadenza.js:456

    • Private #getIframePromise

    +
  • Defined in src/cadenza.js:323

    • Private #log

    +
  • Defined in src/cadenza.js:529

    • Private #onMessage

    +
  • Defined in src/cadenza.js:399

    • Private #postEvent

    +
  • Defined in src/cadenza.js:420

    • Private #show

    +
  • Defined in src/cadenza.js:313

    • createGeometry

    +
  • Defined in src/cadenza.js:252

    • downloadData

    +
  • Defined in src/cadenza.js:486

    • editGeometry

    +
  • Defined in src/cadenza.js:287

    • fetchData

    +
  • Defined in src/cadenza.js:439

    • on

    +
  • Defined in src/cadenza.js:375

    • show

    +
  • Defined in src/cadenza.js:171

    • showMap

    +
  • Defined in src/cadenza.js:203
    • diff --git a/classes/CadenzaError.html b/classes/CadenzaError.html index 8191995f..dd04cb2a 100644 --- a/classes/CadenzaError.html +++ b/classes/CadenzaError.html @@ -27,7 +27,7 @@

    Hierarchy

    • CadenzaError
    +
  • Defined in src/cadenza.js:725
    • @@ -79,14 +79,14 @@

    Returns

    +
  • Defined in src/cadenza.js:732

    • Properties

    Private #type

    #type: string
    +
  • Defined in src/cadenza.js:726

    • Optional cause

    cause?: unknown
    +
  • Defined in src/cadenza.js:737

    • Methods

    diff --git a/functions/cadenza.html b/functions/cadenza.html index 89795f1f..ffa5e512 100644 --- a/functions/cadenza.html +++ b/functions/cadenza.html @@ -55,7 +55,7 @@

    Returns Throws

    For invalid base URL

    +
  • Defined in src/cadenza.js:11
    • diff --git a/index.html b/index.html index 08880bed..5fbc928e 100644 --- a/index.html +++ b/index.html @@ -40,13 +40,11 @@

    Cadenza JS

  • If the embedding target cannot be resolved, a 404 page is shown to the user.
  • Cadenza JS does not handle user authentication: If the user is not already logged in, the normal authentication flow of Cadenza will run. By default, the login page would be shown to the user.
    • -

    Show the Generated PDF of a Jasper Report View Directly

    Views of type "JasperReports report" can be shown in an iFrame like any other view. -But there is an additional option to show only the generated PDF without any Cadenza footers or headers. -This is done by setting the "mediaType" option to "application/pdf".

    +

    Show the Generated PDF of a Jasper 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".

    cadenzaClient.show('{embeddingTargetId}', {
      mediaType: 'application/pdf'
    });

    Abort (Iframe) Loading

    Cadenza JS uses the AbortController Web API for aborting requests. This is supported by most of the public methods.

    -
    const abortController = new AbortController();
    try {
        await cadenzaClient.show('{embeddingTargetId}', { signal: abortController.signal });
    } catch (error) {
      if (error.name === 'AbortError') {
        console.log('Iframe loading was aborted');
      }
    }

    cancelButton.onclick = () => abortController.abort();
+
    const abortController = new AbortController();
    try {
      await cadenzaClient.show('{embeddingTargetId}', { signal: abortController.signal });
    } catch (error) {
      if (error.name === 'AbortError') {
        console.log('Iframe loading was aborted');
      }
    }

    cancelButton.onclick = () => abortController.abort();
 
    
 
    Tip: You can use the same AbortController to abort multiple requests, e.g. when embedding Cadenza in multiple iframes.
    
 
    Show a Workbook Map View
    API: CadenzaClient#showMap
    
diff --git a/interfaces/CadenzaEvent.html b/interfaces/CadenzaEvent.html
index 96da6ddc..c40887f4 100644
--- a/interfaces/CadenzaEvent.html
+++ b/interfaces/CadenzaEvent.html
@@ -30,7 +30,7 @@ 
    Hierarchy
    
 
      
 
    • CadenzaEvent
    
+
  • Defined in src/cadenza.js:707
    • 
 
    
 
    
 
    
@@ -50,7 +50,7 @@ 
    detail
    +
  • Defined in src/cadenza.js:709

    • type

    type: string
    @@ -58,7 +58,7 @@

    type

    +
  • Defined in src/cadenza.js:708
    • diff --git a/interfaces/ExternalLinkKey.html b/interfaces/ExternalLinkKey.html index 4df5d1b1..f89b35a8 100644 --- a/interfaces/ExternalLinkKey.html +++ b/interfaces/ExternalLinkKey.html @@ -24,7 +24,7 @@

    Hierarchy

    • ExternalLinkKey
    +
  • Defined in src/cadenza.js:31
    • @@ -44,7 +44,7 @@

    externalLinkId

    +
  • Defined in src/cadenza.js:33

    • repositoryName

    repositoryName: string
    @@ -52,7 +52,7 @@

    repositoryName

    +
  • Defined in src/cadenza.js:32
    • diff --git a/interfaces/Geometry.html b/interfaces/Geometry.html index 64d0e88e..c986d3b1 100644 --- a/interfaces/Geometry.html +++ b/interfaces/Geometry.html @@ -24,7 +24,7 @@

    Hierarchy

    • Geometry
    +
  • Defined in src/cadenza.js:58
    • @@ -43,7 +43,7 @@

    type

    +
  • Defined in src/cadenza.js:59
    • diff --git a/interfaces/WorkbookKey.html b/interfaces/WorkbookKey.html index 37330b67..d8aef587 100644 --- a/interfaces/WorkbookKey.html +++ b/interfaces/WorkbookKey.html @@ -24,7 +24,7 @@

    Hierarchy

    • WorkbookKey
    +
  • Defined in src/cadenza.js:36
    • @@ -44,7 +44,7 @@

    repositoryName

    +
  • Defined in src/cadenza.js:37

    • workbookId

    workbookId: string
    @@ -52,7 +52,7 @@

    workbookId

    +
  • Defined in src/cadenza.js:38
    • diff --git a/interfaces/WorkbookViewKey.html b/interfaces/WorkbookViewKey.html index 3efb3d43..7ad60e22 100644 --- a/interfaces/WorkbookViewKey.html +++ b/interfaces/WorkbookViewKey.html @@ -24,7 +24,7 @@

    Hierarchy

    • WorkbookViewKey
    +
  • Defined in src/cadenza.js:47
    • @@ -45,7 +45,7 @@

    repositoryName

    +
  • Defined in src/cadenza.js:48

    • viewId

    viewId: string
    @@ -53,7 +53,7 @@

    viewId

    +
  • Defined in src/cadenza.js:50

    • workbookId

    workbookId: string
    @@ -61,7 +61,7 @@

    workbookId

    +
  • Defined in src/cadenza.js:49
    • diff --git a/interfaces/WorksheetKey.html b/interfaces/WorksheetKey.html index b1a8a349..4fb89075 100644 --- a/interfaces/WorksheetKey.html +++ b/interfaces/WorksheetKey.html @@ -24,7 +24,7 @@

    Hierarchy

    • WorksheetKey
    +
  • Defined in src/cadenza.js:41
    • @@ -45,7 +45,7 @@

    repositoryName

    +
  • Defined in src/cadenza.js:42

    • workbookId

    workbookId: string
    @@ -53,7 +53,7 @@

    workbookId

    +
  • Defined in src/cadenza.js:43

    • worksheetId

    worksheetId: string
    @@ -61,7 +61,7 @@

    worksheetId

    +
  • Defined in src/cadenza.js:44
    • diff --git a/types/CadenzaErrorEvent.html b/types/CadenzaErrorEvent.html index 7dbf505a..cbc0f198 100644 --- a/types/CadenzaErrorEvent.html +++ b/types/CadenzaErrorEvent.html @@ -27,7 +27,7 @@
    Optional type: string
    +
  • Defined in src/cadenza.js:712
    • diff --git a/types/EmbeddingTargetId.html b/types/EmbeddingTargetId.html index d1cbc867..14978ea5 100644 --- a/types/EmbeddingTargetId.html +++ b/types/EmbeddingTargetId.html @@ -20,7 +20,7 @@

    Type alias EmbeddingTargetId

    +
  • Defined in src/cadenza.js:28
    • diff --git a/types/Extent.html b/types/Extent.html index 535e7fdc..c1d5d1a7 100644 --- a/types/Extent.html +++ b/types/Extent.html @@ -20,7 +20,7 @@

    Type alias Extent

    +
  • Defined in src/cadenza.js:66
    • diff --git a/types/GeometryType.html b/types/GeometryType.html index 79b4cae6..500dc619 100644 --- a/types/GeometryType.html +++ b/types/GeometryType.html @@ -21,7 +21,7 @@

    Type alias GeometryType

    +
  • Defined in src/cadenza.js:62
    • diff --git a/types/MediaType.html b/types/MediaType.html index 2948b1ef..ab07cd29 100644 --- a/types/MediaType.html +++ b/types/MediaType.html @@ -21,7 +21,7 @@

    Type alias MediaType

    +
  • Defined in src/cadenza.js:637
    • diff --git a/types/WorkbookSource.html b/types/WorkbookSource.html index 162f43ce..ae024b16 100644 --- a/types/WorkbookSource.html +++ b/types/WorkbookSource.html @@ -20,7 +20,7 @@

    Type alias WorkbookSource

    +
  • Defined in src/cadenza.js:53
    • diff --git a/types/WorkbookViewSource.html b/types/WorkbookViewSource.html index d231b72e..c3993372 100644 --- a/types/WorkbookViewSource.html +++ b/types/WorkbookViewSource.html @@ -20,7 +20,7 @@

    Type alias WorkbookViewSource

    +
  • Defined in src/cadenza.js:55
    • diff --git a/types/WorksheetSource.html b/types/WorksheetSource.html index 99ccb9e3..68bf7e1e 100644 --- a/types/WorksheetSource.html +++ b/types/WorksheetSource.html @@ -20,7 +20,7 @@

    Type alias WorksheetSource

    +
  • Defined in src/cadenza.js:54