Class: Designer

ReportDesigner.Designer

Report designer component.

Table of contents

Constructors

• constructor

Accessors

• fontSet

Methods

• 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:252

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:255

• 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:257

Methods

getReport

▸ getReport(): Promise<ReportInfo>

Gets current report.

Returns

Promise<ReportInfo>

Defined in

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

---

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:280

---

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:270

---

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:285

---

setReport

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

Sets report.

Parameters

Name	Type	Description
report	Report	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:263

---

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:275