[]
DEMO DOCS API
DOWNLOAD
(Showing Draft Content)

ReportViewer

Namespace: ReportViewer

Table of contents

Enumerations

Classes

Interfaces

Type aliases

Type aliases

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

const theme: BuiltInUITheme = 'Default';

DocumentLoadEventArgs

Ƭ DocumentLoadEventArgs: Object

Represents the event arguments for the documentLoaded event.

example

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.

ExportSettings

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

Represents the export settings map for a specific format.

example

const settings: ExportSettings = {
	PrintOnOpen: false,
	UseEmbeddedFonts: true,
};

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

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

PanelsLocation

Ƭ PanelsLocation: "sidebar" | "toolbar"

Represents the location of viewer panels.

remarks Accepted values:

  • 'sidebar'
  • 'toolbar'

example

const location: PanelsLocation = 'sidebar';

ParameterPanelLocation

Ƭ ParameterPanelLocation: "auto" | "default" | "top" | "bottom"

Represents the location of the parameters panel.

remarks Accepted values:

  • 'auto'
  • 'default'
  • 'top'
  • 'bottom'

example

const location: ParameterPanelLocation = 'auto';

ReportLoadEventArgs

Ƭ ReportLoadEventArgs: Object

Represents the event arguments for the reportLoaded event.

example

const args: ReportLoadEventArgs = {
	report: {} as PageReport,
};

Type declaration

Name Type Description
report PageReport Gets the loaded report.

SearchOptions

Ƭ SearchOptions: Object

Represents the options for the ReportViewer.search method.

example

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.

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

const show: ShowParametersOnOpen = 'auto';

ToolbarLayout

Ƭ ToolbarLayout: Object

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

example

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.

UITheme

Ƭ UITheme: BuiltInUITheme | ColorTheme

Represents a UI theme definition.

remarks Use a built-in theme name or provide a custom ColorTheme.

example

const theme: UITheme = 'System';

UIThemeConfig

Ƭ UIThemeConfig: Object

Represents UI theme configuration settings.

example

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 Gets or sets the theme selector configuration.

UIThemeSelectorConfig

Ƭ UIThemeSelectorConfig: Object

Represents theme selector configuration.

example

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

Type declaration

Name Type Description
availableThemes? 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.

ViewerMouseMode

Ƭ ViewerMouseMode: "Pan" | "Selection"

Represents the mouse interaction mode.

remarks Accepted values:

  • 'Pan'
  • 'Selection'

example

const mode: ViewerMouseMode = 'Pan';

ViewerRenderMode

Ƭ ViewerRenderMode: "Galley" | "Paginated"

Represents the rendering mode of the viewer.

remarks Accepted values:

  • 'Galley'
  • 'Paginated'

example

const mode: ViewerRenderMode = 'Galley';

ViewerViewMode

Ƭ ViewerViewMode: "Continuous" | "SinglePage"

Represents the viewer page navigation mode.

remarks Accepted values:

  • 'Continuous'
  • 'SinglePage'

example

const mode: ViewerViewMode = 'Continuous';

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

const zoom: ViewerZoomMode = 'FitToWidth';