Variable: PdfToolsViewerApi
const
PdfToolsViewerApi:object
Simple static wrapper without any state Just for automcomplete easy-of-use Exactly the same as calling dispatchEvent / addEventListener with the same parameters One point of interaction with the whole api
Type declaration
addEventListener()
addEventListener: (
eventName
,fn
) =>void
Adds event at this level in the object
Parameters
• eventName: keyof EventMap
• fn: () => string
| (txt
) => void
| (data
, password
?) => void
| (componentName
, payload
?) => void
| (fitMode
) => void
| (pageMode
) => void
| (zoom
) => void
| (visible
?) => void
| (visible
?) => void
| (txt
) => void
| (active
) => void
| () => void
| (pageNumber
) => void
| (active
) => void
| (searchResult
) => void
| () => void
| (caseSensitive
) => void
| (regularExpression
) => void
| () => void
Returns
void
dialogs
dialogs:
object
dialogs.passwordModal
passwordModal:
object
dialogs.passwordModal.addEventListener()
addEventListener: (
eventName
,fn
) =>void
Parameters
• eventName: "toggled"
• fn
Returns
void
dialogs.passwordModal.toggled()
toggled: (
active
) =>void
Parameters
• active: boolean
Returns
void
dialogs.passwordModal.unlockButton
unlockButton:
object
dialogs.passwordModal.unlockButton.addEventListener()
addEventListener: (
eventName
,fn
) =>void
Parameters
• eventName: "clicked"
• fn
Returns
void
dialogs.passwordModal.unlockButton.clicked()
clicked: () =>
void
Returns
void
dialogs.thumbnailsSidebar
thumbnailsSidebar:
object
dialogs.thumbnailsSidebar.addEventListener()
addEventListener: (
eventName
,fn
) =>void
Parameters
• eventName: "thumbnailClicked"
• fn
Returns
void
dialogs.thumbnailsSidebar.thumbnailClicked()
thumbnailClicked: (
pageNumber
) =>void
Parameters
• pageNumber: number
Returns
void
document
document:
object
document.goToPage()
goToPage: (
viewerEl
,pageNumber
) =>void
Parameters
• viewerEl: PdfToolsViewer
• pageNumber: number
Returns
void
document.nextPage()
nextPage: (
viewerEl
) =>void
Parameters
• viewerEl: PdfToolsViewer
Returns
void
document.openFromBlob()
openFromBlob: (
blob
,password
?) =>void
Open a document from a js Blob object
Parameters
• blob: Blob
Blob representing the document
• password?: string
optional password
Returns
void
document.openFromFile()
openFromFile: (
file
,password
?) =>void
Open a document from a js File object
Parameters
• file: File
File to open
• password?: string
optional password
Returns
void
document.openFromMemory()
openFromMemory: (
data
,password
?) =>void
Open a document from memory
Parameters
• data: Uint8Array
Uint8Array
representing the document
• password?: string
optional password
Returns
void
document.openFromUrl()
openFromUrl: (
url
,password
?) =>void
Open a document from a url
Parameters
• url: string
url to open
• password?: string
optional password
Returns
void
document.previousPage()
previousPage: (
viewerEl
) =>void
Parameters
• viewerEl: PdfToolsViewer
Returns
void
document.rotate()
rotate: (
viewerEl
,newRotation
) =>void
Parameters
• viewerEl: PdfToolsViewer
• newRotation: Rotation
Returns
void
document.tools
tools:
object
document.tools.extractText
extractText:
object
document.tools.extractText.addEventListener()
addEventListener: (
eventName
,fn
) =>void
Parameters
• eventName: "start"
| "textExtracted"
• fn: () => string
| (txt
) => void
Returns
void
document.tools.extractText.start()
start: () =>
void
Returns
void
document.tools.extractText.textExtracted()
textExtracted: (
txt
) =>void
Parameters
• txt: string
Returns
void
file
file:
object
file.addEventListener()
addEventListener: (
eventName
,fn
) =>void
Parameters
• eventName: "opened"
• fn
Returns
void
file.opened()
opened: (
data
,password
?) =>void
Parameters
• data: string
| Uint8Array
| Blob
| File
• password?: string
Returns
void
hideElements()
hideElements: (
viewerEl
,components
) =>void
Hide some elements part of the viewer ui
Parameters
• viewerEl: PdfToolsViewer
Viewer DOM element
• components: HideableComponentConfigName
[]
A list of elements to hide
Returns
void
search
search:
object
search.addEventListener()
addEventListener: (
eventName
,fn
) =>void
Parameters
• eventName: "toggled"
| "searchResultClicked"
| "settingsClicked"
| "caseSensitiveToggled"
| "regularExpressionToggled"
| "clearSearchPanelInputClicked"
• fn: (active
) => void
| (searchResult
) => void
| () => void
| (caseSensitive
) => void
| (regularExpression
) => void
| () => void
Returns
void
search.caseSensitiveToggled()
caseSensitiveToggled: (
caseSensitive
) =>void
Parameters
• caseSensitive: boolean
Returns
void
search.clearSearchPanelInputClicked()
clearSearchPanelInputClicked: () =>
void
Returns
void
search.regularExpressionToggled()
regularExpressionToggled: (
regularExpression
) =>void
Parameters
• regularExpression: boolean
Returns
void
search.removeEventListener()
removeEventListener: (
eventName
,fn
) =>void