Namespace: ReportViewer

Table of contents

Enumerations

• MouseMode
• ViewMode
• ViewerStatus
• ZoomMode

Classes

• CancellationToken
• EventFan
• Toolbar
• Viewer

Interfaces

• ExportResult
• FontDescriptor
• HistoryApi
• ReportSettings
• ViewerOptions

Type aliases

• DocumentLoadEventArgs
• ExportSettings
• LoadResult
• PanelsLocation
• ParameterPanelsLocation
• ReportLoadEventArgs
• SearchOptions
• ToolbarItem
• ToolbarLayout
• ViewerMouseMode
• ViewerRenderMode
• ViewerViewMode
• ViewerZoomMode

Type aliases

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.

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:888

---

ExportSettings

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

Initial settings for export panel:

var exportSettings = {
	filename: 'NewFile'
};

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:964

---

LoadResult

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

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:660

---

PanelsLocation

Ƭ PanelsLocation: "sidebar" | "toolbar"

Viewer panels location

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:860

---

ParameterPanelsLocation

Ƭ ParameterPanelsLocation: PanelLocation

Parameters view/panel location

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:862

---

ReportLoadEventArgs

Ƭ ReportLoadEventArgs: Object

'reportLoaded' event arg

Type declaration

Name	Type	Description
report	PageReport	The loaded report

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:866

---

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.

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:707

---

ToolbarItem

Ƭ ToolbarItem: Object

Defines the toolbar item settings and behavior.

Type declaration

Name	Type
checked?	boolean
enabled?	boolean
icon?	Icon
iconCssClass?	string
key	string
text?	string
title?	string
action?	(curr?: ToolbarItem) => void | Partial<ToolbarItem>
onUpdate?	(args: ChangedEventArgs, curr: ToolbarItem) => void | Partial<ToolbarItem>

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:493

---

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.

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:508

---

ViewerMouseMode

Ƭ ViewerMouseMode: "Pan" | "Selection"

Viewer mouse mode

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:858

---

ViewerRenderMode

Ƭ ViewerRenderMode: "Galley" | "Paginated"

Viewer render mode

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:852

---

ViewerViewMode

Ƭ ViewerViewMode: "Continuous" | "SinglePage"

Viewer view mode

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:854

---

ViewerZoomMode

Ƭ ViewerZoomMode: "FitToWidth" | "FitPage" | number

Viewer zoom mode

Defined in

node_modules/@grapecity/ar-js-viewer/dist/ar-js-viewer.d.ts:856