From 55d05abd0d81cfa8a2d64941dc0ec28de26b02a5 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 24 Sep 2024 14:58:46 +0000 Subject: [PATCH] Updates --- classes/AbortError.html | 4 +- classes/CadenzaClient.html | 44 +++++++++++----------- classes/CadenzaError.html | 6 +-- functions/cadenza.html | 4 +- interfaces/CadenzaClientOptions.html | 10 ++--- interfaces/CadenzaEvent.html | 6 +-- interfaces/Distance.html | 4 +- interfaces/ExternalLinkKey.html | 6 +-- interfaces/Feature.html | 12 +++--- interfaces/FeatureCollection.html | 4 +- interfaces/Geometry.html | 4 +- interfaces/GeometryZoomTarget.html | 4 +- interfaces/PageSource.html | 4 +- types/CadenzaActionEvent.html | 2 +- types/CadenzaChangeSelectionEvent.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/CadenzaObjectInfoEvent.html | 2 +- types/CadenzaSelectObjectsCancelEvent.html | 2 +- types/CadenzaSelectObjectsOkEvent.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/LengthUnit.html | 2 +- types/OpaqueString.html | 2 +- types/OperationMode.html | 2 +- types/TablePart.html | 2 +- types/UiFeature.html | 2 +- types/WorkbookLayerPath.html | 2 +- types/ZoomTarget.html | 2 +- 38 files changed, 81 insertions(+), 81 deletions(-) diff --git a/classes/AbortError.html b/classes/AbortError.html index 323a37b9..b414279d 100644 --- a/classes/AbortError.html +++ b/classes/AbortError.html @@ -1,4 +1,4 @@ -AbortError | Cadenza JS - v2.13.0

Class AbortError

Hierarchy

  • DOMException
    • AbortError

Constructors

constructor +AbortError | Cadenza JS - v2.13.0

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

