Namespace: ReportDesigner

Table of contents

Classes

• Designer

Interfaces

• ActionHandlers
• ResourceProvider

Type aliases

• CustomInitTemplates
• DataSetTemplate
• DataSourceTemplate
• DesignerCommand
• DesignerConfig
• FontSet
• ImageResourceInfo
• NewReport
• NewReportInfo
• Report
• ReportDefinition
• ReportInfo
• ReportLink
• ReportResourceInfo
• SaveAsResult
• SaveNewReportInfo
• SaveReportInfo
• SaveResult
• ThemeInfo
• ThemeResourceInfo
• WhenDirty

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

Ƭ 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