Configuration
Viewer Configuration Reference
Property-level reference for ViewerConfiguration.
ViewerConfiguration controls viewer startup behavior and runtime UI defaults.
Properties
| Property | Type | Required |
|---|---|---|
container | string | HTMLElement | Yes |
document | ViewerDocumentSource | No |
showEmptyState | boolean | No |
disableMultiSelection | boolean | No |
initialViewState | ViewStateData | No |
locale | string | No |
i18n | LocaleEntry | LocaleEntry[] | No |
readOnly | boolean | No |
toolbarItems | ToolbarItem[] | No |
inlineTextSelectionToolbarItems | ToolbarItem[] | No |
annotationToolbarItems | ToolbarItem[] | No |
documentEditorToolbarItems | ToolbarItem[] | No |
documentEditorFooterItems | ToolbarItem[] | No |
annotationPresets | AnnotationPresetMap | No |
annotationTooltipCallback | ((annotation: Annotation | null) => unknown) | null | No |
isEditableAnnotation | ((annotation: Annotation) => boolean) | null | No |
styleSheets | ViewerStyleSheet[] | No |
documentSigner | ViewerDocumentSigner | No |
Usage notes
initialViewState.zoomsupports interaction controls such aswheelZoomModeandoptions.enableKeyboardZoom. SetenableKeyboardZoom: falseto disable keyboard zoom shortcuts (Ctrl/Cmd++/-).- Use Viewer Configuration for option-level guidance.
- Use Chrome Options when running with built-in chrome.
- Keep Getting Started as the baseline initialization flow.