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_Optional 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_Notes:
+Notes:
Embed: The method embeds Cadenza in the given iframe.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 @@An Error implementation for errors in the communication with Cadenza.
An Error implementation for errors in the communication with Cadenza.
Note: For invalid parameters, the Cadenza client will throw "normal" Errors.
The technical identifier of the error
A description of the error
-Private #typeOptional causeOptional stackStatic Optional prepareOptional override for formatting stack traces
+Private #typeOptional causeOptional stackStatic Optional prepareOptional override for formatting stack traces
Static stackStatic captureStatic stackStatic captureCreates an instance of the Cadenza JS client.
+Creates an instance of the Cadenza JS client.
Optional options: CadenzaClientOptionsOptions
For invalid arguments
-Creates an instance of the Cadenza JS client.
+Creates an instance of the Cadenza JS client.
The base URL of the Cadenza server
Optional options: CadenzaClientOptionsOptions
This overload is deprecated since and will eventually be removed. Please use the other overload.
For invalid arguments
-Cadenza JS is a JavaScript library to use the disy Cadenza APIs conveniently without having to deal with technical details like parameter encoding or the postMessage() Web API.
The base URL of the Cadenza server
-Whether to enable debug logging
-An iframe for embedding Cadenza or the iframe's ID. +
Whether to enable debug logging
+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.
An external link that Cadenza uses to resolve the +
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!
-A Cadenza postMessage() event
A Cadenza postMessage() event
Optional event details (depending on the event type)
-The event type
-The event type
+A tuple qualifying a Cadenza external link
+A tuple qualifying a Cadenza external link
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>?...
The name of the link's repository
+A adapted GeoJSON feature object.
-A adapted GeoJSON feature object.
+The area of a Polygon feature
The circumference of a Polygon feature
The geometry
-The length of a LineString feature
The id of the feature
-The formated properties
-The object's type
-The circumference of a Polygon feature
The geometry
+The length of a LineString feature
The id of the feature
+The formated properties
+The object's type
+A adapted GeoJSON feature collection object
-The object's type
+A GeoJSON geometry object
-A GeoJSON geometry object
+The coordinates of the geometry
-The type of the geometry
-The type of the geometry
+The given Geometry defines the initial map extent.
-The given Geometry defines the initial map extent.
+This geometry takes precedence over another geometry that might be given in an API call.
-The extent strategy type
-The extent strategy type
+The given layers define the initial map extent.
-The given layers define the initial map extent.
+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.
-The extent strategy type
-The extent strategy type
+The layer's name.
+The layer's type.
+The first result of a location finder query defines the initial map extent.
-The extent strategy type
+A well-known Cadenza page
-The given extent is used as the initial map extent.
-The extent strategy type
+When the user executed a POST message action, which is defined on an external link in the Cadenza management center.
-When the user executed a POST message action, which is defined on an external link in the Cadenza management center.
+When the user changed the selection. undefined if no objects were selected.
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.
-When the user executed a POST message drill-through.
+When the user executed a POST message drill-through.
The event includes a data row for every item in the workbook selection, each row consisting of the values of 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
Optional context?: stringOptional context?: stringWhen the user cancelled the geometry editing.
-When the user cancelled the geometry editing.
+When the user submitted the geometry.
-When the user submitted the geometry.
+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.
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.
An error event that is mapped to a CadenzaError
-Optional message?: stringAn error event that is mapped to a CadenzaError
+Optional message?: stringAn event type to subscribe to using CadenzaClient#on
-An event type to subscribe to using CadenzaClient#on
+When the user opened the object info flyout.
-When the user opened the object info flyout.
+When the user clicked on the 'reload' button in the embedding standby page
+When the user clicked on the 'reload' button in the embedding standby page
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.
-When the user cancelled the selection.
-When the user cancelled the selection.
+When the user submitted the selection. undefined if no objects were selected.
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.
-A tuple with an x and y value
-A tuple with an x and y value
+The type of custom validity used for disclose on visual presentation and form submission behavior
-The type of custom validity used for disclose on visual presentation and form submission behavior
+A data type
+A data type
See JSON Representation of Cadenza Object Data for JSON data.
-The ID of a Cadenza embedding target
+The ID of a Cadenza embedding target
Embedding targets are called 🇩🇪 "Einbettbarer Inhalt" / 🇺🇸 "Embeddable content" throughout the Cadenza UI and help. They're managed within the respective workbook:
The name of an embedding target (as entered in the UI) is its ID.
-An array of numbers representing an extent: [minx, miny, maxx, maxy]
-An array of numbers representing an extent: [minx, miny, maxx, maxy]
+Options for defining the initial extent of a workbook map view; +
Options for defining the initial extent of a workbook map view; 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.
-Filter variable names and values
+Filter variable names and values
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.
-A GeoJSON geometry type
+A GeoJSON geometry type
Note: The GeoJSON geometry type "GeometryCollection" is currently not supported.
-A specific string type that is not assignable from another string
A specific string type that is not assignable from another string
The idea is to have a specific type e.g. for the EmbeddingTargetId instead of a plain string.
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)).
The mode in which a workbook should be operated
-The mode in which a workbook should be operated
+A part of a table to export
-A part of a table to export
+The name of a Cadenza UI feature
+The name of a Cadenza UI feature
Note: Supported features are:
"workbook-design" - The workbook designer"workbook-map-add-layer"- Add layers to the map"workbook-view-management" - Add/Edit/Remove workbook views (Is included in 'workbook-design'.)Identifies a layer within a workbook map view +
Identifies a layer within a workbook map view using the print names of the layer and - if the layer is grouped - its ancestors
-
Deprecated
MDN Reference
+