[{"id":"0916473b-83fc-4a60-8609-02f91e8b1c34","tags":[]},{"id":"7132754a-4c4c-4ff9-a430-06e21c266171","tags":[]},{"id":"f07e4430-8605-4a45-8f8d-0853dbbf0b67","tags":[]},{"id":"66d528a4-f9c5-4684-9488-0a2a0169bf50","tags":[]},{"id":"52374753-a491-4926-80e3-1114a5aadc44","tags":[]},{"id":"787341a3-d970-4540-84ac-19ee64f0dbe2","tags":[]},{"id":"d44deed9-eae7-4df6-9fe8-1a114f316cdc","tags":[]},{"id":"db162604-9c16-4513-bd1b-1fff9790fcb2","tags":[]},{"id":"aa4305c5-df80-44b2-8a02-278524f919c1","tags":[]},{"id":"e16a581c-44c0-45af-99d3-3d54fc371d1d","tags":[]},{"id":"7c8ea105-1d11-46ff-9a56-3eb70dfd5958","tags":[]},{"id":"1dc18e5f-ddec-48d3-a6dc-4906881cf537","tags":[]},{"id":"3dbcc70b-09a5-4814-983e-4fcaf3a84ece","tags":[]},{"id":"e393d03d-1603-455b-9f38-52ea7b3934a6","tags":[]},{"id":"ddb7b27e-e503-474b-a5c4-5fd4b9f92f58","tags":[]},{"id":"f6ef6590-5d1e-483d-99da-6f7615b96065","tags":[]},{"id":"9d7dceaa-bfdb-4865-bd6e-7c8dfcec2d61","tags":[]},{"id":"16796d76-24d8-4ace-b4ad-84838fc00ae0","tags":[]},{"id":"c01d715e-e359-4a3d-9f68-8ff89deaaa97","tags":[]},{"id":"a47419f2-f009-4931-9b67-99399c32dfef","tags":[]},{"id":"131eb4bf-5169-4136-92b3-9b62db0052dd","tags":[]},{"id":"afed2c6f-a981-4b65-8198-9d554775cc58","tags":[]},{"id":"1a97d9a4-f978-413e-9f4d-a90139ac8e4f","tags":[]},{"id":"a98b4526-e99f-4060-895b-aa61baf20f13","tags":[]},{"id":"2f38c0ec-cd81-428f-81a5-abbd06a66196","tags":[]},{"id":"93b7867e-ec84-4f9e-b8bb-acbee73dc50c","tags":[]},{"id":"c8ea308b-fa39-4c39-9f43-b934f3cb8747","tags":[]},{"id":"ed51f39d-4ede-48d5-8632-bec35012c0fe","tags":[]},{"id":"d2fbaa32-1e7f-4281-aefd-c263009fa347","tags":[]},{"id":"a592e7dd-928d-4842-a48e-c30463d382bd","tags":[]},{"id":"142944fe-13da-4bc1-bf72-da37bd7f5cbd","tags":[]},{"id":"ee3085a1-3b3b-4569-89f8-dbc5404ede96","tags":[]},{"id":"7ede5633-cdbc-4ba2-a7ca-dfe5881dcaf3","tags":[]},{"id":"042d12e3-6361-430d-aa43-ee0366b5df1f","tags":[]},{"id":"8fb0ecc0-92a7-4865-b5ea-fac9f79ec715","tags":[]}]
        
(Showing Draft Content)

ReportDesigner

Namespace: ReportDesigner

Table of contents

Classes

Interfaces

Type aliases

Type aliases

CustomInitTemplates

Ƭ CustomInitTemplates: Object

Type declaration

Name Type
imperialTemplates? Report[]
metricTemplates? Report[]

DataSetTemplate

Ƭ DataSetTemplate: Object

Defines a dataset template for data panel.

Type declaration

Name Type Description
canEdit? boolean Instructs if DataSet, created from template, can be edited
id string Template ID
nestedTemplates? DataSet[] RDLX definitions for nested DataSets
shouldEdit? boolean Instructs designer to show edit dialog
template DataSet RDLX definition of DataSet
title string Title

DataSourceTemplate

Ƭ DataSourceTemplate: Object

Defines the datasource template for data panel.

