# ReportDesigner.Designer

## Content

# Class: Designer

[ReportDesigner](../modules/ReportDesigner).Designer

Report designer component.

## Table of contents

### Constructors

- [constructor](ReportDesigner.Designer#constructor)

### Accessors

- [documentChanged](ReportDesigner.Designer#documentchanged)

### Methods

- [createReport](ReportDesigner.Designer#createreport)
- [destroy](ReportDesigner.Designer#destroy)
- [focus](ReportDesigner.Designer#focus)
- [getEditorAPI](ReportDesigner.Designer#geteditorapi)
- [getNotificationsAPI](ReportDesigner.Designer#getnotificationsapi)
- [getPanelsAPI](ReportDesigner.Designer#getpanelsapi)
- [getReport](ReportDesigner.Designer#getreport)
- [getReportPartsLibraries](ReportDesigner.Designer#getreportpartslibraries)
- [processCommand](ReportDesigner.Designer#processcommand)
- [setActionHandlers](ReportDesigner.Designer#setactionhandlers)
- [setDataSourceTemplates](ReportDesigner.Designer#setdatasourcetemplates)
- [setMasterReport](ReportDesigner.Designer#setmasterreport)
- [setReport](ReportDesigner.Designer#setreport)
- [setReportPartsLibraries](ReportDesigner.Designer#setreportpartslibraries)
- [setResourceProvider](ReportDesigner.Designer#setresourceprovider)

## Constructors

### <a id="constructor" name="constructor"></a> constructor

• **new Designer**(`element`, `config?`)

Creates report designer component instance.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `element` | `string` \| `object` \| `Element` | Component host element. |
| `config?` | [`DesignerConfig`](../modules/ReportDesigner#designerconfig) | Designer settings. |

## Accessors

### <a id="documentchanged" name="documentchanged"></a> documentChanged

• `get` **documentChanged**(): [`Event`](../interfaces/Core.Event)<[`DocumentChangedEventArgs`](../modules/ReportDesigner#documentchangedeventargs)\>

#### Returns

[`Event`](../interfaces/Core.Event)<[`DocumentChangedEventArgs`](../modules/ReportDesigner#documentchangedeventargs)\>

## Methods

### <a id="createreport" name="createreport"></a> createReport

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

Creates report.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `reportInfo` | [`NewReportInfo`](../modules/ReportDesigner#newreportinfo) | Report info to load. |
| `whenDirty?` | [`WhenDirty`](../modules/ReportDesigner#whendirty) | Action to perform in case of 'dirty' report. |

#### Returns

`Promise`<`void`\>

___

### <a id="destroy" name="destroy"></a> destroy

▸ **destroy**(): `Promise`<`void`\>

Destroys report designer component instance.

#### Returns

`Promise`<`void`\>

___

### <a id="focus" name="focus"></a> focus

▸ **focus**(): `void`

Returns focus to Designer.

#### Returns

`void`

___

### <a id="geteditorapi" name="geteditorapi"></a> getEditorAPI

▸ **getEditorAPI**(): `Promise`<[`EditorAPI`](../modules/ReportDesigner#editorapi)\>

Gets API to manipulate designer.

#### Returns

`Promise`<[`EditorAPI`](../modules/ReportDesigner#editorapi)\>

___

### <a id="getnotificationsapi" name="getnotificationsapi"></a> getNotificationsAPI

▸ **getNotificationsAPI**(): `Promise`<[`NotificationsAPI`](../modules/ReportDesigner#notificationsapi)\>

Manipulate notifications panel.

#### Returns

`Promise`<[`NotificationsAPI`](../modules/ReportDesigner#notificationsapi)\>

___

### <a id="getpanelsapi" name="getpanelsapi"></a> getPanelsAPI

▸ **getPanelsAPI**(): `Promise`<[`PanelsAPI`](../modules/ReportDesigner#panelsapi)\>

Access to the menu and sidebar panels

#### Returns

`Promise`<[`PanelsAPI`](../modules/ReportDesigner#panelsapi)\>

___

### <a id="getreport" name="getreport"></a> getReport

▸ **getReport**(): `Promise`<[`ReportInfo`](../modules/ReportDesigner#reportinfo)\>

Gets current report.

#### Returns

`Promise`<[`ReportInfo`](../modules/ReportDesigner#reportinfo)\>

___

### <a id="getreportpartslibraries" name="getreportpartslibraries"></a> getReportPartsLibraries

▸ **getReportPartsLibraries**(): `Promise`<`ReportPartsLibrary`[]\>

Gets list of available ReportParts libraries.

#### Returns

`Promise`<`ReportPartsLibrary`[]\>

___

### <a id="processcommand" name="processcommand"></a> processCommand

▸ **processCommand**(`cmd`): `Promise`<`void`\>

Process command.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `cmd` | [`DesignerCommand`](../modules/ReportDesigner#designercommand) | Command name. |

#### Returns

`Promise`<`void`\>

___

### <a id="setactionhandlers" name="setactionhandlers"></a> setActionHandlers

▸ **setActionHandlers**(`actionHandlers`): `Promise`<`void`\>

Sets actions handlers.

#### Parameters

| Name | Type |
| :------ | :------ |
| `actionHandlers` | [`ActionHandlers`](../interfaces/ReportDesigner.ActionHandlers) |

#### Returns

`Promise`<`void`\>

___

### <a id="setdatasourcetemplates" name="setdatasourcetemplates"></a> setDataSourceTemplates

▸ **setDataSourceTemplates**(`templates`): `Promise`<`void`\>

Sets DataSource templates

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `templates` | [`DataSourceTemplate`](../modules/ReportDesigner#datasourcetemplate)[] | List of DataSource templates |

#### Returns

`Promise`<`void`\>

___

### <a id="setmasterreport" name="setmasterreport"></a> setMasterReport

▸ **setMasterReport**(`masterReportId`): `Promise`<`void`\>

Sets Master Report.

#### Parameters

| Name | Type |
| :------ | :------ |
| `masterReportId` | `string` |

#### Returns

`Promise`<`void`\>

___

### <a id="setreport" name="setreport"></a> setReport

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

Sets report.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `report` | [`Report`](../modules/ReportDesigner#report) | Report info to load. |
| `whenDirty?` | [`WhenDirty`](../modules/ReportDesigner#whendirty) | Action to perform in case of 'dirty' report. |
| `isDirtyInitial?` | `boolean` | Initial value for 'dirty' state after load. |

#### Returns

`Promise`<`void`\>

___

### <a id="setreportpartslibraries" name="setreportpartslibraries"></a> setReportPartsLibraries

▸ **setReportPartsLibraries**(`libraries`): `Promise`<`void`\>

Sets list of available ReportParts libraries.

#### Parameters

| Name | Type |
| :------ | :------ |
| `libraries` | `ReportPartsLibrary`[] |

#### Returns

`Promise`<`void`\>

___

### <a id="setresourceprovider" name="setresourceprovider"></a> setResourceProvider

▸ **setResourceProvider**(`resourceProvider`): `Promise`<`void`\>

Sets resource provider.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `resourceProvider` | `Partial`<[`ResourceProvider`](../interfaces/ReportDesigner.ResourceProvider)\> | Resources provider. |

#### Returns

`Promise`<`void`\>