Configuration

Viewer Configuration Reference

Property-level reference for ViewerConfiguration.

ViewerConfiguration controls viewer startup behavior and runtime UI defaults.

Properties

PropertyTypeRequired
containerstring | HTMLElementYes
documentViewerDocumentSourceNo
showEmptyStatebooleanNo
disableMultiSelectionbooleanNo
initialViewStateViewStateDataNo
localestringNo
i18nLocaleEntry | LocaleEntry[]No
readOnlybooleanNo
toolbarItemsToolbarItem[]No
inlineTextSelectionToolbarItemsToolbarItem[]No
annotationToolbarItemsToolbarItem[]No
documentEditorToolbarItemsToolbarItem[]No
documentEditorFooterItemsToolbarItem[]No
annotationPresetsAnnotationPresetMapNo
annotationTooltipCallback((annotation: Annotation | null) => unknown) | nullNo
isEditableAnnotation((annotation: Annotation) => boolean) | nullNo
styleSheetsViewerStyleSheet[]No
documentSignerViewerDocumentSignerNo

Usage notes

  • initialViewState.zoom supports interaction controls such as wheelZoomMode and options.enableKeyboardZoom. Set enableKeyboardZoom: false to 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.