Skip to main content
Version: Version 5

Interface: DocumentViewEventMap

Interface defining event types for changes in a document view.

Properties

backgroundClicked()

backgroundClicked: () => void

Returns

void


currentPageChanged()

currentPageChanged: (pageNumber) => void

Event triggered when the currently displayed page in the document view changes. The event payload is a number representing the page number of the currently displayed page.

Parameters

pageNumber: number

Returns

void


firstVisiblePageChanged()

firstVisiblePageChanged: (pageNumber) => void

Event triggered when the index of the first visible page in the document view changes. The event payload is a number representing the page number of the first visible page.

Parameters

pageNumber: number

Returns

void


fitModeChanged()

fitModeChanged: (fitMode) => void

Event triggered when the fit mode of the document view changes. The event payload is a value of the FitMode enum representing the new fit mode.

Parameters

fitMode: FitMode

Returns

void


lastVisiblePageChanged()

lastVisiblePageChanged: (pageNumber) => void

Event triggered when the index of the last visible page in the document view changes. The event payload is a number representing the page number of the last visible page.

Parameters

pageNumber: number

Returns

void


pageClick()

pageClick: (pageNumber, payload) => void

Parameters

pageNumber: number

payload: MouseEvent

Returns

void


pageDoubleClick()

pageDoubleClick: (pageNumber, payload) => void

Parameters

pageNumber: number

payload: MouseEvent

Returns

void


pageLayoutModeChanged()

pageLayoutModeChanged: (pageLayoutMode) => void

Event triggered when the page layout mode of the document view changes. The event payload is a value of the PageLayoutMode enum representing the new layout mode.

Parameters

pageLayoutMode: PageLayoutMode

Returns

void


pageMouseDown()

pageMouseDown: (pageNumber, payload) => void

Parameters

pageNumber: number

payload: MouseEvent

Returns

void


pageMouseEnter()

pageMouseEnter: (pageNumber, payload) => void

Parameters

pageNumber: number

payload: MouseEvent

Returns

void


pageMouseLeave()

pageMouseLeave: (pageNumber, payload) => void

Parameters

pageNumber: number

payload: MouseEvent

Returns

void


pageMouseMove()

pageMouseMove: (pageNumber, payload) => void

Parameters

pageNumber: number

payload: MouseEvent

Returns

void


pageMouseUp()

pageMouseUp: (pageNumber, payload) => void

Parameters

pageNumber: number

payload: MouseEvent

Returns

void


pageRendered()

pageRendered: (pageNumber) => void

Event triggered when a page in the document view finishes rendering. The event payload is a number representing the page number of the rendered page.

Parameters

pageNumber: number

Returns

void


rotationChanged()

rotationChanged: (rotation) => void

Event triggered when the rotation of the document view changes. The event payload is a value of the Rotation enum representing the new rotation.

Parameters

rotation: Rotation

Returns

void


zoomChanged()

zoomChanged: (zoomLevel) => void

Event triggered when the zoom level of the document view changes. The event payload is a number representing the new zoom level.

Parameters

zoomLevel: number

Returns

void