[]
DEMO DOCS API
DOWNLOAD
(Showing Draft Content)

ReportViewer

Namespace: ReportViewer

Table of contents

Enumerations

Classes

Interfaces

Type aliases

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:880

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:956

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:852

ParameterPanelsLocation

Ƭ ParameterPanelsLocation: PanelLocation

Parameters view/panel location

Defined in

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

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:858

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

UnregisterHandler

Ƭ UnregisterHandler: () => any

Type declaration

▸ (): any

Unsubscribe event handler

Returns

any

Defined in

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

ViewerMouseMode

Ƭ ViewerMouseMode: "Pan" | "Selection"

Viewer mouse mode

Defined in

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

ViewerRenderMode

Ƭ ViewerRenderMode: "Galley" | "Paginated"

Viewer render mode

Defined in

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

ViewerViewMode

Ƭ ViewerViewMode: "Continuous" | "SinglePage"

Viewer view mode

Defined in

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

ViewerZoomMode

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

Viewer zoom mode

Defined in

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