Class: Viewer

ReportViewer.Viewer

Represents the report viewer component.

remarks Use this class to render and interact with reports in the browser.

example

const viewer = new Viewer('#viewer');

Table of contents

Constructors

• constructor

Accessors

• availableExports
• currentPage
• documentLoaded
• errorHandler
• history
• mouseMode
• pageCount
• renderMode
• reportLoaded
• showParametersOnOpen
• stateChanged
• theme
• toolbar
• viewMode
• zoom

Methods

• backToParent
• canBackToParent
• dispose
• export
• goToFirstPage
• goToLastPage
• goToNextPage
• goToPage
• goToPrevPage
• highlight
• open
• print
• refresh
• resetDocument
• search
• toggleFullScreen
• toggleSidebar
• toggleToolbar

Constructors

constructor

• new Viewer(element, options?)

Initializes a new instance of the Viewer class.

example

const viewer = new ActiveReports.Viewer('#viewer', { language: 'en' });
await viewer.open('report.json');

Parameters

Name	Type	Description
element	string | object | Element	The host element for the viewer.
options?	ViewerOptions	Optional viewer configuration settings.

Accessors

availableExports

• get availableExports(): string[]

Gets or sets the export formats shown in the export panel.

Returns

string[]

• set availableExports(formatKeys): void

Gets or sets the export formats shown in the export panel.

Parameters

Name	Type
formatKeys	string[]

Returns

void

---

currentPage

• get currentPage(): number

Gets the current page number (1-based).

Returns

number

---

documentLoaded

• get documentLoaded(): Event<DocumentLoadEventArgs>

Gets the event fired after the document is fully rendered.

Returns

Event<DocumentLoadEventArgs>

---

errorHandler

• get errorHandler(): ErrorHandler

Gets or sets the viewer error handler.

Returns

ErrorHandler

• set errorHandler(handler): void

Gets or sets the viewer error handler.

Parameters

Name	Type
handler	ErrorHandler

Returns

void

---

history

• get history(): HistoryApi

Gets the history API.

Returns

HistoryApi

---

mouseMode

• get mouseMode(): ViewerMouseMode

Gets or sets the mouse interaction mode.

Returns

ViewerMouseMode

• set mouseMode(value): void

Gets or sets the mouse interaction mode.

Parameters

Name	Type
value	ViewerMouseMode

Returns

void

---

pageCount

• get pageCount(): number

Gets the total number of pages in the current report.

Returns

number

---

renderMode

• get renderMode(): ViewerRenderMode

Gets or sets the viewer render mode.

Returns

ViewerRenderMode

• set renderMode(mode): void

Gets or sets the viewer render mode.

Parameters

Name	Type
mode	ViewerRenderMode

Returns

void

---

reportLoaded

• get reportLoaded(): Event<ReportLoadEventArgs>

Gets the event fired after a report is loaded.

Returns

Event<ReportLoadEventArgs>

---

showParametersOnOpen

• get showParametersOnOpen(): ShowParametersOnOpen

Gets or sets when the parameters panel is shown.

Returns

ShowParametersOnOpen

• set showParametersOnOpen(mode): void

Gets or sets when the parameters panel is shown.

Parameters

Name	Type
mode	ShowParametersOnOpen

Returns

void

---

stateChanged

• get stateChanged(): Event<ChangedEventArgs>

Gets the event that indicates viewer state changes.

Returns

Event<ChangedEventArgs>

---

theme

• get theme(): undefined | UITheme

Gets or sets the current UI theme.

Returns

undefined | UITheme

• set theme(value): void

Gets or sets the current UI theme.

Parameters

Name	Type
value	undefined | UITheme

Returns

void

---

toolbar

• get toolbar(): Toolbar

Gets the viewer toolbar API.

Returns

Toolbar

---

viewMode

• get viewMode(): ViewerViewMode | ViewMode

Gets or sets the viewer view mode.

Returns

ViewerViewMode | ViewMode

• set viewMode(value): void

Gets or sets the viewer view mode.

Parameters

Name	Type
value	ViewerViewMode | ViewMode

Returns

void

---

zoom

• get zoom(): ViewerZoomMode

Gets or sets the current zoom value.

Returns

ViewerZoomMode

• set zoom(value): void

Gets or sets the current zoom value.

Parameters

Name	Type
value	ViewerZoomMode

