# ReportViewer

## Content

# Namespace: ReportViewer

## Table of contents

### Enumerations

- [MouseMode](../enums/ReportViewer.MouseMode)
- [SearchStatus](../enums/ReportViewer.SearchStatus)
- [ViewMode](../enums/ReportViewer.ViewMode)
- [ViewerStatus](../enums/ReportViewer.ViewerStatus)
- [ZoomMode](../enums/ReportViewer.ZoomMode)

### Classes

- [CancellationToken](../classes/ReportViewer.CancellationToken)
- [Range](../classes/ReportViewer.Range)
- [Rect](../classes/ReportViewer.Rect)
- [SearchResult](../classes/ReportViewer.SearchResult)
- [Viewer](../classes/ReportViewer.Viewer)

### Interfaces

- [ExportResult](../interfaces/ReportViewer.ExportResult)
- [FontDescriptor](../interfaces/ReportViewer.FontDescriptor)
- [HistoryApi](../interfaces/ReportViewer.HistoryApi)
- [ReportSettings](../interfaces/ReportViewer.ReportSettings)
- [Toolbar](../interfaces/ReportViewer.Toolbar)
- [ViewerOptions](../interfaces/ReportViewer.ViewerOptions)

### Type aliases

- [BuiltInUITheme](ReportViewer#builtinuitheme)
- [DocumentLoadEventArgs](ReportViewer#documentloadeventargs)
- [ExportSettings](ReportViewer#exportsettings)
- [LoadResult](ReportViewer#loadresult)
- [PanelsLocation](ReportViewer#panelslocation)
- [ParameterPanelLocation](ReportViewer#parameterpanellocation)
- [ReportLoadEventArgs](ReportViewer#reportloadeventargs)
- [SearchOptions](ReportViewer#searchoptions)
- [ShowParametersOnOpen](ReportViewer#showparametersonopen)
- [ToolbarLayout](ReportViewer#toolbarlayout)
- [UITheme](ReportViewer#uitheme)
- [UIThemeConfig](ReportViewer#uithemeconfig)
- [UIThemeSelectorConfig](ReportViewer#uithemeselectorconfig)
- [ViewerMouseMode](ReportViewer#viewermousemode)
- [ViewerRenderMode](ReportViewer#viewerrendermode)
- [ViewerViewMode](ReportViewer#viewerviewmode)
- [ViewerZoomMode](ReportViewer#viewerzoommode)

## Type aliases

### <a id="builtinuitheme" name="builtinuitheme"></a> BuiltInUITheme

Ƭ **BuiltInUITheme**: ``"System"`` \| ``"Default"`` \| ``"DefaultDark"`` \| ``"DarkOled"`` \| ``"HighContrast"`` \| ``"HighContrastDark"`` \| ``"ActiveReports"`` \| ``"ActiveReportsDark"``

Represents the names of built-in UI themes.

**`remarks`**
Accepted values:
- `'System'`
- `'Default'`
- `'DefaultDark'`
- `'DarkOled'`
- `'HighContrast'`
- `'HighContrastDark'`
- `'ActiveReports'`
- `'ActiveReportsDark'`

**`example`**
```ts
const theme: BuiltInUITheme = 'Default';
```

___

### <a id="documentloadeventargs" name="documentloadeventargs"></a> DocumentLoadEventArgs

Ƭ **DocumentLoadEventArgs**: `Object`

Represents the event arguments for the documentLoaded event.

**`example`**
```ts
const args: DocumentLoadEventArgs = {
	pageCount: 12,
	cancelled: false,
};
```

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `cancelled?` | `boolean` | Gets a value indicating whether rendering was canceled. |
| `pageCount` | `number` | Gets the number of pages in the loaded document. |

___

### <a id="exportsettings" name="exportsettings"></a> ExportSettings

Ƭ **ExportSettings**: `Record`<`string`, `string` \| `boolean` \| `number` \| ``null``\>

Represents the export settings map for a specific format.

**`example`**
```ts
const settings: ExportSettings = {
	PrintOnOpen: false,
	UseEmbeddedFonts: true,
};
```

___

### <a id="loadresult" name="loadresult"></a> LoadResult

Ƭ **LoadResult**: { `document`: `IDocument` ; `status`: ``"loaded"``  } \| { `details?`: `string` ; `message`: `string` ; `status`: ``"error"``  } \| { `status`: ``"cancelled"``  }

Represents the result of a document load operation.

**`remarks`**
Possible statuses:
- `'loaded'`: The document was loaded successfully.
- `'error'`: The document failed to load.
- `'cancelled'`: The operation was canceled.

**`example`**
```ts
const result: LoadResult = { status: 'loaded', document: {} as PluginModel.IDocument };
```

___

### <a id="panelslocation" name="panelslocation"></a> PanelsLocation

Ƭ **PanelsLocation**: ``"sidebar"`` \| ``"toolbar"``

Represents the location of viewer panels.

**`remarks`**
Accepted values:
- `'sidebar'`
- `'toolbar'`

**`example`**
```ts
const location: PanelsLocation = 'sidebar';
```

___

### <a id="parameterpanellocation" name="parameterpanellocation"></a> ParameterPanelLocation

Ƭ **ParameterPanelLocation**: ``"auto"`` \| ``"default"`` \| ``"top"`` \| ``"bottom"``

Represents the location of the parameters panel.

**`remarks`**
Accepted values:
- `'auto'`
- `'default'`
- `'top'`
- `'bottom'`

**`example`**
```ts
const location: ParameterPanelLocation = 'auto';
```

___

### <a id="reportloadeventargs" name="reportloadeventargs"></a> ReportLoadEventArgs

Ƭ **ReportLoadEventArgs**: `Object`

Represents the event arguments for the reportLoaded event.

**`example`**
```ts
const args: ReportLoadEventArgs = {
	report: {} as PageReport,
};
```

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `report` | [`PageReport`](../classes/Core.PageReport) | Gets the loaded report. |

___

### <a id="searchoptions" name="searchoptions"></a> SearchOptions

Ƭ **SearchOptions**: `Object`

Represents the options for the ReportViewer.search method.

**`example`**
```ts
const options: SearchOptions = {
	text: 'Total',
	matchCase: false,
	wholeWord: true,
};
```

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `matchCase?` | `boolean` | Gets or sets a value indicating whether the search is case-sensitive. |
| `searchBackward?` | `boolean` | Gets or sets a value indicating whether to search backward. |
| `startPage?` | `number` | Gets or sets the page index to start the search from. |
| `text` | `string` | Gets or sets the text to search for. |
| `wholeWord?` | `boolean` | Gets or sets a value indicating whether to match whole words only. |

___

### <a id="showparametersonopen" name="showparametersonopen"></a> ShowParametersOnOpen

Ƭ **ShowParametersOnOpen**: ``"always"`` \| ``"auto"``

Represents when the parameters panel is shown.

**`remarks`**
Accepted values:
- `'always'`: Always show parameters on open.
- `'auto'`: Show only when parameters are required.

**`example`**
```ts
const show: ShowParametersOnOpen = 'auto';
```

___

### <a id="toolbarlayout" name="toolbarlayout"></a> ToolbarLayout

Ƭ **ToolbarLayout**: `Object`

Represents the toolbar layout (order and visibility) for different view modes.

**`example`**
```ts
const layout: ToolbarLayout = {
	default: ['print', 'search'],
	fullscreen: ['print'],
};
```

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `default?` | `string`[] | Gets or sets the default (desktop) layout.  **`remarks`** Applied when other modes are not specified. |
| `fullscreen?` | `string`[] | Gets or sets the full-screen layout. |
| `mobile?` | `string`[] | Gets or sets the mobile layout. |

___

### <a id="uitheme" name="uitheme"></a> UITheme

Ƭ **UITheme**: [`BuiltInUITheme`](ReportViewer#builtinuitheme) \| `ColorTheme`

Represents a UI theme definition.

**`remarks`**
Use a built-in theme name or provide a custom [ColorTheme](ReportDesigner#colortheme).

**`example`**
```ts
const theme: UITheme = 'System';
```

___

### <a id="uithemeconfig" name="uithemeconfig"></a> UIThemeConfig

Ƭ **UIThemeConfig**: `Object`

Represents UI theme configuration settings.

**`example`**
```ts
const config: UIThemeConfig = {
	initialTheme: 'Default',
	themeSelector: { isEnabled: true },
};
```

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `initialTheme?` | `string` | Gets or sets the initial theme name.  **`default`** "Default" |
| `themeSelector?` | [`UIThemeSelectorConfig`](ReportViewer#uithemeselectorconfig) | Gets or sets the theme selector configuration. |

___

### <a id="uithemeselectorconfig" name="uithemeselectorconfig"></a> UIThemeSelectorConfig

Ƭ **UIThemeSelectorConfig**: `Object`

Represents theme selector configuration.

**`example`**
```ts
const selector: UIThemeSelectorConfig = {
	availableThemes: ['Default'],
	isEnabled: true,
};
```

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `availableThemes?` | [`UITheme`](ReportViewer#uitheme)[] | Gets or sets the list of available themes.  **`remarks`** These themes are built-in themes.   **`default`** ["System", "Default", "DefaultDark", "DarkOled", "HighContrast", "HighContrastDark", "ActiveReports", "ActiveReportsDark"] |
| `isEnabled?` | `boolean` | Gets or sets whether the theme selector is enabled. |

___

### <a id="viewermousemode" name="viewermousemode"></a> ViewerMouseMode

Ƭ **ViewerMouseMode**: ``"Pan"`` \| ``"Selection"``

Represents the mouse interaction mode.

**`remarks`**
Accepted values:
- `'Pan'`
- `'Selection'`

**`example`**
```ts
const mode: ViewerMouseMode = 'Pan';
```

___

### <a id="viewerrendermode" name="viewerrendermode"></a> ViewerRenderMode

Ƭ **ViewerRenderMode**: ``"Galley"`` \| ``"Paginated"``

Represents the rendering mode of the viewer.

**`remarks`**
Accepted values:
- `'Galley'`
- `'Paginated'`

**`example`**
```ts
const mode: ViewerRenderMode = 'Galley';
```

___

### <a id="viewerviewmode" name="viewerviewmode"></a> ViewerViewMode

Ƭ **ViewerViewMode**: ``"Continuous"`` \| ``"SinglePage"``

Represents the viewer page navigation mode.

**`remarks`**
Accepted values:
- `'Continuous'`
- `'SinglePage'`

**`example`**
```ts
const mode: ViewerViewMode = 'Continuous';
```

___

### <a id="viewerzoommode" name="viewerzoommode"></a> ViewerZoomMode

Ƭ **ViewerZoomMode**: ``"FitToWidth"`` \| ``"FitPage"`` \| `number`

Represents the zoom strategy or explicit scale factor for the viewer.

**`remarks`**
Accepted values:
- `'FitToWidth'`
- `'FitPage'`
- `number`: Zoom factor (for example, `1` for 100%).

**`example`**
```ts
const zoom: ViewerZoomMode = 'FitToWidth';
```