From 4c9e6a4ad01ae47f873c9ac692bc733ff9cd1514 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 26 Nov 2024 10:01:55 +0000 Subject: [PATCH] Updates --- classes/AbortError.html | 4 +- classes/CadenzaClient.html | 46 ++++++++++---------- 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 | 16 +++---- interfaces/FeatureCollection.html | 6 +-- interfaces/Geometry.html | 6 +-- interfaces/GeometryExtentStrategy.html | 6 +-- interfaces/LayerDataExtentStrategy.html | 6 +-- interfaces/LayerDefinition.html | 8 ++-- interfaces/LocationFinderExtentStrategy.html | 6 +-- interfaces/PageSource.html | 4 +- interfaces/StaticExtentStrategy.html | 6 +-- 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/CadenzaReloadEvent.html | 2 +- types/CadenzaSelectObjectsCancelEvent.html | 2 +- types/CadenzaSelectObjectsOkEvent.html | 2 +- types/Coordinate.html | 2 +- types/CustomValidityType.html | 2 +- types/DataType.html | 2 +- types/EmbeddingTargetId.html | 2 +- types/Extent.html | 2 +- types/ExtentStrategy.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 +- 45 files changed, 103 insertions(+), 103 deletions(-) diff --git a/classes/AbortError.html b/classes/AbortError.html index e1430b7c..2c2e0f14 100644 --- a/classes/AbortError.html +++ b/classes/AbortError.html @@ -1,4 +1,4 @@ -AbortError | Cadenza JS - v10.2.7-dev

Class AbortError

Hierarchy

  • DOMException
    • AbortError

Constructors

constructor +AbortError | Cadenza JS - v10.2.7-dev

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 d8fd0249..6179fe33 100644 --- a/classes/CadenzaClient.html +++ b/classes/CadenzaClient.html @@ -16,7 +16,7 @@ -

Properties

#baseUrl +

Properties

#baseUrl #debug #iframe #iframeElement @@ -53,19 +53,19 @@ setCustomValidity 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 #setExtentStrategy

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 #setExtentStrategy

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. @@ -102,7 +102,7 @@

      Fires

    • filter: undefined | FilterVariables

      Filter variables

    • parts: undefined | TablePart[]

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

  • 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

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)

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

      Fires

    • signal: undefined | AbortSignal

      A signal to abort the data fetching

    • useMapSrs: undefined | boolean

      The intersection geometry and the result geometries are in the map's SRS (otherwise EPSG:4326 is assumed)

  • 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 embedding targets of type view with a view type of @@ -147,7 +147,7 @@

      Fires

    • signal: undefined | AbortSignal

      A signal to abort the data fetching

  • Rest ...args: any

Returns Promise<Response>

A Promise for the fetch response

Throws

For invalid arguments

-

fetchObjectInfo

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)

      @@ -159,15 +159,15 @@

      Fires

    • useMapSrs: undefined | boolean

      Use the map SRS instead of WGS84

  • 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.

    +
      • (): void

      • Returns void

reload

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

    Reload the views of a worksheet.

    Parameters

    • Optional __namedParameters: {
          invalidateCaches: undefined | boolean;
      } = {}

      Options

      • invalidateCaches: undefined | boolean

        When true, caches will be invalidated for objecttypes used in the worksheet

        -
    • Rest ...args: any

    Returns void