constructorABORT_ERRDATA_CLONE_ERRDOMSTRING_SIZE_ERRHIERARCHY_REQUEST_ERRINDEX_SIZE_ERRINUSE_ATTRIBUTE_ERRINVALID_ACCESS_ERRINVALID_CHARACTER_ERRINVALID_MODIFICATION_ERRINVALID_NODE_TYPE_ERRINVALID_STATE_ERRNAMESPACE_ERRNETWORK_ERRNOT_FOUND_ERRNOT_SUPPORTED_ERRNO_DATA_ALLOWED_ERRNO_MODIFICATION_ALLOWED_ERRQUOTA_EXCEEDED_ERRSECURITY_ERRSYNTAX_ERRTIMEOUT_ERRTYPE_MISMATCH_ERRURL_MISMATCH_ERRVALIDATION_ERRWRONG_DOCUMENT_ERRcausecodemessagenamestackABORT_ERRDATA_CLONE_ERRDOMSTRING_SIZE_ERRHIERARCHY_REQUEST_ERRINDEX_SIZE_ERRINUSE_ATTRIBUTE_ERRINVALID_ACCESS_ERRINVALID_CHARACTER_ERRINVALID_MODIFICATION_ERRINVALID_NODE_TYPE_ERRINVALID_STATE_ERRNAMESPACE_ERRNETWORK_ERRNOT_FOUND_ERRNOT_SUPPORTED_ERRNO_DATA_ALLOWED_ERRNO_MODIFICATION_ALLOWED_ERRQUOTA_EXCEEDED_ERRSECURITY_ERRSYNTAX_ERRTIMEOUT_ERRTYPE_MISMATCH_ERRURL_MISMATCH_ERRVALIDATION_ERRWRONG_DOCUMENT_ERR
\ No newline at end of file diff --git a/classes/CadenzaClient.html b/classes/CadenzaClient.html index 927c3ca9..c7badbcb 100644 --- a/classes/CadenzaClient.html +++ b/classes/CadenzaClient.html @@ -13,7 +13,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 @@ -48,19 +48,19 @@ selectObjects show showMap -

    Properties

    Private Readonly #baseUrl

    #baseUrl: undefined | 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

    Private #targetWindow

    baseUrl

    • get baseUrl(): undefined | string

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

      -

      Returns undefined | 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, body): Promise<Response>

    • Parameters

      • path: string

        Type

        string

        +

    Properties

    Private Readonly #baseUrl

    #baseUrl: undefined | 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

    Private #targetWindow

    baseUrl

    • get baseUrl(): undefined | string

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

      +

      Returns undefined | 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, body): Promise<Response>

    • Parameters

      • path: string

        Type

        string

      • params: URLSearchParams

        Type

        URLSearchParams

      • signal: undefined | AbortSignal

        Type

        AbortSignal | undefined

      • body: undefined | string

        Type

        String | undefined If body is set, the fetch will be a post.

        -

      Returns Promise<Response>

    Private #getIframePromise

    • #getIframePromise(signal): Promise<void>

    • Parameters

      • signal: undefined | AbortSignal

      Returns Promise<void>

    Private #log

    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?, transfer?): void

    • Parameters

      • type: string
      • Optional detail: unknown
      • Optional transfer: Transferable[]

      Returns void

    Private #postRequest

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

    • Posts an event to Cadenza and returns a Promise for the response.

      +

    Returns Promise<Response>

    Private #getIframePromise

    • #getIframePromise(signal): Promise<void>

    • Parameters

      • signal: undefined | AbortSignal

      Returns Promise<void>

    Private #log

    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?, transfer?): void

    • Parameters

      • type: string
      • Optional detail: unknown
      • Optional transfer: Transferable[]

      Returns void

    Private #postRequest

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

    • Posts an event to Cadenza and returns a Promise for the response.

      It is guaranteed that a response refers to a specific request, even if multiple request are executed in parallel.

      -

      Type Parameters

      • T = void

      Parameters

      • type: string
      • Optional detail: unknown

      Returns Promise<T>

    Private #show

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

    • Parameters

      • path: string
      • params: URLSearchParams
      • Optional signal: AbortSignal

      Returns Promise<void>

    closeMe

    • closeMe(): void
    • Post Message Parent

      Sends a message to parent Cadenza window to close the window containing this application

      -

      Returns void

    createGeometry

    • createGeometry(backgroundMapView, geometryType, __namedParameters?, ...args): Promise<void>
    • Embed

      Create a geometry.

      +

      Type Parameters

      • T = void

      Parameters

      • type: string
      • Optional detail: unknown

      Returns Promise<T>

    Private #show

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

    • Parameters

      • path: string
      • params: URLSearchParams
      • Optional signal: AbortSignal

      Returns Promise<void>

    closeMe

    • closeMe(): void
    • Post Message Parent

      Sends a message to parent Cadenza window to close the window containing this application

      +

      Returns void

    createGeometry

    destroy

    destroy

    downloadData

    • downloadData(source, dataType, __namedParameters?, ...args): void
    • Server

      Download data from a workbook view.

      +

    downloadData

    • downloadData(source, dataType, __namedParameters?, ...args): void
    • Server

      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: EmbeddingTargetId

        The workbook view to fetch data from.

      • dataType: DataType

        The data type you want to get back from the server. Currently, "csv", "excel" and "json" are supported for table and indicator views and "pdf" for views of type "JasperReports report".

      • Optional __namedParameters: {
            fileName: undefined | string;
            filter: undefined | FilterVariables;
            parts: undefined | TablePart[];
        } = {}
      • Rest ...args: any

      Returns void

      Throws

      For invalid arguments

      -

    editGeometry

    • editGeometry(backgroundMapView, geometry, __namedParameters?, ...args): Promise<void>
    • Embed

      Edit a geometry.

      +

    editGeometry

    • editGeometry(backgroundMapView, geometry, __namedParameters?, ...args): Promise<void>
    • Embed

      Edit a geometry.

      Parameters

      • backgroundMapView: EmbeddingTargetId

        The workbook map view in the background

      • geometry: Geometry

        The geometry

      • Optional __namedParameters: {
            filter: undefined | FilterVariables;
            locationFinder: undefined | string;
            mapExtent: undefined | Extent;
            minScale: undefined | number;
            signal: undefined | AbortSignal;
            useMapSrs: undefined | boolean;
            zoomTarget: undefined | GeometryZoomTarget;
        } = {}
        • filter: undefined | FilterVariables
        • locationFinder: undefined | string
        • mapExtent: undefined | Extent
        • minScale: undefined | number
        • signal: undefined | AbortSignal
        • useMapSrs: undefined | boolean
        • zoomTarget: undefined | GeometryZoomTarget
      • Rest ...args: any

      Returns Promise<void>

      A Promise for when the iframe is loaded

      @@ -91,34 +91,34 @@

      Fires

      -

    expandNavigator

    • expandNavigator(expanded?, ...args): void
    • Post Message

      Expand/collapse the navigator.

      +

    expandNavigator

    • expandNavigator(expanded?, ...args): void
    • Post Message

      Expand/collapse the navigator.

      Parameters

      • expanded: boolean = true

        The expansion state of the navigator

        -
      • Rest ...args: any

      Returns void

    fetchAreaIntersections

    • fetchAreaIntersections(source, layerPath, geometry, __namedParameters?, ...args): Promise<FeatureCollection>
    • Server

      Fetch the intersection areas from a workbook map view layer in JSON format for a given area.

      +
    • Rest ...args: any

    Returns void

    fetchAreaIntersections

    • fetchAreaIntersections(source, layerPath, geometry, __namedParameters?, ...args): Promise<FeatureCollection>
    • Server

      Fetch the intersection areas from a workbook map view layer in JSON format for a given area.

      Parameters

      • source: EmbeddingTargetId

        The workbook view to fetch object info from.

      • layerPath: (string | WorkbookLayerPath)[]

        Layer path to identify the layer (identified using layer paths or print names)

      • geometry: Geometry

        The intersection geometry

      • Optional __namedParameters: {
            buffer: undefined | Distance;
            signal: undefined | AbortSignal;
            useMapSrs: undefined | boolean;
        } = {}
        • buffer: undefined | Distance
        • signal: undefined | AbortSignal
        • useMapSrs: undefined | boolean
      • Rest ...args: any

      Returns Promise<FeatureCollection>

      A Promise for the fetch response

      -

    fetchData

    • fetchData(source, dataType, __namedParameters?, ...args): Promise<Response>
    • Server

      Fetch data from a workbook view.

      +

    fetchData

    • fetchData(source, dataType, __namedParameters?, ...args): Promise<Response>
    • Server

      Fetch data from a workbook view.

      Parameters

      • source: EmbeddingTargetId

        The workbook view to fetch data from.

      • dataType: DataType

        The data type you want to get back from the server. Currently, "csv", "excel" and "json" are supported for table and indicator views and "pdf" for views of type "JasperReports report".

      • Optional __namedParameters: {
            filter: undefined | FilterVariables;
            parts: undefined | TablePart[];
            signal: undefined | AbortSignal;
        } = {}
      • Rest ...args: any

      Returns Promise<Response>

      A Promise for the fetch response

      Throws

      For invalid arguments

      -

    fetchObjectInfo

    • fetchObjectInfo(source, layerPath, objectIds, __namedParameters?, ...args): Promise<FeatureCollection>

    • Fetch object info from a workbook map view.

      +

    fetchObjectInfo

    • fetchObjectInfo(source, layerPath, objectIds, __namedParameters?, ...args): Promise<FeatureCollection>

    • Fetch object info from a workbook map view.

      Parameters

      • source: EmbeddingTargetId

        The workbook view to fetch object info from.

      • layerPath: (string | WorkbookLayerPath)[]

        Layer path to identify the layer (identified using layer paths or print names)

      • objectIds: unknown[][]

        The IDs of the objects to select

      • Optional __namedParameters: {
            filter: undefined | FilterVariables;
            fullGeometries: undefined | boolean;
            signal: undefined | AbortSignal;
            useMapSrs: undefined | boolean;
        } = {}
        • filter: undefined | FilterVariables
        • fullGeometries: undefined | boolean
        • signal: undefined | AbortSignal
        • useMapSrs: undefined | boolean
      • Rest ...args: any

      Returns Promise<FeatureCollection>

      A Promise for the fetch response

      Throws

      For invalid arguments

      -

    on

    on

    reload

    • reload(__namedParameters?, ...args): void
    • Post Message

      Reload the views of a worksheet.

      -

      Parameters

      • Optional __namedParameters: {
            invalidateCaches: undefined | boolean;
        } = {}
        • invalidateCaches: undefined | boolean
      • Rest ...args: any

      Returns void

    selectObjects

    • selectObjects(backgroundMapView, __namedParameters?, ...args): Promise<void>
    • Embed

      Select objects in a workbook map.

      +
        • (): void

        • Returns void

    reload

    • reload(__namedParameters?, ...args): void
    • Post Message

      Reload the views of a worksheet.

      +

      Parameters

      • Optional __namedParameters: {
            invalidateCaches: undefined | boolean;
        } = {}
        • invalidateCaches: undefined | boolean
      • Rest ...args: any

      Returns void

    selectObjects

    • selectObjects(backgroundMapView, __namedParameters?, ...args): Promise<void>
    • Embed

      Select objects in a workbook map.

      Parameters

      • backgroundMapView: EmbeddingTargetId

        The workbook map view

      • Optional __namedParameters: {
            filter: undefined | FilterVariables;
            layers: undefined | (string | WorkbookLayerPath)[];
            locationFinder: undefined | string;
            mapExtent: undefined | Extent;
            signal: undefined | AbortSignal;
            useMapSrs: undefined | boolean;
        } = {}
        • filter: undefined | FilterVariables
        • layers: undefined | (string | WorkbookLayerPath)[]
        • locationFinder: undefined | string
        • mapExtent: undefined | Extent
        • signal: undefined | AbortSignal
        • useMapSrs: undefined | boolean
      • Rest ...args: any

      Returns Promise<void>

      A Promise for when the iframe is loaded

      Throws

      For invalid arguments

      @@ -128,7 +128,7 @@

      Fires

      -

    show

    • show(source, __namedParameters?, ...args): Promise<void>
    • Embed

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

      +

    show

    • show(source, __namedParameters?, ...args): Promise<void>
    • Embed

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

      Parameters

      • source: EmbeddingTargetId | PageSource

        The source to show

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

      Returns Promise<void>

      A Promise for when the iframe is loaded

      Throws

      For invalid arguments

      @@ -136,7 +136,7 @@

      Fires

      -

    showMap

    • showMap(mapView, __namedParameters?, ...args): Promise<void>
    • Embed

      Show a workbook map view in an iframe.

      +

    showMap

    • showMap(mapView, __namedParameters?, ...args): Promise<void>
    • Embed

      Show a workbook map view in an iframe.

      Parameters

      • mapView: EmbeddingTargetId

        The workbook map view to show

      • Optional __namedParameters: {
            disabledUiFeatures: undefined | UiFeature[];
            expandNavigator: undefined | boolean;
            filter: undefined | FilterVariables;
            geometry: undefined | Geometry;
            hideMainHeaderAndFooter: undefined | boolean;
            hideWorkbookToolBar: undefined | boolean;
            highlightGlobalId: undefined | GlobalId;
            locationFinder: undefined | string;
            mapExtent: undefined | Extent;
            operationMode: undefined | OperationMode;
            signal: undefined | AbortSignal;
            useMapSrs: undefined | boolean;
            zoomTarget: undefined | GeometryZoomTarget;
        } = {}
        • disabledUiFeatures: undefined | UiFeature[]
        • expandNavigator: undefined | boolean
        • filter: undefined | FilterVariables
        • geometry: undefined | Geometry
        • hideMainHeaderAndFooter: undefined | boolean
        • hideWorkbookToolBar: undefined | boolean
        • highlightGlobalId: undefined | GlobalId
        • locationFinder: undefined | string
        • mapExtent: undefined | Extent
        • operationMode: undefined | OperationMode
        • signal: undefined | AbortSignal
        • useMapSrs: undefined | boolean
        • zoomTarget: undefined | GeometryZoomTarget
      • Rest ...args: any

      Returns Promise<void>

      A Promise for when the iframe is loaded

      Throws

      For invalid arguments

      @@ -144,4 +144,4 @@

      Fires

      -

    Settings

    Member Visibility

    Theme

    On This Page

    #baseUrl#debug#iframe#iframeElement#origin#subscriptions#webApplication#requiredIframe#targetWindowbaseUrliframe#createUrl#download#fetch#getIframePromise#log#on#onMessage#postEvent#postRequest#showcloseMecreateGeometrydestroydownloadDataeditGeometryexpandNavigatorfetchAreaIntersectionsfetchDatafetchObjectInfoonreloadselectObjectsshowshowMap
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    #baseUrl#debug#iframe#iframeElement#origin#subscriptions#webApplication#requiredIframe#targetWindowbaseUrliframe#createUrl#download#fetch#getIframePromise#log#on#onMessage#postEvent#postRequest#showcloseMecreateGeometrydestroydownloadDataeditGeometryexpandNavigatorfetchAreaIntersectionsfetchDatafetchObjectInfoonreloadselectObjectsshowshowMap
    \ No newline at end of file diff --git a/classes/CadenzaError.html b/classes/CadenzaError.html index 33888032..dbb56a0e 100644 --- a/classes/CadenzaError.html +++ b/classes/CadenzaError.html @@ -1,6 +1,6 @@ CadenzaError | Cadenza JS - v2.13.0

    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,7 +12,7 @@

    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

      • (err, stackTraces): any

      • Parameters

        • err: Error
        • stackTraces: CallSite[]

        Returns any

    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

    constructor#typecausemessagenamestackprepareStackTracestackTraceLimittypecaptureStackTrace
    \ No newline at end of file diff --git a/functions/cadenza.html b/functions/cadenza.html index 547e3f5d..7d01042c 100644 --- a/functions/cadenza.html +++ b/functions/cadenza.html @@ -1,10 +1,10 @@ cadenza | Cadenza JS - v2.13.0

    Function cadenza

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/CadenzaClientOptions.html b/interfaces/CadenzaClientOptions.html index a6bf0d41..9eaa5cdf 100644 --- a/interfaces/CadenzaClientOptions.html +++ b/interfaces/CadenzaClientOptions.html @@ -1,14 +1,14 @@ -CadenzaClientOptions | Cadenza JS - v2.13.0

    Interface CadenzaClientOptions

    interface CadenzaClientOptions {
        baseUrl: undefined | string;
        debug: undefined | boolean;
        iframe: undefined | string | HTMLIFrameElement;
        webApplication: undefined | ExternalLinkKey;
    }

    Properties

    baseUrl +CadenzaClientOptions | Cadenza JS - v2.13.0

    Interface CadenzaClientOptions

    interface CadenzaClientOptions {
        baseUrl: undefined | string;
        debug: undefined | boolean;
        iframe: undefined | string | HTMLIFrameElement;
        webApplication: undefined | ExternalLinkKey;
    }

    Properties

    baseUrl debug iframe webApplication

    Properties

    baseUrl

    baseUrl: undefined | string

    The base URL of the Cadenza server

    -

    debug

    debug: undefined | boolean

    Whether to enable debug logging

    -

    iframe

    iframe: undefined | string | HTMLIFrameElement

    An iframe for embedding Cadenza or the iframe's ID. +

    debug

    debug: undefined | boolean

    Whether to enable debug logging

    +

    iframe

    iframe: undefined | string | HTMLIFrameElement

    An iframe for embedding Cadenza or the iframe's ID. The iframe is required only for methods that embed Cadenza in an iframe, so e.g. not for CadenzaClient#fetchData. If you want to embed Cadenza in multiple iframes, you need to create an instance of the CadenzaClient per iframe.

    -

    webApplication

    webApplication: undefined | ExternalLinkKey

    An external link that Cadenza uses to resolve the +

    webApplication

    webApplication: undefined | ExternalLinkKey

    An external link that Cadenza uses to resolve the target origin when posting events. This is required if Cadenza and your application are not running on the same origin. Please ensure that the user has view privilege for that link!

    -

    Settings

    Member Visibility

    Theme

    On This Page

    baseUrldebugiframewebApplication
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    baseUrldebugiframewebApplication
    \ No newline at end of file diff --git a/interfaces/CadenzaEvent.html b/interfaces/CadenzaEvent.html index dd96ec6a..1e97ccd3 100644 --- a/interfaces/CadenzaEvent.html +++ b/interfaces/CadenzaEvent.html @@ -1,6 +1,6 @@ CadenzaEvent | Cadenza JS - v2.13.0

    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

    detailtype
    \ No newline at end of file +

    type

    type: TYPE

    The event type

    +

    Settings

    Member Visibility

    Theme

    On This Page

    detailtype
    \ No newline at end of file diff --git a/interfaces/Distance.html b/interfaces/Distance.html index d521070c..d12c82df 100644 --- a/interfaces/Distance.html +++ b/interfaces/Distance.html @@ -1,3 +1,3 @@ -Distance | Cadenza JS - v2.13.0

    Interface Distance

    interface Distance {
        lengthUnit: LengthUnit;
        value: number;
    }

    Properties

    lengthUnit +Distance | Cadenza JS - v2.13.0

    Interface Distance

    interface Distance {
        lengthUnit: LengthUnit;
        value: number;
    }

    Properties

    lengthUnit value -

    Properties

    lengthUnit

    lengthUnit: LengthUnit

    value

    value: number

    Settings

    Member Visibility

    Theme

    On This Page

    lengthUnitvalue
    \ No newline at end of file +

    Properties

    lengthUnit

    lengthUnit: LengthUnit

    value

    value: number

    Settings

    Member Visibility

    Theme

    On This Page

    lengthUnitvalue
    \ No newline at end of file diff --git a/interfaces/ExternalLinkKey.html b/interfaces/ExternalLinkKey.html index 72e8fa36..18e00b65 100644 --- a/interfaces/ExternalLinkKey.html +++ b/interfaces/ExternalLinkKey.html @@ -2,8 +2,8 @@

    You get the repositoryName and externalLinkId from the URL of the external link's page in the Cadenza management center:

    <baseUrl>/admin/repositories/<repositoryName>/external-links/<externalLinkId>?...
    -
    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

    externalLinkIdrepositoryName
    \ No newline at end of file +

    repositoryName

    repositoryName: string

    The name of the link's repository

    +

    Settings

    Member Visibility

    Theme

    On This Page

    externalLinkIdrepositoryName
    \ No newline at end of file diff --git a/interfaces/Feature.html b/interfaces/Feature.html index 4daa1509..e22bacb7 100644 --- a/interfaces/Feature.html +++ b/interfaces/Feature.html @@ -1,12 +1,12 @@ Feature | Cadenza JS - v2.13.0

    Interface Feature

    A adapted GeoJSON feature object.

    -
    interface Feature {
        area: undefined | number;
        geometry: Geometry;
        length: undefined | number;
        objectId: any[];
        properties: Record<string, string>;
    }

    Properties

    area +
    interface Feature {
        area: undefined | number;
        geometry: Geometry;
        length: undefined | number;
        objectId: any[];
        properties: Record<string, string>;
    }

    Properties

    area geometry length objectId properties

    Properties

    area

    area: undefined | number

    The area of a Polygon feature

    -

    geometry

    geometry: Geometry

    The geometry

    -

    length

    length: undefined | number

    The area of a LineString feature

    -

    objectId

    objectId: any[]

    The id of the feature

    -

    properties

    properties: Record<string, string>

    The formated properties

    -

    Settings

    Member Visibility

    Theme

    On This Page

    areageometrylengthobjectIdproperties
    \ No newline at end of file +

    geometry

    geometry: Geometry

    The geometry

    +

    length

    length: undefined | number

    The area of a LineString feature

    +

    objectId

    objectId: any[]

    The id of the feature

    +

    properties

    properties: Record<string, string>

    The formated properties

    +

    Settings

    Member Visibility

    Theme

    On This Page

    areageometrylengthobjectIdproperties
    \ No newline at end of file diff --git a/interfaces/FeatureCollection.html b/interfaces/FeatureCollection.html index 7fa155ee..3b01ca29 100644 --- a/interfaces/FeatureCollection.html +++ b/interfaces/FeatureCollection.html @@ -1,4 +1,4 @@ FeatureCollection | Cadenza JS - v2.13.0

    Interface FeatureCollection

    A adapted GeoJSON feature collection object

    -
    interface FeatureCollection {
        features: Feature[];
    }

    Properties

    features +
    interface FeatureCollection {
        features: Feature[];
    }

    Properties

    features

    Properties

    features

    features: Feature[]

    The features within this collection

    -

    Settings

    Member Visibility

    Theme

    On This Page

    features
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    features
    \ No newline at end of file diff --git a/interfaces/Geometry.html b/interfaces/Geometry.html index 439c0407..af64ccb1 100644 --- a/interfaces/Geometry.html +++ b/interfaces/Geometry.html @@ -1,4 +1,4 @@ Geometry | Cadenza JS - v2.13.0

    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

    type
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    type
    \ No newline at end of file diff --git a/interfaces/GeometryZoomTarget.html b/interfaces/GeometryZoomTarget.html index 736f9dd7..17a95b4c 100644 --- a/interfaces/GeometryZoomTarget.html +++ b/interfaces/GeometryZoomTarget.html @@ -1,4 +1,4 @@ GeometryZoomTarget | Cadenza JS - v2.13.0

    Interface GeometryZoomTarget

    Instructs Cadenza to zoom to a provided {@Link Geometry}

    -
    interface GeometryZoomTarget {
        type: "geometry";
    }

    Properties

    type +
    interface GeometryZoomTarget {
        type: "geometry";
    }

    Properties

    type

    Properties

    type

    type: "geometry"

    The type of the zoom target

    -

    Settings

    Member Visibility

    Theme

    On This Page

    type
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    type
    \ No newline at end of file diff --git a/interfaces/PageSource.html b/interfaces/PageSource.html index 9cfd339f..565407b5 100644 --- a/interfaces/PageSource.html +++ b/interfaces/PageSource.html @@ -1,4 +1,4 @@ PageSource | Cadenza JS - v2.13.0

    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

    page
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    page
    \ No newline at end of file diff --git a/types/CadenzaActionEvent.html b/types/CadenzaActionEvent.html index a8c2d1a4..de3dd72a 100644 --- a/types/CadenzaActionEvent.html +++ b/types/CadenzaActionEvent.html @@ -1,2 +1,2 @@ CadenzaActionEvent | Cadenza JS - v2.13.0

    Type alias CadenzaActionEvent

    CadenzaActionEvent: CadenzaEvent<"action", {
        context: string;
    }>

    When the user executed a POST message action, which is defined on an external link in the Cadenza management center.

    -

    Type declaration

    • context: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CadenzaChangeSelectionEvent.html b/types/CadenzaChangeSelectionEvent.html index d82e34c2..a3006582 100644 --- a/types/CadenzaChangeSelectionEvent.html +++ b/types/CadenzaChangeSelectionEvent.html @@ -1,3 +1,3 @@ CadenzaChangeSelectionEvent | Cadenza JS - v2.13.0

    Type alias CadenzaChangeSelectionEvent

    CadenzaChangeSelectionEvent: CadenzaEvent<"change:selection", undefined | {
        layer: WorkbookLayerPath;
        values: unknown[][];
    }>

    When the user changed the selection.

    For a selection in a workbook map view with activated feature info, the values also include the simplified geometries of the selected objects.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

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

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

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CadenzaEditGeometryCancelEvent.html b/types/CadenzaEditGeometryCancelEvent.html index aa717c23..097dba50 100644 --- a/types/CadenzaEditGeometryCancelEvent.html +++ b/types/CadenzaEditGeometryCancelEvent.html @@ -1,2 +1,2 @@ CadenzaEditGeometryCancelEvent | Cadenza JS - v2.13.0

    Type alias CadenzaEditGeometryCancelEvent

    CadenzaEditGeometryCancelEvent: CadenzaEvent<"editGeometry:cancel">

    When the user cancelled the geometry editing.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CadenzaEditGeometryOkEvent.html b/types/CadenzaEditGeometryOkEvent.html index cb7227fa..781d0e5e 100644 --- a/types/CadenzaEditGeometryOkEvent.html +++ b/types/CadenzaEditGeometryOkEvent.html @@ -1,2 +1,2 @@ CadenzaEditGeometryOkEvent | Cadenza JS - v2.13.0

    Type alias CadenzaEditGeometryOkEvent

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

    When the user submitted the geometry.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CadenzaEditGeometryUpdateEvent.html b/types/CadenzaEditGeometryUpdateEvent.html index 02fccb38..abebaf4c 100644 --- a/types/CadenzaEditGeometryUpdateEvent.html +++ b/types/CadenzaEditGeometryUpdateEvent.html @@ -1,2 +1,2 @@ CadenzaEditGeometryUpdateEvent | Cadenza JS - v2.13.0

    Type alias CadenzaEditGeometryUpdateEvent

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

    When the user changed the geometry.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

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

    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

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

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

    Type alias CadenzaEventByType<T>

    CadenzaEventByType<T>: T extends "action"
        ? CadenzaActionEvent
        : T extends "change:selection"
            ? CadenzaChangeSelectionEvent
            : T extends "drillThrough"
                ? CadenzaDrillThroughEvent
                : T extends "editGeometry:update"
                    ? CadenzaEditGeometryUpdateEvent
                    : T extends "editGeometry:ok"
                        ? CadenzaEditGeometryOkEvent
                        : T extends "editGeometry:cancel"
                            ? CadenzaEditGeometryCancelEvent
                            : T extends "objectInfo"
                                ? CadenzaObjectInfoEvent
                                : T extends "selectObjects:ok"
                                    ? CadenzaSelectObjectsOkEvent
                                    : T extends "selectObjects:cancel"
                                        ? CadenzaSelectObjectsCancelEvent
                                        : never

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +CadenzaEventByType | Cadenza JS - v2.13.0

    Type alias CadenzaEventByType<T>

    CadenzaEventByType<T>: T extends "action"
        ? CadenzaActionEvent
        : T extends "change:selection"
            ? CadenzaChangeSelectionEvent
            : T extends "drillThrough"
                ? CadenzaDrillThroughEvent
                : T extends "editGeometry:update"
                    ? CadenzaEditGeometryUpdateEvent
                    : T extends "editGeometry:ok"
                        ? CadenzaEditGeometryOkEvent
                        : T extends "editGeometry:cancel"
                            ? CadenzaEditGeometryCancelEvent
                            : T extends "objectInfo"
                                ? CadenzaObjectInfoEvent
                                : T extends "selectObjects:ok"
                                    ? CadenzaSelectObjectsOkEvent
                                    : T extends "selectObjects:cancel"
                                        ? CadenzaSelectObjectsCancelEvent
                                        : never

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CadenzaEventType.html b/types/CadenzaEventType.html index 2596331d..85a7283e 100644 --- a/types/CadenzaEventType.html +++ b/types/CadenzaEventType.html @@ -1,2 +1,2 @@ CadenzaEventType | Cadenza JS - v2.13.0

    Type alias CadenzaEventType

    CadenzaEventType: "action" | "change:selection" | "drillThrough" | "editGeometry:ok" | "editGeometry:update" | "editGeometry:cancel" | "objectInfo" | "selectObjects:ok" | "selectObjects:cancel"

    An event type to subscribe to using CadenzaClient#on

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CadenzaObjectInfoEvent.html b/types/CadenzaObjectInfoEvent.html index b5cb9ffb..be196ab3 100644 --- a/types/CadenzaObjectInfoEvent.html +++ b/types/CadenzaObjectInfoEvent.html @@ -1,2 +1,2 @@ CadenzaObjectInfoEvent | Cadenza JS - v2.13.0

    Type alias CadenzaObjectInfoEvent

    CadenzaObjectInfoEvent: CadenzaEvent<"objectInfo", {
        layer: WorkbookLayerPath;
        objectInfos: {
            elements: {
                attributePrintName: string;
                formattedValue: string;
            }[];
            selectionIndex: number;
        };
    }>

    When the user opened the object info flyout.

    -

    Type declaration

    • layer: WorkbookLayerPath
    • objectInfos: {
          elements: {
              attributePrintName: string;
              formattedValue: string;
          }[];
          selectionIndex: number;
      }
      • elements: {
            attributePrintName: string;
            formattedValue: string;
        }[]
      • selectionIndex: number

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

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

    Type alias CadenzaSelectObjectsCancelEvent

    CadenzaSelectObjectsCancelEvent: CadenzaEvent<"selectObjects:cancel">

    When the user cancelled the selection.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CadenzaSelectObjectsOkEvent.html b/types/CadenzaSelectObjectsOkEvent.html index f52f01bf..56eb7634 100644 --- a/types/CadenzaSelectObjectsOkEvent.html +++ b/types/CadenzaSelectObjectsOkEvent.html @@ -1,3 +1,3 @@ CadenzaSelectObjectsOkEvent | Cadenza JS - v2.13.0

    Type alias CadenzaSelectObjectsOkEvent

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

    When the user submitted the selection.

    For a selection in a workbook map view with activated feature info, the values also include the simplified geometries of the selected objects.

    -

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/DataType.html b/types/DataType.html index 5676a2da..46cbe436 100644 --- a/types/DataType.html +++ b/types/DataType.html @@ -1,3 +1,3 @@ DataType | Cadenza JS - v2.13.0

    Type alias DataType

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

    A data type

    See JSON Representation of Cadenza Object Data for JSON data.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/EmbeddingTargetId.html b/types/EmbeddingTargetId.html index 0864bb91..9a08cf4b 100644 --- a/types/EmbeddingTargetId.html +++ b/types/EmbeddingTargetId.html @@ -6,4 +6,4 @@
  • 🇺🇸 "More" > "Manage workbook" > "Embedding"

    • The name of an embedding target (as entered in the UI) is its ID.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Extent.html b/types/Extent.html index 1ac21a14..bc4fe1d7 100644 --- a/types/Extent.html +++ b/types/Extent.html @@ -1,2 +1,2 @@ Extent | Cadenza JS - v2.13.0

    Type alias Extent

    Extent: [number, number, number, number]

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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/FilterVariables.html b/types/FilterVariables.html index ec92e4f7..cd957e92 100644 --- a/types/FilterVariables.html +++ b/types/FilterVariables.html @@ -2,4 +2,4 @@

    Variables of type String, Integer, Long, Double and Date can be set.

    Note: Since numbers in JavaScript are Double values (more info on MDN), for Long variables, the API is currently limited to the Double value range.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/GeometryType.html b/types/GeometryType.html index 29b80489..900c6a8c 100644 --- a/types/GeometryType.html +++ b/types/GeometryType.html @@ -1,3 +1,3 @@ GeometryType | Cadenza JS - v2.13.0

    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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/GlobalId.html b/types/GlobalId.html index ba641a28..d84dd12d 100644 --- a/types/GlobalId.html +++ b/types/GlobalId.html @@ -1,2 +1,2 @@ GlobalId | Cadenza JS - v2.13.0

    Type alias GlobalId

    GlobalId: OpaqueString<"GlobalId">

    The ID of a navigator item

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/LengthUnit.html b/types/LengthUnit.html index 4a673f62..ab9de51d 100644 --- a/types/LengthUnit.html +++ b/types/LengthUnit.html @@ -1 +1 @@ -LengthUnit | Cadenza JS - v2.13.0

    Type alias LengthUnit

    LengthUnit: "m" | "km"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +LengthUnit | Cadenza JS - v2.13.0

    Type alias LengthUnit

    LengthUnit: "m" | "km"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/OpaqueString.html b/types/OpaqueString.html index 0a3b1a8b..ebbed791 100644 --- a/types/OpaqueString.html +++ b/types/OpaqueString.html @@ -3,4 +3,4 @@ You don't need to actually add that __type property. In TS code, just use a type assertion (e.g. cadenzaClient.show('<embeddingTargetId>' as EmbeddingTargetId)).

    -

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type Parameters

    Type declaration

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/OperationMode.html b/types/OperationMode.html index e7810877..81b23c2f 100644 --- a/types/OperationMode.html +++ b/types/OperationMode.html @@ -1,2 +1,2 @@ OperationMode | Cadenza JS - v2.13.0

    Type alias OperationMode

    OperationMode: "normal" | "simplified"

    The mode in which a workbook should be operated

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/TablePart.html b/types/TablePart.html index 62b560e1..405c282f 100644 --- a/types/TablePart.html +++ b/types/TablePart.html @@ -1,2 +1,2 @@ TablePart | Cadenza JS - v2.13.0

    Type alias TablePart

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

    A part of a table to export

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/UiFeature.html b/types/UiFeature.html index 5223982a..1a0e3881 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

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/WorkbookLayerPath.html b/types/WorkbookLayerPath.html index 901d4ffc..f9e820b0 100644 --- a/types/WorkbookLayerPath.html +++ b/types/WorkbookLayerPath.html @@ -1,3 +1,3 @@ WorkbookLayerPath | Cadenza JS - v2.13.0

    Type alias WorkbookLayerPath

    WorkbookLayerPath: string[]

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

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/ZoomTarget.html b/types/ZoomTarget.html index 8344f3a1..2d9002c5 100644 --- a/types/ZoomTarget.html +++ b/types/ZoomTarget.html @@ -1,2 +1,2 @@ ZoomTarget | Cadenza JS - v2.13.0

    Type alias ZoomTarget

    ZoomTarget: GeometryZoomTarget

    An object describing a target to zoom to

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file