# 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)
- [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"``

UI theme

___

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

Ƭ **DocumentLoadEventArgs**: `Object`

Defines the 'documentLoaded' event arg.

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `cancelled?` | `boolean` | true if document rendering was cancelled |
| `pageCount` | `number` | number of document pages. |

___

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

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

Initial settings for export panel:

``` javascript
var exportSettings = {
	filename: 'NewFile'
};
```

___

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

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

___

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

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

Viewer panels location

___

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

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

Parameters view/panel location

___

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

Ƭ **ReportLoadEventArgs**: `Object`

'reportLoaded' event arg

#### Type declaration

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

___

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

Ƭ **SearchOptions**: `Object`

Defines the argument type for the ReportViewer.search method.

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `matchCase?` | `boolean` | Case-sensitive search. |
| `searchBackward?` | `boolean` | Search backward from the current position. |
| `startPage?` | `number` | The page to start the search from. |
| `text` | `string` | Text to search for. |
| `wholeWord?` | `boolean` | Match whole word. |

___

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

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

Parameters view/panel open behaviour

___

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

Ƭ **ToolbarLayout**: `Object`

Describes the toolbar items layout (order and visibility) for different view models.

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `default?` | `string`[] | Default (desktop) view mode. Also applied when other modes are not specified. |
| `fullscreen?` | `string`[] | The layout for the full-screen mode. |
| `mobile?` | `string`[] | The toolbar layout for mobile devices. |

___

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

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

___

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

Ƭ **UIThemeConfig**: `Object`

#### Type declaration

| Name | Type | Description |
| :------ | :------ | :------ |
| `initialTheme?` | `string` | The initial theme to be applied.  **`default`** "Default" |
| `themeSelector?` | { `availableThemes?`: [`UITheme`](ReportViewer#uitheme)[] ; `isEnabled?`: `boolean`  } | Controls Theme Picker behavior |
| `themeSelector.availableThemes?` | [`UITheme`](ReportViewer#uitheme)[] | An array of available themes that can be picked by the user. These themes are built-in themes.  **`default`** ["System", "Default", "DefaultDark", "DarkOled", "HighContrast", "HighContrastDark", "ActiveReports", "ActiveReportsDark"] |
| `themeSelector.isEnabled?` | `boolean` | shows Theme Picker in UI |

___

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

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

Viewer mouse mode

___

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

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

Viewer render mode

___

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

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

Viewer view mode

___

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

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

Viewer zoom mode