# ReportDesigner

## Content

# Namespace: ReportDesigner

## Table of contents

### Classes

- [Designer](../classes/ReportDesigner.Designer)

### Interfaces

- [ActionHandlers](../interfaces/ReportDesigner.ActionHandlers)
- [ResourceProvider](../interfaces/ReportDesigner.ResourceProvider)

### Type aliases

- [CustomInitTemplates](ReportDesigner#custominittemplates)
- [DataSetTemplate](ReportDesigner#datasettemplate)
- [DataSourceTemplate](ReportDesigner#datasourcetemplate)
- [DesignerCommand](ReportDesigner#designercommand)
- [DesignerConfig](ReportDesigner#designerconfig)
- [FontSet](ReportDesigner#fontset)
- [ImageResourceInfo](ReportDesigner#imageresourceinfo)
- [NewReport](ReportDesigner#newreport)
- [NewReportInfo](ReportDesigner#newreportinfo)
- [Report](ReportDesigner#report)
- [ReportDefinition](ReportDesigner#reportdefinition)
- [ReportInfo](ReportDesigner#reportinfo)
- [ReportLink](ReportDesigner#reportlink)
- [ReportResourceInfo](ReportDesigner#reportresourceinfo)
- [SaveAsResult](ReportDesigner#saveasresult)
- [SaveNewReportInfo](ReportDesigner#savenewreportinfo)
- [SaveReportInfo](ReportDesigner#savereportinfo)
- [SaveResult](ReportDesigner#saveresult)
- [ThemeInfo](ReportDesigner#themeinfo)
- [ThemeResourceInfo](ReportDesigner#themeresourceinfo)
- [WhenDirty](ReportDesigner#whendirty)

## Type aliases

### <a id="custominittemplates" name="custominittemplates"></a> CustomInitTemplates

Ƭ **CustomInitTemplates**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `imperialTemplates?` | [`Report`](ReportDesigner#report)[] |
| `metricTemplates?` | [`Report`](ReportDesigner#report)[] |

___

### <a id="datasettemplate" name="datasettemplate"></a> 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`](Core.Rdl#dataset)[] | RDLX definitions for nested DataSets |
| `shouldEdit?` | `boolean` | Instructs designer to show edit dialog |
| `template` | [`DataSet`](Core.Rdl#dataset) | RDLX definition of DataSet |
| `title` | `string` | Title |

___

### <a id="datasourcetemplate" name="datasourcetemplate"></a> 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`](ReportDesigner#datasettemplate)[] | DataSet templates for DataSource based on template |
| `id` | `string` | Template ID |
| `shouldEdit?` | `boolean` | Instructs designer to show edit dialog |
| `template` | [`DataSource`](Core.Rdl#datasource) | RDLX definition of DataSource |
| `title` | `string` | Title |

___

### <a id="designercommand" name="designercommand"></a> DesignerCommand

Ƭ **DesignerCommand**: ``"save"`` \| ``"saveAs"`` \| ``"create"`` \| ``"open"`` \| ``"render"``

Command name.

___

### <a id="designerconfig" name="designerconfig"></a> DesignerConfig

Ƭ **DesignerConfig**: `Object`

Designer configuration

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `customInitTemplates?` | [`CustomInitTemplates`](ReportDesigner#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'. |

___

### <a id="fontset" name="fontset"></a> FontSet

Ƭ **FontSet**: ``"default"`` \| ``"registered"`` \| ``"all"``

Fonts set.

```
default: predefined fonts
registered: fonts registered in FontStore
all: predefined an registered in FontStore fonts
```

___

### <a id="imageresourceinfo" name="imageresourceinfo"></a> 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. |

___

### <a id="newreport" name="newreport"></a> 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. |

___

### <a id="newreportinfo" name="newreportinfo"></a> NewReportInfo

Ƭ **NewReportInfo**: `Object`

New report info.

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `reportType` | ``"CPL"`` \| ``"FPL"`` | Type of report. |

___

### <a id="report" name="report"></a> Report

Ƭ **Report**: [`ReportLink`](ReportDesigner#reportlink) \| [`ReportDefinition`](ReportDesigner#reportdefinition)

Report info.

___

### <a id="reportdefinition" name="reportdefinition"></a> ReportDefinition

Ƭ **ReportDefinition**: `Object`

Report info representing report by definition.

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `definition` | [`Report`](Core.Rdl#report) | RDLX report definition. |
| `displayName?` | `string` | Report display name. |
| `id?` | `string` | Report id. |

___

### <a id="reportinfo" name="reportinfo"></a> ReportInfo

Ƭ **ReportInfo**: `Object`

Represents current report information.

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `definition` | [`Report`](Core.Rdl#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. |

___

### <a id="reportlink" name="reportlink"></a> ReportLink

Ƭ **ReportLink**: `Object`

Report info representing report by ID.

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `displayName?` | `string` | Report display name. |
| `id` | `string` | Report ID |

___

### <a id="reportresourceinfo" name="reportresourceinfo"></a> ReportResourceInfo

Ƭ **ReportResourceInfo**: `Object`

Represents external resource information.

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `displayName?` | `string` | Resource display name. |
| `id` | `string` | Resource ID. |

___

### <a id="saveasresult" name="saveasresult"></a> 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. |

___

### <a id="savenewreportinfo" name="savenewreportinfo"></a> SaveNewReportInfo

Ƭ **SaveNewReportInfo**: `Object`

Current report info to be saved as new one.

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `definition` | [`Report`](Core.Rdl#report) | Current RDLX report definittion. |
| `displayName?` | `string` | Current report display name. |
| `id?` | `string` | Current report ID. |

___

### <a id="savereportinfo" name="savereportinfo"></a> SaveReportInfo

Ƭ **SaveReportInfo**: `Object`

Current report info to be saved.

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `definition` | [`Report`](Core.Rdl#report) | Current RDLX report definittion. |
| `displayName?` | `string` | Current report display name. |
| `id` | `string` | Current report ID. |

___

### <a id="saveresult" name="saveresult"></a> SaveResult

Ƭ **SaveResult**: `Object`

Represents result of "save report" operation.

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `displayName?` | `string` | Report display name after save. |

___

### <a id="themeinfo" name="themeinfo"></a> 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 |

___

### <a id="themeresourceinfo" name="themeresourceinfo"></a> ThemeResourceInfo

Ƭ **ThemeResourceInfo**: `Object`

Represents theme information.

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `displayName?` | `string` | Resource display name. |
| `id` | `string` | Resource ID. |
| `info` | [`ThemeInfo`](ReportDesigner#themeinfo) | Theme short representation. |

___

### <a id="whendirty" name="whendirty"></a> 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
```