Class CadenzaClient

Notes:

Most public methods are tagged with one of these modifiers:
- Embed: The method embeds Cadenza in the given iframe.
- Post Message: The method communicates with an embedded Cadenza via postMessage.
- Post Message Parent: The method communicates with a parent/opener Cadenza via postMessage.
- Server: The method communicates with the Cadenza server via HTTP.
Most public methods can be aborted using an AbortSignal. When aborted, the result Promise is rejected with an AbortError.
If there's another error, the result Promise is rejected with a CadenzaError.
For methods that support the hideMainHeaderAndFooter and hideWorkbookToolBar parameters - the parameters cannot override the configuration of an embedding target.

Accessors

baseUrl

get baseUrl(): undefined | string
The base URL of the Cadenza server this client is requesting

Returns undefined | string
- Defined in src/cadenza.js:352

iframe

get iframe(): undefined | HTMLIFrameElement
The iframe this client is using for embedding Cadenza.

Returns undefined | HTMLIFrameElement
- Defined in src/cadenza.js:357

Methods

batchCreateGeometry

batchCreateGeometry(
    backgroundMapView: EmbeddingTargetId,
    geometryType: GeometryType,
    __namedParameters?: CommonEditGeometryOptions,
    ...args?: any,
): Promise<void>
Embed
Create multiple geometries.
Parameters
- backgroundMapView: EmbeddingTargetId
  The workbook map view in the background
- geometryType: GeometryType
  The type of geometries to create
- Optional__namedParameters: CommonEditGeometryOptions
- ...args: any = {}
Returns Promise<void>
A Promise for when the iframe is loaded
Throws
For invalid arguments
Fires
- Defined in src/cadenza.js:814

batchEditGeometry

batchEditGeometry(
    backgroundMapView: EmbeddingTargetId,
    features: FeatureCollection,
    __namedParameters?: CommonEditGeometryOptions,
    ...args?: any,
): Promise<void>
Embed
Edit multiple geometries.
Parameters
- backgroundMapView: EmbeddingTargetId
  The workbook map view in the background
- features: FeatureCollection
  The features to edit. The last feature in this collection is directly set up for editing.
- Optional__namedParameters: CommonEditGeometryOptions
- ...args: any = {}
Returns Promise<void>
A Promise for when the iframe is loaded
Throws
For invalid arguments
Fires
- Defined in src/cadenza.js:871

closeMe

closeMe(): void
Post Message Parent
Sends a message to parent Cadenza window to close the window containing this application

Returns void
- Defined in src/cadenza.js:477

createGeometry

createGeometry(
    backgroundMapView: EmbeddingTargetId,
    geometryType: GeometryType,
    __namedParameters?: CommonEditGeometryOptions,
    ...args?: any,
): Promise<void>
Embed
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.
Parameters
- backgroundMapView: EmbeddingTargetId
  The workbook map view in the background
- geometryType: GeometryType
  The geometry type
- Optional__namedParameters: CommonEditGeometryOptions
- ...args: any = {}
Returns Promise<void>
Throws
For invalid arguments
Fires
- Defined in src/cadenza.js:703

destroy

destroy(): void
Remove all subscriptions.

Returns void
See
CadenzaClient#on
- Defined in src/cadenza.js:1190

downloadData

downloadData(
    source: EmbeddingTargetId,
    dataType: DataType,
    __namedParameters?: {
        fileName?: string;
        filter?: FilterVariables;
        parts?: TablePart[];
    },
    ...args?: any,
): 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 embedding targets of type view with a view type of table and indicator. "pdf" is supported for embedding targets of type report and of type view with a view type of "JasperReports report".
- Optional__namedParameters: { fileName?: string; filter?: FilterVariables; parts?: TablePart[] }
  Options
  - OptionalfileName?: string
    The file name to use; The file extension is appended by Cadenza.
  - Optionalfilter?: FilterVariables
    Filter variables
  - Optionalparts?: TablePart[]
    Table parts to export; If not specified, all parts are exported.
- ...args: any = {}
Returns void
Throws
For invalid arguments
- Defined in src/cadenza.js:1404

editGeometry

editGeometry(
    backgroundMapView: EmbeddingTargetId,
    geometry: Geometry,
    __namedParameters?: CommonEditGeometryOptions,
    ...args?: any,
): Promise<void>
Embed
Edit a geometry.
Parameters
- backgroundMapView: EmbeddingTargetId
  The workbook map view in the background
