Class: Designer

ReportDesigner.Designer

Report designer component.

Table of contents

Constructors

• constructor

Accessors

• documentChanged

Methods

• createReport
• focus
• getEditorAPI
• getNotificationsAPI
• getPanelsAPI
• getReport
• getReportPartsLibraries
• processCommand
• setActionHandlers
• setDataSourceTemplates
• setReport
• setReportPartsLibraries
• setResourceProvider

Constructors

constructor

• new Designer(element, config?)

Creates report designer component instance.

Parameters

Name	Type	Description
element	string | object | Element	Component host element.
config?	DesignerConfig	Designer settings.

Accessors

documentChanged

• get documentChanged(): Event<DocumentChangedEventArgs>

Returns

Event<DocumentChangedEventArgs>

Methods

createReport

▸ createReport(reportInfo, whenDirty?): Promise<void>

Creates report.

Parameters

Name	Type	Description
reportInfo	NewReportInfo	Report info to load.
whenDirty?	WhenDirty	Action to perform in case of 'dirty' report.

Returns

Promise<void>

---

focus

▸ focus(): void

Returns focus to Designer.

Returns

void

---

getEditorAPI

▸ getEditorAPI(): Promise<EditorAPI>

Gets API to manipulate designer.

Returns

Promise<EditorAPI>

---

getNotificationsAPI

▸ getNotificationsAPI(): Promise<NotificationsAPI>

Manipulate notifications panel.

Returns

Promise<NotificationsAPI>

---

getPanelsAPI

▸ getPanelsAPI(): Promise<PanelsAPI>

Access to the menu and sidebar panels

Returns

Promise<PanelsAPI>

---

getReport

▸ getReport(): Promise<ReportInfo>

Gets current report.

Returns

Promise<ReportInfo>

---

getReportPartsLibraries

▸ getReportPartsLibraries(): Promise<ReportPartsLibrary[]>

Gets list of available ReportParts libraries.

Returns

Promise<ReportPartsLibrary[]>

---

processCommand

▸ processCommand(cmd): Promise<void>

Process command.

Parameters

Name	Type	Description
cmd	DesignerCommand	Command name.

Returns

Promise<void>

---

setActionHandlers

▸ setActionHandlers(actionHandlers): Promise<void>

Sets actions handlers.

Parameters

Name	Type
actionHandlers	ActionHandlers

Returns

Promise<void>

---

setDataSourceTemplates

▸ setDataSourceTemplates(templates): Promise<void>

Sets DataSource templates

Parameters

Name	Type	Description
templates	DataSourceTemplate[]	List of DataSource templates

Returns

Promise<void>

---

setReport

▸ setReport(report, whenDirty?, isDirtyInitial?): Promise<void>

Sets report.

Parameters

Name	Type	Description
report	Report	Report info to load.
whenDirty?	WhenDirty	Action to perform in case of 'dirty' report.
isDirtyInitial?	boolean	Initial value for 'dirty' state after load.

Returns

Promise<void>

---

setReportPartsLibraries

▸ setReportPartsLibraries(libraries): Promise<void>

Sets list of available ReportParts libraries.

Parameters

Name	Type
libraries	ReportPartsLibrary[]

Returns

Promise<void>

---

setResourceProvider

▸ setResourceProvider(resourceProvider): Promise<void>

Sets resource provider.

Parameters

Name	Type	Description
resourceProvider	Partial<ResourceProvider>	Resources provider.

Returns

Promise<void>