Interface: DocumentView
Groups all the API actions related to the document view.
Properties
addEventListener()
addEventListener: (
eventName,callback) =>void
Adds an event listener for the document view.
Parameters
eventName
The name of the event to listen for.
"clicked" | "doubleclicked" | "setCursor" | "pageChanged" | "rotated"
callback
The callback function to execute when the event is triggered.
(pageNumber, point) => void | (pageNumber, point) => void | (cursor) => void | (pageNumber) => void | (rotation) => void
Returns
void
A function to remove the event listener.
emitClicked()
emitClicked: (
pageNumber,point) =>void
Emits a clicked event for the document view.
Parameters
pageNumber
number
The page number where the click occurred.
point
The point where the click occurred.
Returns
void
emitDoubleclicked()
emitDoubleclicked: (
pageNumber,point) =>void
Emits a double clicked event for the document view.
Parameters
pageNumber
number
The page number where the double click occurred.
point
The point where the double click occurred.
Returns
void
emitPageChanged()
emitPageChanged: (
pageNumber) =>void
Emits a page changed event.
Parameters
pageNumber
number
The new page number.
Returns
void
emitRotated()
emitRotated: (
newRotation) =>void
Emits a rotated event for the document view.
Parameters
newRotation
The new rotation value.
Returns
void
emitSetCursor()
emitSetCursor: (
cursor) =>void
Emits a set cursor event for the document view.
Parameters
cursor
The new cursor position.
Returns
void
goToPage()
goToPage: (
pageNumber) =>void
Navigates to a specific page in the document.
Parameters
pageNumber
number
The page number to navigate to.
Returns
void
nextPage()
nextPage: () =>
void
Navigates to the next page in the document.
Returns
void
previousPage()
previousPage: () =>
void
Navigates to the previous page in the document.
Returns
void
removeEventListener()
removeEventListener: (
eventName,callback) =>void
Removes an event listener for the document view.
Parameters
eventName
The name of the event to stop listening for.
"clicked" | "doubleclicked" | "setCursor" | "pageChanged" | "rotated"
callback
The callback function to remove.
(pageNumber, point) => void | (pageNumber, point) => void | (cursor) => void | (pageNumber) => void | (rotation) => void
Returns
void
rotate()
rotate: (
newRotation) =>void
Rotates the document view.
Parameters
newRotation
The new rotation value.
Returns
void
zoomIn()
zoomIn: () =>
void
Zooms in the document view.
Returns
void
zoomOut()
zoomOut: () =>
void
Zooms out the document view.
Returns
void
Methods
getZoom()
getZoom():
number
Gets the current zoom level of the document view.
Returns
number
The current zoom level.