- geometry: Geometry
  The geometry to edit
- Optional__namedParameters: CommonEditGeometryOptions
- ...args: any = {}
Returns Promise<void>
A Promise for when the iframe is loaded
Throws
For invalid arguments
Fires
- Defined in src/cadenza.js:755

expandNavigator

expandNavigator(expanded: boolean, ...args?: any): void
Post Message
Expand/collapse the navigator.
Parameters
- expanded: boolean
  The expansion state of the navigator
- ...args: any = true
Returns void
- Defined in src/cadenza.js:564

fetchAreaIntersections

fetchAreaIntersections(
    source: EmbeddingTargetId,
    layerPath: (string | WorkbookLayerPath)[],
    geometry: Geometry,
    __namedParameters?: {
        buffer?: Distance;
        includeGeometryValidationReport?: boolean;
        signal?: AbortSignal;
        useAutoCorrection?: boolean;
        useMapSrs?: boolean;
    },
    ...args?: any,
): Promise<AreaIntersectionsResult | ProblemDetails>
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?: Distance;
      includeGeometryValidationReport?: boolean;
      signal?: AbortSignal;
      useAutoCorrection?: boolean;
      useMapSrs?: boolean;
  }
  Options
  - Optionalbuffer?: Distance
    Buffer size for geometry of the transition
  - OptionalincludeGeometryValidationReport?: boolean
    Enables the list of corrected geometries, including error descriptions
  - Optionalsignal?: AbortSignal
    A signal to abort the data fetching
  - OptionaluseAutoCorrection?: boolean
    Enables the automatic correction of invalid geometries
  - OptionaluseMapSrs?: boolean
    The intersection geometry and the result geometries are in the map's SRS (otherwise EPSG:4326 is assumed)
- ...args: any = {}
Returns Promise<AreaIntersectionsResult | ProblemDetails>
A Promise for the fetch response
- Defined in src/cadenza.js:1316

fetchData

fetchData(
    source: EmbeddingTargetId,
    dataType: DataType,
    __namedParameters?: {
        filter?: FilterVariables;
        parts?: TablePart[];
        signal?: AbortSignal;
    },
    ...args?: any,
): 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 table and indicator. "pdf" is supported for embedding targets of type report and of type view with a view type of "JasperReports report".
- Optional__namedParameters: { filter?: FilterVariables; parts?: TablePart[]; signal?: AbortSignal }
  Options
  - Optionalfilter?: FilterVariables
    Filter variables
  - Optionalparts?: TablePart[]
    Table parts to export; If not specified, all parts are exported.
  - Optionalsignal?: AbortSignal
    A signal to abort the data fetching
- ...args: any = {}
Returns Promise<Response>
A Promise for the fetch response

Throws
For invalid arguments
- Defined in src/cadenza.js:1255

fetchObjectInfo

fetchObjectInfo(
    source: EmbeddingTargetId,
    layerPath: (string | WorkbookLayerPath)[],
    objectIds: unknown[][],
    __namedParameters?: {
        filter?: FilterVariables;
        fullGeometries?: boolean;
        signal?: AbortSignal;
        useMapSrs?: boolean;
    },
    ...args?: any,
): 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?: FilterVariables;
      fullGeometries?: boolean;
      signal?: AbortSignal;
      useMapSrs?: boolean;
  }
  Options
  - Optionalfilter?: FilterVariables
    Filter variables
  - OptionalfullGeometries?: boolean
    Return non-simplified geometries
  - Optionalsignal?: AbortSignal
    A signal to abort the data fetching
  - OptionaluseMapSrs?: boolean
    Use the map SRS instead of WGS84
- ...args: any = {}
Returns Promise<FeatureCollection>
A Promise for the fetch response

Throws
For invalid arguments
- Defined in src/cadenza.js:1277

getData

getData<T extends DataType>(
    dataType: DataType,
    __namedParameters?: {
        height?: number;
        width?: number;
        withScale?: boolean;
    },
    ...args?: any,
): Promise<T extends "png" ? Blob : never>
Post Message
Get data from the currently shown workbook view.

Currently, only map views are supported.
Type Parameters
- T extends DataType
Parameters
- dataType: DataType
  The requested data type. Currently, only "png" is
