Interface: ViewerOptions

ReportViewer.ViewerOptions

Defines the contract for viewer configuration options.

example

const options: ViewerOptions = {
	language: 'en',
	ParameterPanelLocation: 'default',
	themeConfig: { initialTheme: 'Default' },
};

Table of contents

Properties

• ErrorHandler
• ExportsSettings
• PanelsLayout
• ParameterPanelLocation
• ToolbarLayout
• animations
• language
• memoizeData
• showEvaluationErrors
• showExpressionWarnings
• themeConfig

Properties

ErrorHandler

• Optional ErrorHandler: ErrorHandler

Gets or sets a custom error handler.

ExportsSettings

• Optional ExportsSettings: Record<string, ExportSettings>

Gets or sets initial export settings by format key.

PanelsLayout

• Optional PanelsLayout: PanelsLocation

Gets or sets the layout of viewer panels.

ParameterPanelLocation

• Optional ParameterPanelLocation: ParameterPanelLocation

Gets or sets the parameters panel location.

ToolbarLayout

• Optional ToolbarLayout: ToolbarLayout

Gets or sets the initial toolbar layout.

animations

• Optional animations: Partial<{ charts: Partial<{ highlight: { enabled: boolean } ; onHover: { enabled: boolean } ; onLoad: { enabled: boolean } }> ; table: { onHover: { backgroundColor: string ; enabled: boolean ; textColor?: string } | { enabled: boolean ; textColor: string } } }>

Gets or sets animation configuration for report rendering.

language

• Optional language: string

Gets or sets the viewer language.

memoizeData

• Optional memoizeData: boolean

Gets or sets whether report data memoization is enabled.

showEvaluationErrors

• Optional showEvaluationErrors: boolean

Gets or sets whether evaluation errors are rendered.

showExpressionWarnings

• Optional showExpressionWarnings: boolean

Gets or sets whether evaluation warning notifications are rendered.

themeConfig

• Optional themeConfig: UIThemeConfig

Gets or sets the UI theme configuration.