selectObjects

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

    Select objects in a workbook map.

    +
  • Rest ...args: any

    • Returns void

    selectObjects

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

      Select objects in a workbook map.

      Parameters

    setCustomValidity

    • setCustomValidity(message, type?): void

    • Set custom validity state of the geometry editor in addition to the default validation state (including errors and +

    setCustomValidity

    • setCustomValidity(message, type?): void

    • Set custom validity state of the geometry editor in addition to the default validation state (including errors and warnings). When set to error the dialog submission is blocked. If there already is a custom state set it will override it. Passing '' will reset the custom state to undefined, meaning no custom state is displayed. If no geometry editing is started, the method call has no effect.

      Parameters

      • message: string

        The message to show in the dialog

      • Optional type: CustomValidityType = 'error'

        The type of message (defaults to 'error')

        -

      Returns void

    show

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

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

      +

    Returns void

    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;
        } = {}

    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: {
            additionalLayers: undefined | LayerDefinition[];
            disabledUiFeatures: undefined | UiFeature[];
            expandNavigator: undefined | boolean;
            extentStrategy: undefined | ExtentStrategy;
            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;
        } = {}

        Options

    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#setExtentStrategy#showcloseMecreateGeometrydestroydownloadDataeditGeometryexpandNavigatorfetchAreaIntersectionsfetchDatafetchObjectInfoonreloadselectObjectssetCustomValidityshowshowMap
    \ 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#setExtentStrategy#showcloseMecreateGeometrydestroydownloadDataeditGeometryexpandNavigatorfetchAreaIntersectionsfetchDatafetchObjectInfoonreloadselectObjectssetCustomValidityshowshowMap
    \ No newline at end of file diff --git a/classes/CadenzaError.html b/classes/CadenzaError.html index 1c342054..a663bd97 100644 --- a/classes/CadenzaError.html +++ b/classes/CadenzaError.html @@ -1,6 +1,6 @@ CadenzaError | Cadenza JS - v10.2.7-dev

    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 deca7395..59cd5902 100644 --- a/functions/cadenza.html +++ b/functions/cadenza.html @@ -1,10 +1,10 @@ cadenza | Cadenza JS - v10.2.7-dev

    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 f8bdfa7f..0fb8f4de 100644 --- a/interfaces/CadenzaClientOptions.html +++ b/interfaces/CadenzaClientOptions.html @@ -1,14 +1,14 @@ -CadenzaClientOptions | Cadenza JS - v10.2.7-dev

    Interface CadenzaClientOptions

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

    Properties

    baseUrl +CadenzaClientOptions | Cadenza JS - v10.2.7-dev

    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 260f167c..cb98f44f 100644 --- a/interfaces/CadenzaEvent.html +++ b/interfaces/CadenzaEvent.html @@ -1,6 +1,6 @@ CadenzaEvent | Cadenza JS - v10.2.7-dev

    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 d4729357..42466b4e 100644 --- a/interfaces/Distance.html +++ b/interfaces/Distance.html @@ -1,3 +1,3 @@ -Distance | Cadenza JS - v10.2.7-dev

    Interface Distance

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

    Properties

    lengthUnit +Distance | Cadenza JS - v10.2.7-dev

    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 1d81b4f4..d1d928c6 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 8264825e..f3df5be7 100644 --- a/interfaces/Feature.html +++ b/interfaces/Feature.html @@ -1,5 +1,5 @@ Feature | Cadenza JS - v10.2.7-dev

    Interface Feature

    A adapted GeoJSON feature object.

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

    Properties

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

    Properties

    area circumference geometry length @@ -7,10 +7,10 @@ properties type

    Properties

    area

    area: undefined | number

    The area of a Polygon feature

    -

    circumference

    circumference: undefined | number

    The circumference of a Polygon feature

    -

    geometry

    geometry: Geometry

    The geometry

    -

    length

    length: undefined | number

    The length of a LineString feature

    -

    objectId

    objectId: any[]

    The id of the feature

    -

    properties

    properties: Record<string, string>

    The formated properties

    -

    type

    type: "Feature"

    The object's type

    -

    Settings

    Member Visibility

    Theme

    On This Page

    areacircumferencegeometrylengthobjectIdpropertiestype
    \ No newline at end of file +

    circumference

    circumference: undefined | number

    The circumference of a Polygon feature

    +

    geometry

    geometry: Geometry

    The geometry

    +

    length

    length: undefined | number

    The length of a LineString feature

    +

    objectId

    objectId: any[]

    The id of the feature

    +

    properties

    properties: Record<string, string>

    The formated properties

    +

    type

    type: "Feature"

    The object's type

    +

    Settings

    Member Visibility

    Theme

    On This Page

    areacircumferencegeometrylengthobjectIdpropertiestype
    \ No newline at end of file diff --git a/interfaces/FeatureCollection.html b/interfaces/FeatureCollection.html index 27e28acb..d7a50141 100644 --- a/interfaces/FeatureCollection.html +++ b/interfaces/FeatureCollection.html @@ -1,6 +1,6 @@ FeatureCollection | Cadenza JS - v10.2.7-dev

    Interface FeatureCollection

    A adapted GeoJSON feature collection object

    -
    interface FeatureCollection {
        features: Feature[];
        type: "FeatureCollection";
    }

    Properties

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

    Properties

    features type

    Properties

    features

    features: Feature[]

    The features within this collection

    -

    type

    type: "FeatureCollection"

    The object's type

    -

    Settings

    Member Visibility

    Theme

    On This Page

    featurestype
    \ No newline at end of file +

    type

    type: "FeatureCollection"

    The object's type

    +

    Settings

    Member Visibility

    Theme

    On This Page

    featurestype
    \ No newline at end of file diff --git a/interfaces/Geometry.html b/interfaces/Geometry.html index 27aae273..98e0d9b3 100644 --- a/interfaces/Geometry.html +++ b/interfaces/Geometry.html @@ -1,6 +1,6 @@ Geometry | Cadenza JS - v10.2.7-dev

    Interface Geometry

    A GeoJSON geometry object

    -
    interface Geometry {
        coordinates: Coordinate | Coordinate[] | Coordinate[][] | Coordinate[][][];
        type: GeometryType;
    }

    Properties

    coordinates +
    interface Geometry {
        coordinates: Coordinate | Coordinate[] | Coordinate[][] | Coordinate[][][];
        type: GeometryType;
    }

    Properties

    coordinates type

    Properties

    coordinates

    coordinates: Coordinate | Coordinate[] | Coordinate[][] | Coordinate[][][]

    The coordinates of the geometry

    -

    type

    type: GeometryType

    The type of the geometry

    -

    Settings

    Member Visibility

    Theme

    On This Page

    coordinatestype
    \ No newline at end of file +

    type

    type: GeometryType

    The type of the geometry

    +

    Settings

    Member Visibility

    Theme

    On This Page

    coordinatestype
    \ No newline at end of file diff --git a/interfaces/GeometryExtentStrategy.html b/interfaces/GeometryExtentStrategy.html index a090c7c6..883d522c 100644 --- a/interfaces/GeometryExtentStrategy.html +++ b/interfaces/GeometryExtentStrategy.html @@ -1,6 +1,6 @@ GeometryExtentStrategy | Cadenza JS - v10.2.7-dev

    Interface GeometryExtentStrategy

    The given Geometry defines the initial map extent.

    -
    interface GeometryExtentStrategy {
        geometry: undefined | Geometry;
        type: "geometry";
    }

    Properties

    geometry +
    interface GeometryExtentStrategy {
        geometry: undefined | Geometry;
        type: "geometry";
    }

    Properties

    geometry type

    Properties

    geometry

    geometry: undefined | Geometry

    This geometry takes precedence over another geometry that might be given in an API call.

    -

    type

    type: "geometry"

    The extent strategy type

    -

    Settings

    Member Visibility

    Theme

    On This Page

    geometrytype
    \ No newline at end of file +

    type

    type: "geometry"

    The extent strategy type

    +

    Settings

    Member Visibility

    Theme

    On This Page

    geometrytype
    \ No newline at end of file diff --git a/interfaces/LayerDataExtentStrategy.html b/interfaces/LayerDataExtentStrategy.html index d1862dd9..6be9192c 100644 --- a/interfaces/LayerDataExtentStrategy.html +++ b/interfaces/LayerDataExtentStrategy.html @@ -1,7 +1,7 @@ LayerDataExtentStrategy | Cadenza JS - v10.2.7-dev

    Interface LayerDataExtentStrategy

    The given layers define the initial map extent.

    -
    interface LayerDataExtentStrategy {
        layers: undefined | (string | WorkbookLayerPath)[];
        type: "layerData";
    }

    Properties

    layers +
    interface LayerDataExtentStrategy {
        layers: undefined | (string | WorkbookLayerPath)[];
        type: "layerData";
    }

    Properties

    layers type

    Properties

    layers

    layers: undefined | (string | WorkbookLayerPath)[]

    A layer is ignored if either the layer or its extent is not known to Cadenza. If no layers are given, all map layers are used.

    -

    type

    type: "layerData"

    The extent strategy type

    -

    Settings

    Member Visibility

    Theme

    On This Page

    layerstype
    \ No newline at end of file +

    type

    type: "layerData"

    The extent strategy type

    +

    Settings

    Member Visibility

    Theme

    On This Page

    layerstype
    \ No newline at end of file diff --git a/interfaces/LayerDefinition.html b/interfaces/LayerDefinition.html index 7cec18f2..5994d655 100644 --- a/interfaces/LayerDefinition.html +++ b/interfaces/LayerDefinition.html @@ -1,7 +1,7 @@ -LayerDefinition | Cadenza JS - v10.2.7-dev

    Interface LayerDefinition

    interface LayerDefinition {
        content: FeatureCollection;
        name: string;
        type: "geojson";
    }

    Properties

    content +LayerDefinition | Cadenza JS - v10.2.7-dev

    Interface LayerDefinition

    interface LayerDefinition {
        content: FeatureCollection;
        name: string;
        type: "geojson";
    }

    Properties

    content name type

    Properties

    content

    content: FeatureCollection

    The layer's content in geojson format.

    -

    name

    name: string

    The layer's name.

    -

    type

    type: "geojson"

    The layer's type.

    -

    Settings

    Member Visibility

    Theme

    On This Page

    contentnametype
    \ No newline at end of file +

    name

    name: string

    The layer's name.

    +

    type

    type: "geojson"

    The layer's type.

    +

    Settings

    Member Visibility

    Theme

    On This Page

    contentnametype
    \ No newline at end of file diff --git a/interfaces/LocationFinderExtentStrategy.html b/interfaces/LocationFinderExtentStrategy.html index ffc333e5..9902d42f 100644 --- a/interfaces/LocationFinderExtentStrategy.html +++ b/interfaces/LocationFinderExtentStrategy.html @@ -1,6 +1,6 @@ LocationFinderExtentStrategy | Cadenza JS - v10.2.7-dev

    Interface LocationFinderExtentStrategy

    The first result of a location finder query defines the initial map extent.

    -
    interface LocationFinderExtentStrategy {
        query: string;
        type: "locationFinder";
    }

    Properties

    query +
    interface LocationFinderExtentStrategy {
        query: string;
        type: "locationFinder";
    }

    Properties

    query type

    Properties

    query

    query: string

    This query takes precedence over another query that might be given in an API call.

    -

    type

    type: "locationFinder"

    The extent strategy type

    -

    Settings

    Member Visibility

    Theme

    On This Page

    querytype
    \ No newline at end of file +

    type

    type: "locationFinder"

    The extent strategy type

    +

    Settings

    Member Visibility

    Theme

    On This Page

    querytype
    \ No newline at end of file diff --git a/interfaces/PageSource.html b/interfaces/PageSource.html index af5d5510..e3fe34c9 100644 --- a/interfaces/PageSource.html +++ b/interfaces/PageSource.html @@ -1,4 +1,4 @@ PageSource | Cadenza JS - v10.2.7-dev

    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/interfaces/StaticExtentStrategy.html b/interfaces/StaticExtentStrategy.html index 46da4e26..4658d7f7 100644 --- a/interfaces/StaticExtentStrategy.html +++ b/interfaces/StaticExtentStrategy.html @@ -1,6 +1,6 @@ StaticExtentStrategy | Cadenza JS - v10.2.7-dev

    Interface StaticExtentStrategy

    The given extent is used as the initial map extent.

    -
    interface StaticExtentStrategy {
        extent: Extent;
        type: "static";
    }

    Properties

    extent +
    interface StaticExtentStrategy {
        extent: Extent;
        type: "static";
    }

    Properties

    extent type

    Properties

    extent

    extent: Extent

    This extent takes precedence over another extent that might be given in an API call.

    -

    type

    type: "static"

    The extent strategy type

    -

    Settings

    Member Visibility

    Theme

    On This Page

    extenttype
    \ No newline at end of file +

    type

    type: "static"

    The extent strategy type

    +

    Settings

    Member Visibility

    Theme

    On This Page

    extenttype
    \ No newline at end of file diff --git a/types/CadenzaActionEvent.html b/types/CadenzaActionEvent.html index 1b56deb1..a438af76 100644 --- a/types/CadenzaActionEvent.html +++ b/types/CadenzaActionEvent.html @@ -1,2 +1,2 @@ CadenzaActionEvent | Cadenza JS - v10.2.7-dev

    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 8ca7da90..399e92e4 100644 --- a/types/CadenzaChangeSelectionEvent.html +++ b/types/CadenzaChangeSelectionEvent.html @@ -1,3 +1,3 @@ CadenzaChangeSelectionEvent | Cadenza JS - v10.2.7-dev

    Type alias CadenzaChangeSelectionEvent

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

    When the user changed the selection. undefined if no objects were selected.

    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 d4fa0a8f..9da0d9a9 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 9858ef80..305c49dd 100644 --- a/types/CadenzaEditGeometryCancelEvent.html +++ b/types/CadenzaEditGeometryCancelEvent.html @@ -1,2 +1,2 @@ CadenzaEditGeometryCancelEvent | Cadenza JS - v10.2.7-dev

    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 93a992ea..3de98410 100644 --- a/types/CadenzaEditGeometryOkEvent.html +++ b/types/CadenzaEditGeometryOkEvent.html @@ -1,2 +1,2 @@ CadenzaEditGeometryOkEvent | Cadenza JS - v10.2.7-dev

    Type alias CadenzaEditGeometryOkEvent

    CadenzaEditGeometryOkEvent: CadenzaEvent<"editGeometry:ok", Feature>

    When the user submitted the geometry.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CadenzaEditGeometryUpdateEvent.html b/types/CadenzaEditGeometryUpdateEvent.html index 84abef03..89cf1fd4 100644 --- a/types/CadenzaEditGeometryUpdateEvent.html +++ b/types/CadenzaEditGeometryUpdateEvent.html @@ -1,2 +1,2 @@ CadenzaEditGeometryUpdateEvent | Cadenza JS - v10.2.7-dev

    Type alias CadenzaEditGeometryUpdateEvent

    CadenzaEditGeometryUpdateEvent: CadenzaEvent<"editGeometry:update", FeatureCollection | Feature | undefined>

    When the user changed the geometry. FeatureCollection if multiple features are present on the edit layer, but the original defined type is not multi-geometry. This is also the case if the dialog was instantiated from a geometry and the original defined type is inherited. undefined if no feature is present on the edit layer.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CadenzaErrorEvent.html b/types/CadenzaErrorEvent.html index ebd759b2..dbacf8a3 100644 --- a/types/CadenzaErrorEvent.html +++ b/types/CadenzaErrorEvent.html @@ -1,2 +1,2 @@ CadenzaErrorEvent | Cadenza JS - v10.2.7-dev

    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 b3f18c16..76903168 100644 --- a/types/CadenzaEventByType.html +++ b/types/CadenzaEventByType.html @@ -1 +1 @@ -CadenzaEventByType | Cadenza JS - v10.2.7-dev

    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
                                        : T extends "reload"
                                            ? CadenzaReloadEvent
                                            : never

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +CadenzaEventByType | Cadenza JS - v10.2.7-dev

    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
                                        : T extends "reload"
                                            ? CadenzaReloadEvent
                                            : never

    Type Parameters

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CadenzaEventType.html b/types/CadenzaEventType.html index 8c2695b8..ed41ab09 100644 --- a/types/CadenzaEventType.html +++ b/types/CadenzaEventType.html @@ -1,2 +1,2 @@ CadenzaEventType | Cadenza JS - v10.2.7-dev

    Type alias CadenzaEventType

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

    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 2da8d46b..7be16308 100644 --- a/types/CadenzaObjectInfoEvent.html +++ b/types/CadenzaObjectInfoEvent.html @@ -1,2 +1,2 @@ CadenzaObjectInfoEvent | Cadenza JS - v10.2.7-dev

    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/CadenzaReloadEvent.html b/types/CadenzaReloadEvent.html index 749cbdd2..b1c7984e 100644 --- a/types/CadenzaReloadEvent.html +++ b/types/CadenzaReloadEvent.html @@ -2,4 +2,4 @@

    If a user does not interact with the iframe displaying the Cadenza content for a while, a standby embed page is displayed and the user can click a reload button there. Then the application using Cadenza JS can re-trigger the loading of the iframe with the correct original URL and parameters and do what was originally done when displaying that iframe.

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CadenzaSelectObjectsCancelEvent.html b/types/CadenzaSelectObjectsCancelEvent.html index f7e0d40d..c70f0e25 100644 --- a/types/CadenzaSelectObjectsCancelEvent.html +++ b/types/CadenzaSelectObjectsCancelEvent.html @@ -1,2 +1,2 @@ CadenzaSelectObjectsCancelEvent | Cadenza JS - v10.2.7-dev

    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 860df12b..0598c443 100644 --- a/types/CadenzaSelectObjectsOkEvent.html +++ b/types/CadenzaSelectObjectsOkEvent.html @@ -1,3 +1,3 @@ CadenzaSelectObjectsOkEvent | Cadenza JS - v10.2.7-dev

    Type alias CadenzaSelectObjectsOkEvent

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

    When the user submitted the selection. undefined if no objects were selected.

    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/Coordinate.html b/types/Coordinate.html index f55b9f10..90428a8b 100644 --- a/types/Coordinate.html +++ b/types/Coordinate.html @@ -1,2 +1,2 @@ Coordinate | Cadenza JS - v10.2.7-dev

    Type alias Coordinate

    Coordinate: [number, number]

    A tuple with an x and y value

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/CustomValidityType.html b/types/CustomValidityType.html index e44e324a..4cfdadbf 100644 --- a/types/CustomValidityType.html +++ b/types/CustomValidityType.html @@ -1,2 +1,2 @@ CustomValidityType | Cadenza JS - v10.2.7-dev

    Type alias CustomValidityType

    CustomValidityType: "error" | "warning" | "info" | "success"

    The type of custom validity used for disclose on visual presentation and form submission behavior

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/DataType.html b/types/DataType.html index 1275a1e1..675ae51e 100644 --- a/types/DataType.html +++ b/types/DataType.html @@ -1,3 +1,3 @@ DataType | Cadenza JS - v10.2.7-dev

    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 e91e4966..29a6857c 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 9071e22a..806e20f0 100644 --- a/types/Extent.html +++ b/types/Extent.html @@ -1,2 +1,2 @@ Extent | Cadenza JS - v10.2.7-dev

    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/ExtentStrategy.html b/types/ExtentStrategy.html index 3d859ec8..e343cb9b 100644 --- a/types/ExtentStrategy.html +++ b/types/ExtentStrategy.html @@ -2,4 +2,4 @@ If the options do not result in a defined extent, Cadenza's default logic is used: The map will zoom in the way the underlying workbook map view was configured to initially zoom including all auto zooming configurations.

    -

    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 0a41e2d1..c15b1c5e 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 60baaac9..b271f0ee 100644 --- a/types/GeometryType.html +++ b/types/GeometryType.html @@ -1,3 +1,3 @@ GeometryType | Cadenza JS - v10.2.7-dev

    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 abee49ba..bf1fdac9 100644 --- a/types/GlobalId.html +++ b/types/GlobalId.html @@ -1,2 +1,2 @@ GlobalId | Cadenza JS - v10.2.7-dev

    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 b0a9a75c..96c0a646 100644 --- a/types/LengthUnit.html +++ b/types/LengthUnit.html @@ -1 +1 @@ -LengthUnit | Cadenza JS - v10.2.7-dev

    Type alias LengthUnit

    LengthUnit: "m" | "km"

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +LengthUnit | Cadenza JS - v10.2.7-dev

    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 ee23db1a..0bebcca7 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 b3acc6bb..144fa6de 100644 --- a/types/OperationMode.html +++ b/types/OperationMode.html @@ -1,2 +1,2 @@ OperationMode | Cadenza JS - v10.2.7-dev

    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 01f6defa..d62cc48a 100644 --- a/types/TablePart.html +++ b/types/TablePart.html @@ -1,2 +1,2 @@ TablePart | Cadenza JS - v10.2.7-dev

    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 7e0e9785..61d4c149 100644 --- a/types/UiFeature.html +++ b/types/UiFeature.html @@ -5,4 +5,4 @@
  • "workbook-map-add-layer"- Add layers to the map
  • "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 828f780a..96d4e930 100644 --- a/types/WorkbookLayerPath.html +++ b/types/WorkbookLayerPath.html @@ -1,3 +1,3 @@ WorkbookLayerPath | Cadenza JS - v10.2.7-dev

    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