Class: Designer

ReportDesigner.Designer

Report designer component.

Table of contents

Constructors

• constructor

Accessors

• fontSet

Methods

• createReport
• getReport
• processCommand
• setActionHandlers
• setDataSourceTemplates
• setReport
• 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.

Defined in

node_modules/@grapecity/activereports-designer/types/ar-js-designer.d.ts:266

Accessors

fontSet

• get fontSet(): FontSet

Gets available set of fonts.

Returns

FontSet

Defined in

node_modules/@grapecity/activereports-designer/types/ar-js-designer.d.ts:269

• set fontSet(value): void

Sets available set of fonts.

Parameters

Name	Type
value	FontSet

Returns

void

Defined in

node_modules/@grapecity/activereports-designer/types/ar-js-designer.d.ts:271

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>

Defined in

node_modules/@grapecity/activereports-designer/types/ar-js-designer.d.ts:277

---

getReport

▸ getReport(): Promise<ReportInfo>

Gets current report.

Returns

Promise<ReportInfo>

Defined in

node_modules/@grapecity/activereports-designer/types/ar-js-designer.d.ts:286

---

processCommand

▸ processCommand(cmd): Promise<void>

Process command.

Parameters

Name	Type	Description
cmd	DesignerCommand	Command name.

Returns

Promise<void>

Defined in

node_modules/@grapecity/activereports-designer/types/ar-js-designer.d.ts:301

---

setActionHandlers

▸ setActionHandlers(actions): Promise<void>

Sets actions handlers.

Parameters

Name	Type	Description
actions	ActionHandlers	Actions handlers.

Returns

Promise<void>

Defined in

node_modules/@grapecity/activereports-designer/types/ar-js-designer.d.ts:291

---

setDataSourceTemplates

▸ setDataSourceTemplates(templates): Promise<void>

Sets DataSource templates

Parameters

Name	Type	Description
templates	DataSourceTemplate[]	List of DataSource templates

Returns

Promise<void>

Defined in

node_modules/@grapecity/activereports-designer/types/ar-js-designer.d.ts:306

---

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>

Defined in

node_modules/@grapecity/activereports-designer/types/ar-js-designer.d.ts:284

---

setResourceProvider

▸ setResourceProvider(resourceProvider): Promise<void>

Sets resource provider.

Parameters

Name	Type	Description
resourceProvider	Partial<ResourceProvider>	Resources provider.

Returns

Promise<void>

Defined in

node_modules/@grapecity/activereports-designer/types/ar-js-designer.d.ts:296