- Optional__namedParameters: { height?: number; width?: number; withScale?: boolean }
  Options
  - Optionalheight?: number
    The height of the resulting map image in px.
  - Optionalwidth?: number
    The width of the resulting map image in px.
  - OptionalwithScale?: boolean
    Whether to show the scale line and the scale on the map image.
- ...args: any = {}
Returns Promise<T extends "png" ? Blob : never>
- Defined in src/cadenza.js:583

on

on<TYPE extends CadenzaEventType>(
    type: TYPE,
    subscriber: (
        event: CadenzaEvent<TYPE, CadenzaEventByType<TYPE>["detail"]>,
    ) => void,
): () => void
Subscribe to a postMessage() event.
Type Parameters
- TYPE extends CadenzaEventType
Parameters
- type: TYPE
  The event type
- subscriber: (event: CadenzaEvent<TYPE, CadenzaEventByType<TYPE>["detail"]>) => void
  The subscriber function
Returns () => void
An unsubscribe function
- Defined in src/cadenza.js:1132

reload

reload(
__namedParameters?: { invalidateCaches?: boolean },
...args?: any,
): Promise<void>
Post Message
Reload the views of a worksheet.
Parameters
- Optional__namedParameters: { invalidateCaches?: boolean }
  Options
  - OptionalinvalidateCaches?: boolean
    When true, caches will be invalidated for objecttypes used in the worksheet
- ...args: any = {}
Returns Promise<void>
A Promise which resolves when the views of the worksheet have finished reloading
- Defined in src/cadenza.js:468

selectObjects

selectObjects(
    backgroundMapView: EmbeddingTargetId,
    __namedParameters?: {
        disabledUiFeatures?: UiFeature[];
        extentStrategy?: ExtentStrategy;
        filter?: FilterVariables;
        layers?: (string | WorkbookLayerPath)[];
        operationMode?: OperationMode;
        signal?: AbortSignal;
        useMapSrs?: boolean;
    },
    ...args?: any,
): Promise<void>
Embed
Select objects in a workbook map.
Parameters
- backgroundMapView: EmbeddingTargetId
  The workbook map view
- Optional__namedParameters: {
      disabledUiFeatures?: UiFeature[];
      extentStrategy?: ExtentStrategy;
      filter?: FilterVariables;
      layers?: (string | WorkbookLayerPath)[];
      operationMode?: OperationMode;
      signal?: AbortSignal;
      useMapSrs?: boolean;
  }
  Options
  - OptionaldisabledUiFeatures?: UiFeature[]
    Cadenza UI features to disable
  - OptionalextentStrategy?: ExtentStrategy
    Defines the initial map extent; If not given, Cadenza's default logic is used.
  - Optionalfilter?: FilterVariables
    Filter variables
  - Optionallayers?: (string | WorkbookLayerPath)[]
    Layers to restrict the selection to (identified using layer paths or print names)
  - OptionaloperationMode?: OperationMode
    The mode in which a workbook should be operated
  - Optionalsignal?: AbortSignal
    A signal to abort the iframe loading
  - OptionaluseMapSrs?: boolean
    Whether the coordinates specified in other parameters are specified in the map's SRS (otherwise EPSG:4326 is assumed)
- ...args: any = {}
Returns Promise<void>
A Promise for when the iframe is loaded
Throws
For invalid arguments
Fires
- Defined in src/cadenza.js:989

setCustomValidity

setCustomValidity(message: string, type?: CustomValidityType): 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
- Optionaltype: CustomValidityType = 'error'
  The type of message (defaults to 'error')
Returns void
- Defined in src/cadenza.js:960

show