Type declaration

Name Type Description
canEdit? boolean Instructs if DataSet, created from template, can be edited
datasets? DataSetTemplate[] DataSet templates for DataSource based on template
id string Template ID
shouldEdit? boolean Instructs designer to show edit dialog
template DataSource RDLX definition of DataSource
title string Title

DesignerCommand

Ƭ DesignerCommand: "save" | "saveAs" | "create" | "open" | "render"

Command name.


DesignerConfig

Ƭ DesignerConfig: Object

Designer configuration

Type declaration

Name Type Description
customInitTemplates? CustomInitTemplates Templates with default values for report and report items.
disableOpenSaveHotkeys? boolean If set to 'true' disables default open and save report hotkeys,
language? string Application language, for example 'en', 'ja or 'zh'. Default value is 'en'.

FontSet

Ƭ FontSet: "default" | "registered" | "all"

Fonts set.

default: predefined fonts
registered: fonts registered in FontStore
all: predefined an registered in FontStore fonts

ImageResourceInfo

Ƭ ImageResourceInfo: Object

Represents image information.

Type declaration

Name Type Description
displayName? string Resource display name.
id string Resource ID.
mimeType string Mime type.
thumbnail? string Thumbnail.

NewReport

Ƭ NewReport: Object

Report info representing new report to be created.

Type declaration

Name Type Description
displayName? string Report display name.
id? string Report id.
reportType "CPL" | "FPL" Type of report.

NewReportInfo

Ƭ NewReportInfo: Object

New report info.

Type declaration

Name Type Description
reportType "CPL" | "FPL" Type of report.

Report

Ƭ Report: ReportLink | ReportDefinition

Report info.


ReportDefinition

Ƭ ReportDefinition: Object

Report info representing report by definition.

Type declaration

Name Type Description
definition Report RDLX report definition.
displayName? string Report display name.
id? string Report id.

ReportInfo

Ƭ ReportInfo: Object

Represents current report information.

Type declaration

Name Type Description
definition Report RDLX report definition.
displayName string Report display name.
id string | null Report id.
isDirty boolean True if report is in dirty (not saved) state.

Ƭ ReportLink: Object

Report info representing report by ID.

Type declaration

Name Type Description
displayName? string Report display name.
id string Report ID

ReportResourceInfo

Ƭ ReportResourceInfo: Object

Represents external resource information.

Type declaration

Name Type Description
displayName? string Resource display name.
id string Resource ID.

SaveAsResult

Ƭ SaveAsResult: Object

Represents result of "save new report" operation.

Type declaration

Name Type Description
displayName? string Report display name.
id string New report ID.

SaveNewReportInfo

Ƭ SaveNewReportInfo: Object

Current report info to be saved as new one.

Type declaration

Name Type Description
definition Report Current RDLX report definittion.
displayName? string Current report display name.
id? string Current report ID.

SaveReportInfo

Ƭ SaveReportInfo: Object

Current report info to be saved.

Type declaration

Name Type Description
definition Report Current RDLX report definittion.
displayName? string Current report display name.
id string Current report ID.

SaveResult

Ƭ SaveResult: Object

Represents result of "save report" operation.

Type declaration

Name Type Description
displayName? string Report display name after save.

ThemeInfo

Ƭ ThemeInfo: Object

Report theme short representation.

Type declaration

Name Type Description
Accent1 string Accent1 theme color
Accent2 string Accent2 theme color
Accent3 string Accent3 theme color
Accent4 string Accent4 theme color
Accent5 string Accent5 theme color
Accent6 string Accent6 theme color
Dark1 string Dark1 theme color
Dark2 string Dark2 theme color
Light1 string Light1 theme color
Light2 string Light2 theme color
MajorFontFamily string Major text theme font family
MinorFontFamily string Minor text theme font family

ThemeResourceInfo

Ƭ ThemeResourceInfo: Object

Represents theme information.

Type declaration

Name Type Description
displayName? string Resource display name.
id string Resource ID.
info ThemeInfo Theme short representation.

WhenDirty

Ƭ WhenDirty: "ask" | "override" | "throw"

Represents action to perform in case of dirty report.

ask: show comfirmation dialog
override: override dirty report
throw: throw error