Interface: Document
Groups all the API actions related to document handling.
Properties
goToPage()
goToPage: (
viewerEl,pageNumber) =>void
Triggers an event to navigate to a specific page in the document.
Parameters
• viewerEl: PdfToolsViewer
The Viewer DOM element.
• pageNumber: number
The page number to navigate to.
Returns
void
Example
const viewerEl = document.querySelector('#viewer'); PdfToolsViewerApi.document.goToPage(viewerEl, 2);
nextPage()
nextPage: (
viewerEl) =>void
Triggers an event to navigate to the next page in the document.
Parameters
• viewerEl: PdfToolsViewer
The Viewer DOM element.
Returns
void
Example
const viewerEl = document.querySelector('#viewer'); PdfToolsViewerApi.document.nextPage(viewerEl);
open()
open: (
inputDocument) =>void
Opens a document.
Parameters
• inputDocument: InputFile | InputUri
The input required to open the document (either Pdf.InputFile or Pdf.InputUri).
Returns
void
Example
PdfToolsViewerApi.document.tools.open({ data: file });
previousPage()
previousPage: (
viewerEl) =>void
Triggers an event to navigate to the previous page in the document.
Parameters
• viewerEl: PdfToolsViewer
The Viewer DOM element.
Returns
void
Example
const viewerEl = document.querySelector('#viewer'); PdfToolsViewerApi.document.previousPage(viewerEl);
rotate()
rotate: (
viewerEl,newRotation) =>void
Triggers an event to rotate the document.
Parameters
• viewerEl: PdfToolsViewer
The Viewer DOM element.
• newRotation: Rotation
The new rotation value to apply.
Returns
void
Example
const viewerEl = document.querySelector('#viewer'); PdfToolsViewerApi.document.rotate(viewerEl, Rotation.Clockwise);
save()
save: (
viewerEl,options) =>void
Saves the current document as a PDF file and triggers a download.
Parameters
• viewerEl: PdfToolsViewer
The Viewer DOM element.
• options: DocumentSaveOptions
Options for configuring the document save behavior.
Returns
void
Example
const viewerEl = document.querySelector('#viewer'); PdfToolsViewerApi.document.save(viewerEl, options);
tools
tools:
object
Groups all the API actions related to document tools.
extractText
extractText:
object
Groups all the API actions related to document text extraction tools.
extractText.addEventListener()
addEventListener: (
eventName,fn) =>void
Adds an event listener to the different events related to text extraction.
Parameters
• eventName: "start" | "textExtracted"
The event name ('start' or 'textExtracted').
• fn: () => string | (txt) => void
The callback function to execute when the event is triggered.
Returns
void
Example
PdfToolsViewerApi.document.tools.extractText.addEventListener('start', () => { console.log('callback') });
extractText.start()
start: () =>
void
Triggers an event indicating that text extraction has started.
Returns
void
Example
PdfToolsViewerApi.document.tools.extractText.start();
extractText.textExtracted()
textExtracted: (
txt) =>void
Triggers an event indicating that text has been extracted.
Parameters
• txt: string
The extracted text.
Returns
void
Example
PdfToolsViewerApi.document.tools.extractText.textExtracted('lorem ipsum');