show(
    source: EmbeddingTargetId | PageSource,
    __namedParameters?: {
        dataType?: DataType;
        disabledUiFeatures?: UiFeature[];
        expandNavigator?: boolean;
        filter?: FilterVariables;
        hideMainHeaderAndFooter?: boolean;
        hideWorkbookToolBar?: boolean;
        highlightGlobalId?: GlobalId;
        labelSet?: string;
        layout?: Layout;
        operationMode?: OperationMode;
        signal?: AbortSignal;
        worksheetPlaceholders?: WorksheetPlaceholders;
    },
    ...args?: any,
): 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?: DataType;
      disabledUiFeatures?: UiFeature[];
      expandNavigator?: boolean;
      filter?: FilterVariables;
      hideMainHeaderAndFooter?: boolean;
      hideWorkbookToolBar?: boolean;
      highlightGlobalId?: GlobalId;
      labelSet?: string;
      layout?: Layout;
      operationMode?: OperationMode;
      signal?: AbortSignal;
      worksheetPlaceholders?: WorksheetPlaceholders;
  }
  - OptionaldataType?: DataType
    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 footers).
  - OptionaldisabledUiFeatures?: UiFeature[]
    Cadenza UI features to disable
  - OptionalexpandNavigator?: boolean
    Indicates if the navigator should be expanded.
  - Optionalfilter?: FilterVariables
    Filter variables
  - OptionalhideMainHeaderAndFooter?: boolean
    Whether to hide the main Cadenza header and footer
  - OptionalhideWorkbookToolBar?: boolean
    Whether to hide the workbook toolbar
  - OptionalhighlightGlobalId?: GlobalId
    The ID of an item to highlight / expand in the navigator
  - OptionallabelSet?: string
    The name of a label set defined in the basicweb-config.xml (only supported for the welcome page)
  - Optionallayout?: Layout
    The layout to be used; the dashboard layout is used by default or the linear layout if there is not enough space.
  - OptionaloperationMode?: OperationMode
    The mode in which a workbook should be operated
  - Optionalsignal?: AbortSignal
    A signal to abort the iframe loading
  - OptionalworksheetPlaceholders?: WorksheetPlaceholders
    Maps the worksheet placeholder IDs in report embeddings to the print names of the worksheets to replace them with.
- ...args: any = {}
Returns Promise<void>
A Promise for when the iframe is loaded
Throws
For invalid arguments
Fires
- CadenzaDrillThroughEvent
- CadenzaActionEvent
- Defined in src/cadenza.js:415

showMap

showMap(
    mapView: EmbeddingTargetId,
    __namedParameters?: {
        additionalLayers?: LayerDefinition[];
        disabledUiFeatures?: UiFeature[];
        expandNavigator?: boolean;
        extentStrategy?: ExtentStrategy;
        filter?: FilterVariables;
        geometry?: Geometry;
        hideMainHeaderAndFooter?: boolean;
        hideWorkbookToolBar?: boolean;
        highlightGlobalId?: GlobalId;
        operationMode?: OperationMode;
        signal?: AbortSignal;
        useMapSrs?: boolean;
    },
    ...args?: any,
): Promise<void>
Embed
Show a workbook map view in an iframe.
Parameters
- mapView: EmbeddingTargetId
  The workbook map view to show
- Optional__namedParameters: {
      additionalLayers?: LayerDefinition[];
      disabledUiFeatures?: UiFeature[];
      expandNavigator?: boolean;
      extentStrategy?: ExtentStrategy;
      filter?: FilterVariables;
      geometry?: Geometry;
      hideMainHeaderAndFooter?: boolean;
      hideWorkbookToolBar?: boolean;
      highlightGlobalId?: GlobalId;
      operationMode?: OperationMode;
      signal?: AbortSignal;
      useMapSrs?: boolean;
  }
  Options
  - OptionaladditionalLayers?: LayerDefinition[]
    Layer definitions to be imported and shown in the background, as a basis for the drawing. IMPORTANT: The Cadenza referenced with cadenzaClient must be configured to support the import of GeoJSON, and the (system) privileges of the corresponding user must also be set in such a way that the import of GeoJSON is possible.
  - OptionaldisabledUiFeatures?: UiFeature[]
    Cadenza UI features to disable
  - OptionalexpandNavigator?: boolean
    Indicates if the navigator should be expanded.
  - OptionalextentStrategy?: ExtentStrategy
    Defines the initial map extent; If not given, Cadenza's default logic is used.
  - Optionalfilter?: FilterVariables
    Filter variables
  - Optionalgeometry?: Geometry
    A geometry to show on the map
  - OptionalhideMainHeaderAndFooter?: boolean
    Whether to hide the main Cadenza header and footer
  - OptionalhideWorkbookToolBar?: boolean
    Whether to hide the workbook toolbar
  - OptionalhighlightGlobalId?: GlobalId
    The ID of an item to highlight / expand in the navigator
  - OptionaloperationMode?: OperationMode
    The mode in which a workbook should be operated
  - Optionalsignal?: AbortSignal
    A signal to abort the iframe loading
  - OptionaluseMapSrs?: boolean
    Whether the coordinates specified in other parameters are specified in the map's SRS (otherwise EPSG:4326 is assumed)