Returns

void

Methods

backToParent

▸ backToParent(): void

Navigates back to the parent report.

example

viewer.backToParent();

Returns

void

---

canBackToParent

▸ canBackToParent(): boolean

Gets a value indicating whether back-to-parent navigation is available.

example

const canNavigate = viewer.canBackToParent();

Returns

boolean

true if back-to-parent navigation is available; otherwise, false.

---

dispose

▸ dispose(): void

Disposes the viewer and releases resources.

example

viewer.dispose();

Returns

void

---

export

▸ export(format, settings, params?): Promise<ExportResult>

Exports the current report to the specified format.

example

const result = await viewer.export('pdf', { title: 'Invoice' });
result.download('invoice.pdf');

Parameters

Name	Type	Description
format	string	The export format identifier (for example, pdf, xlsx, or html).
settings	Record<string, string | number | boolean>	The format-specific export settings.
params?	Object	Optional export parameters.
params.cancel?	() => boolean	-

Returns

Promise<ExportResult>

A promise that resolves to the export result.

---

goToFirstPage

▸ goToFirstPage(): void

Navigates to the first page.

example

viewer.goToFirstPage();

Returns

void

---

goToLastPage

▸ goToLastPage(): void

Navigates to the last page.

example

viewer.goToLastPage();

Returns

void

---

goToNextPage

▸ goToNextPage(): void

Navigates to the next page.

example

viewer.goToNextPage();

Returns

void

---

goToPage

▸ goToPage(pageNumber): void

Navigates to the specified page.

example

viewer.goToPage(3);

Parameters

Name	Type	Description
pageNumber	number	The 1-based page number to navigate to.

Returns

void

---

goToPrevPage

▸ goToPrevPage(): void

Navigates to the previous page.

example

viewer.goToPrevPage();

Returns

void

---

highlight

▸ highlight(result): Promise<void>

Highlights a search result.

example

const result = {} as SearchFeature.SearchResult;
await viewer.highlight(result);

Parameters

Name	Type	Description
result	null | SearchResult	The search result to highlight, or null to clear.

Returns

Promise<void>

A promise that resolves when highlighting is complete.

---

open

▸ open(report, settings?): Promise<LoadResult>

Opens a report from a URI, definition, or PageReport instance.

example

await viewer.open('report.json');

Parameters

Name	Type	Description
report	string | Report | PageReport	The report source to open.
settings?	Partial<ReportSettings>	Optional report settings.

Returns

Promise<LoadResult>

A promise that resolves to the load result.

---

print

▸ print(): void

Prints the current report.

example

viewer.print();

Returns

void

---

refresh

▸ refresh(): void

Refreshes the current report.

example

viewer.refresh();

Returns

void

---

resetDocument

▸ resetDocument(): Promise<void>

Resets the current document state.

example

await viewer.resetDocument();

Returns

Promise<void>

A promise that resolves when the document is reset.

---

search

▸ search(options, resultFn, progressFn?, cancel?): Promise<SearchStatus>

Searches within the current report.

example

await viewer.search(
	{ text: 'Total' },
	(result) => console.log(result.pageIndex),
);

Parameters

Name	Type	Description
options	SearchOptions	The search options.
resultFn	(result: SearchResult) => void	The callback invoked for each search result.
progressFn?	(progress: { pageCount: null | number ; pageIndex: number }) => void	The optional callback invoked with search progress.
cancel?	CancellationToken	The optional cancellation token.

Returns

Promise<SearchStatus>

A promise that resolves to the search status.

---

toggleFullScreen

▸ toggleFullScreen(enabled?): void

Toggles full-screen mode.

example

viewer.toggleFullScreen(true);

Parameters

Name	Type	Description
enabled?	boolean	Optional full-screen override. When omitted, the current state is toggled.

Returns

void

---

toggleSidebar

▸ toggleSidebar(visible?): void

Toggles the sidebar panel visibility.

example

viewer.toggleSidebar(true);

Parameters

Name	Type	Description
visible?	boolean	Optional visibility override. When omitted, the visibility is toggled.

Returns

void

---

toggleToolbar

▸ toggleToolbar(show?): void

Toggles the toolbar visibility.

example

viewer.toggleToolbar(false);

Parameters

Name	Type	Description
show?	boolean	Optional visibility override. When omitted, the visibility is toggled.

Returns

void