Skip to main content
Version: Version 5

Type Alias: DocumentViewOptions

DocumentViewOptions = object

Configuration options for initializing a DocumentView.

These options allow you to customize the initial behavior and appearance of the document view.

Properties

accessibilityLayerEnabled?

optional accessibilityLayerEnabled?: boolean

Enables or disables the accessibility layer for the document view. When enabled, the accessibility layer provides support for screen readers and other accessibility tools by creating an invisible HTML structure aligned with the text fragments on the page.

Default Value

false


devicePixelRatio?

optional devicePixelRatio?: number

Device pixel ratio (DPR) for rendering. Higher values produce sharper images at the cost of more memory and CPU usage.

Default Value

window.devicePixelRatio


fitMode?

optional fitMode?: FitMode

Specifies the fit mode for the document view. Determines how the document pages are scaled to fit within the viewport.

Default Value

FitMode.None


pageLayoutMode?

optional pageLayoutMode?: PageLayoutMode

Specifies the page layout mode for the document view. Determines how pages are arranged within the viewport (e.g., single column, two columns).

Default Value

PageLayoutMode.OneColumn


useInitialDestination?

optional useInitialDestination?: boolean

Controls whether to automatically navigate to the PDF’s initial destination when the document view is initialized. If the PDF does not have an initial destination, this option has no effect.

Default Value

true


zoom?

optional zoom?: number

Initial zoom level for the document view. 1 corresponds to 100% zoom.

Default Value

1