- ...args: any = {}
Returns Promise<void>
A Promise for when the iframe is loaded
Throws
For invalid arguments
Fires
- CadenzaDrillThroughEvent
- CadenzaActionEvent
- Defined in src/cadenza.js:507

Class CadenzaClient

Index

Accessors

Methods

Accessors

baseUrl

Returns undefined | string

iframe

Returns undefined | HTMLIFrameElement

Methods

batchCreateGeometry

Parameters

Returns Promise<void>

Throws

Fires

batchEditGeometry

Parameters

Returns Promise<void>

Throws

Fires

closeMe

Returns void

createGeometry

Parameters

Returns Promise<void>

Throws

Fires

destroy

Returns void

See

downloadData

Parameters

OptionalfileName?: string

Optionalfilter?: FilterVariables

Optionalparts?: TablePart[]

Returns void

Throws

editGeometry

Parameters

Returns Promise<void>

Throws

Fires

expandNavigator

Parameters

Returns void

fetchAreaIntersections

Parameters

Optionalbuffer?: Distance

OptionalincludeGeometryValidationReport?: boolean

Optionalsignal?: AbortSignal

OptionaluseAutoCorrection?: boolean

OptionaluseMapSrs?: boolean

Returns Promise<AreaIntersectionsResult | ProblemDetails>

fetchData

Parameters

Optionalfilter?: FilterVariables

Optionalparts?: TablePart[]

Optionalsignal?: AbortSignal

Returns Promise<Response>

Throws

fetchObjectInfo

Parameters

Optionalfilter?: FilterVariables

OptionalfullGeometries?: boolean

Optionalsignal?: AbortSignal

OptionaluseMapSrs?: boolean

Returns Promise<FeatureCollection>

Throws

getData

Type Parameters

Parameters

Optionalheight?: number

Optionalwidth?: number

OptionalwithScale?: boolean

Returns Promise<T extends "png" ? Blob : never>

on

Type Parameters

Parameters

Returns () => void

reload

`Optional`fileName?: string

`Optional`filter?: FilterVariables

`Optional`parts?: TablePart[]

`Optional`buffer?: Distance

`Optional`includeGeometryValidationReport?: boolean

`Optional`signal?: AbortSignal

`Optional`useAutoCorrection?: boolean

`Optional`useMapSrs?: boolean

`Optional`filter?: FilterVariables

`Optional`parts?: TablePart[]

`Optional`signal?: AbortSignal

`Optional`filter?: FilterVariables

`Optional`fullGeometries?: boolean

`Optional`signal?: AbortSignal

`Optional`useMapSrs?: boolean

`Optional`height?: number

`Optional`width?: number

`Optional`withScale?: boolean

`Optional`invalidateCaches?: boolean

`Optional`disabledUiFeatures?: UiFeature[]

`Optional`extentStrategy?: ExtentStrategy

`Optional`filter?: FilterVariables

`Optional`layers?: (string | WorkbookLayerPath)[]

`Optional`operationMode?: OperationMode

`Optional`signal?: AbortSignal

`Optional`useMapSrs?: boolean

`Optional`dataType?: DataType

`Optional`disabledUiFeatures?: UiFeature[]

`Optional`expandNavigator?: boolean

`Optional`filter?: FilterVariables

`Optional`hideMainHeaderAndFooter?: boolean

`Optional`hideWorkbookToolBar?: boolean

`Optional`highlightGlobalId?: GlobalId

`Optional`labelSet?: string

`Optional`layout?: Layout

`Optional`operationMode?: OperationMode

`Optional`signal?: AbortSignal

`Optional`worksheetPlaceholders?: WorksheetPlaceholders

`Optional`additionalLayers?: LayerDefinition[]

`Optional`disabledUiFeatures?: UiFeature[]

`Optional`expandNavigator?: boolean

`Optional`extentStrategy?: ExtentStrategy

`Optional`filter?: FilterVariables

`Optional`geometry?: Geometry

`Optional`hideMainHeaderAndFooter?: boolean

`Optional`hideWorkbookToolBar?: boolean

`Optional`highlightGlobalId?: GlobalId

`Optional`operationMode?: OperationMode

`Optional`signal?: AbortSignal

`Optional`useMapSrs?: boolean