Readonly ABORT_Readonly DATA_Readonly DOMSTRING_Readonly HIERARCHY_Readonly INDEX_Readonly INUSE_Readonly INVALID_Readonly INVALID_Readonly INVALID_Readonly INVALID_Readonly INVALID_Readonly NAMESPACE_Readonly NETWORK_Readonly NOT_Readonly NOT_Readonly NO_Readonly NO_Readonly QUOTA_Readonly SECURITY_Readonly SYNTAX_Readonly TIMEOUT_Readonly TYPE_Readonly URL_Readonly VALIDATION_Readonly WRONG_Optional causeReadonly codeReadonly ABORT_Readonly DATA_Readonly DOMSTRING_Readonly HIERARCHY_Readonly INDEX_Readonly INUSE_Readonly INVALID_Readonly INVALID_Readonly INVALID_Readonly INVALID_Readonly INVALID_Readonly NAMESPACE_Readonly NETWORK_Readonly NOT_Readonly NOT_Readonly NO_Readonly NO_Readonly QUOTA_Readonly SECURITY_Readonly SYNTAX_Readonly TIMEOUT_Readonly TYPE_Readonly URL_Readonly VALIDATION_Readonly WRONG_Optional causeReadonly codeReadonly messageReadonly nameOptional stackStatic Readonly ABORT_Static Readonly DATA_Static Readonly DOMSTRING_Static Readonly HIERARCHY_Static Readonly INDEX_Static Readonly INUSE_Static Readonly INVALID_Static Readonly INVALID_Static Readonly INVALID_Static Readonly INVALID_Static Readonly INVALID_Static Readonly NAMESPACE_Static Readonly NETWORK_Static Readonly NOT_Static Readonly NOT_Static Readonly NO_Static Readonly NO_Static Readonly QUOTA_Static Readonly SECURITY_Static Readonly SYNTAX_Static Readonly TIMEOUT_Static Readonly TYPE_Static Readonly URL_Static Readonly VALIDATION_Static Readonly WRONG_Private Readonly #basePrivate Readonly #debugPrivate Readonly #iframePrivate #iframePrivate Readonly #originPrivate #subscriptionsPrivate Readonly #webPrivate #requiredPrivate #targetThe base URL of the Cadenza server this client is requesting
-The iframe this client is using for embedding Cadenza.
-Private #createPrivate #downloadPrivate #fetchPrivate Readonly #basePrivate Readonly #debugPrivate Readonly #iframePrivate #iframePrivate Readonly #originPrivate #subscriptionsPrivate Readonly #webPrivate #requiredPrivate #targetThe base URL of the Cadenza server this client is requesting
+The iframe this client is using for embedding Cadenza.
+Private #createPrivate #downloadPrivate #fetchstring
URLSearchParams
AbortSignal | undefined
String | undefined If body is set, the fetch will be a post.
-Private #getPrivate #logPrivate #onPrivate #onMessageEvent<CadenzaEvent<never, never>>
-Private #postPrivate #postPrivate #getPrivate #logPrivate #onPrivate #onMessageEvent<CadenzaEvent<never, never>>
+Private #postPrivate #postPosts 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.
-Optional detail: unknownPrivate #setPrivate #showEmbed Create a geometry.
+Optional detail: unknownPrivate #setPrivate #showEmbed Create a geometry.
Note: Under the hood, creating a geometry is similar to editing a geometry.
That's why the events use the editGeometry prefix.
The workbook map view in the background
@@ -88,9 +88,9 @@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.
The workbook view to fetch data from.
The data type you want to get back from the server. @@ -102,7 +102,7 @@
Filter variables
Table parts to export; If not specified, all parts are exported.
Rest ...args: anyFor invalid arguments
-Embed Edit a geometry.
The workbook map view in the background
The geometry
Optional __namedParameters: { Server Fetch the intersection areas from a workbook map view layer in JSON format for a given area.
+Rest ...args: anyServer Fetch the intersection areas from a workbook map view layer in JSON format for a given area.
The workbook view to fetch object info from.
Layer path to identify the layer (identified using layer paths or print names)
@@ -135,7 +135,7 @@A signal to abort the data fetching
The intersection geometry and the result geometries are in the map's SRS (otherwise EPSG:4326 is assumed)
Rest ...args: anyA Promise for the fetch response
Server Fetch data from a workbook view.
+Server Fetch data from a workbook view.
The workbook view to fetch data from.
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 @@
A signal to abort the data fetching
Rest ...args: anyA Promise for the fetch response
For invalid arguments
-Fetch object info from a workbook map view.
+Fetch object info from a workbook map view.
The workbook view to fetch object info from.
Layer path to identify the layer (identified using layer paths or print names)
@@ -159,15 +159,15 @@Use the map SRS instead of WGS84
Rest ...args: anyA Promise for the fetch response
For invalid arguments
-Subscribe to a postMessage() event.
Subscribe to a postMessage() event.
The event type
The subscriber function
An unsubscribe function
-Post Message Reload the views of a worksheet.
+Post Message Reload the views of a worksheet.
Optional __namedParameters: { Options
When true, caches will be invalidated for objecttypes used in the worksheet
-Rest ...args: anyEmbed Select objects in a workbook map.
+Rest ...args: anyEmbed Select objects in a workbook map.
The workbook map view
Optional __namedParameters: { Options
Defines the initial map extent; If not given, Cadenza's default logic is used.
@@ -187,14 +187,14 @@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.
The message to show in the dialog
Optional type: CustomValidityType = 'error'The type of message (defaults to 'error')
-Embed Show a page, workbook, worksheet or workbook view in an iframe.
The source to show
Optional __namedParameters: { Set to 'pdf' for embedding targets of type report and of views with view type of "JasperReports report" to show the generated report PDF directly (without any Cadenza headers or @@ -214,7 +214,7 @@
Embed Show a workbook map view in an iframe.
The workbook map view to show
Optional __namedParameters: { Options
Layer definitions to be imported and shown in the background, as a basis for the drawing.
@@ -237,4 +237,4 @@
Deprecated
MDN Reference
+