Interface: DocumentViewEventMap
Interface defining event types for changes in a document view.
Properties
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
documentViewClick
documentViewClick: (
payload) =>void
Event triggered when the document view is clicked. The event payload is the MouseEvent object.
Parameters
payload
MouseEvent
Returns
void
documentViewDoubleClick
documentViewDoubleClick: (
payload) =>void
Event triggered when the document view is double-clicked. The event payload is the MouseEvent object.
Parameters
payload
MouseEvent
Returns
void
documentViewMouseDown
documentViewMouseDown: (
payload) =>void
Event triggered when the mouse button is pressed down within the document view. The event payload is the MouseEvent object.
Parameters
payload
MouseEvent
Returns
void
documentViewMouseEnter
documentViewMouseEnter: (
payload) =>void
Event triggered when the mouse enters the document view. The event payload is the MouseEvent object.
Parameters
payload
MouseEvent
Returns
void
documentViewMouseLeave
documentViewMouseLeave: (
payload) =>void
Event triggered when the mouse leaves the document view. The event payload is the MouseEvent object.
Parameters
payload
MouseEvent
Returns
void
documentViewMouseMove
documentViewMouseMove: (
payload) =>void
Event triggered when the mouse moves within the document view. The event payload is the MouseEvent object.
Parameters
payload
MouseEvent
Returns
void
documentViewMouseUp
documentViewMouseUp: (
payload) =>void
Event triggered when the mouse button is released within the document view. The event payload is the MouseEvent object.
Parameters
payload
MouseEvent
Returns
void
documentViewPointerCancel
documentViewPointerCancel: (
event) =>void
Fired when a pointer is canceled (e.g. touch→pointercancel) in the document view.
Parameters
event
PointerEvent
Returns
void
documentViewPointerDown
documentViewPointerDown: (
event) =>void
Fired when a pointer is pressed down anywhere in the document view.
Parameters
event
PointerEvent
Returns
void
documentViewPointerEnter
documentViewPointerEnter: (
event) =>void
Fired when a pointer enters the document view.
Parameters
event
PointerEvent
Returns
void
documentViewPointerLeave
documentViewPointerLeave: (
event) =>void
Fired when a pointer leaves the document view.
Parameters
event
PointerEvent
Returns
void
documentViewPointerMove
documentViewPointerMove: (
event) =>void
Fired when a pointer moves within the document view.
Parameters
event
PointerEvent
Returns
void
documentViewPointerUp
documentViewPointerUp: (
event) =>void
Fired when a pointer is released anywhere in the document view.
Parameters
event
PointerEvent
Returns
void
documentViewTouchCancel
documentViewTouchCancel: (
payload) =>void
Event triggered when a touch is canceled within the document view. The event payload is the TouchEvent object.
Parameters
payload
TouchEvent
Returns
void
documentViewTouchEnd
documentViewTouchEnd: (
payload) =>void
Event triggered when a touch ends within the document view. The event payload is the TouchEvent object.
Parameters
payload
TouchEvent
Returns
void
documentViewTouchMove
documentViewTouchMove: (
payload) =>void
Event triggered when a touch moves within the document view. The event payload is the TouchEvent object.
Parameters
payload
TouchEvent
Returns
void
documentViewTouchStart
documentViewTouchStart: (
payload) =>void
Event triggered when a touch starts within the document view. The event payload is the TouchEvent object.
Parameters
payload
TouchEvent
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
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
pageAddedToViewport
pageAddedToViewport: (
pageNumber) =>void
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
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
pagePointerCancel
pagePointerCancel: (
pageNumber,payload) =>void
Parameters
pageNumber
number
payload
PointerEvent
Returns
void
pagePointerDown
pagePointerDown: (
pageNumber,payload) =>void
Parameters
pageNumber
number
payload
PointerEvent
Returns
void
pagePointerEnter
pagePointerEnter: (
pageNumber,payload) =>void
Parameters
pageNumber
number
payload
PointerEvent
Returns
void
pagePointerLeave
pagePointerLeave: (
pageNumber,payload) =>void
Parameters
pageNumber
number
payload
PointerEvent
Returns
void
pagePointerMove
pagePointerMove: (
pageNumber,payload) =>void
Parameters
pageNumber
number
payload
PointerEvent
Returns
void
pagePointerUp
pagePointerUp: (
pageNumber,payload) =>void
Parameters
pageNumber
number
payload
PointerEvent
Returns
void
pageRemovedFromViewport
pageRemovedFromViewport: (
pageNumber) =>void
Parameters
pageNumber
number
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
pageTouchCancel
pageTouchCancel: (
pageNumber,payload) =>void
Parameters
pageNumber
number
payload
TouchEvent
Returns
void
pageTouchEnd
pageTouchEnd: (
pageNumber,payload) =>void
Parameters
pageNumber
number
payload
TouchEvent
Returns
void
pageTouchMove
pageTouchMove: (
pageNumber,payload) =>void
Parameters
pageNumber
number
payload
TouchEvent
Returns
void
pageTouchStart
pageTouchStart: (
pageNumber,payload) =>void
Parameters
pageNumber
number
payload
TouchEvent
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
Returns
void
scrollPositionChanged
scrollPositionChanged: (
x,y) =>void
Event triggered when the scroll in the document view changes. The event payload is the x,y coordinates of the new scroll position.
Parameters
x
number
y
number
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