PDFTron WebViewer

Class: Document

CoreControls. Document

Represents a document.

new Document(id, type)

Constructs a new empty Document, representing a document with individual pages (canvases) that can be displayed on screen and printed.
Parameters:
Name Type Description
id string Unique string identifier for the document
type string The type of document that should be instantiated. Values are 'xod' for XOD documents, 'pdf' for PDF, JPG or PNG documents, 'office' for MS Office documents and 'blackbox' for WebViewer Server documents

Methods

<static> registerDocumentType(type, source, exposedFuncs)

Register new document type with Document class
Parameters:
Name Type Description
type String Name of the new document type
source any Class of the new document
exposedFuncs Array.<string> An array containing strings of the function names to expose on the document object
Returns:
Type
Boolean

<static> unregisterDocumentType(type)

Unregister existing document type form Document class
Parameters:
Name Type Description
type String Name of registered document type
Returns:
Type
Boolean

cancelLoadCanvas(id)

Cancels the loadCanvasAsync call corresponding to the passed in id
Parameters:
Name Type Description
id number The id returned from the loadCanvasAsync call that will be cancelled.

cancelLoadThumbnail(requestId)

Cancels the request made for thumbnail with the specified request Id
Parameters:
Name Type Description
requestId number The id returned from loadThumbnailAsync

cancelOfflineModeDownload()

Cancels a download for offline mode in progress. If there is no current download then this does nothing.

cropPages(pageArray, topMargin, botMargin, leftMargin, rightMargin)

[PDF Document only] Crop the given pages by the given margins. Note that this method will need to wait for the entire file to be downloaded before the change is applied.
Parameters:
Name Type Description
pageArray Array.<number> an array of page numbers to crop
topMargin number how much to crop from the top
botMargin number how much to crop from the bottom
leftMargin number how much to crop from the left
rightMargin number how much to crop from the right
Returns:
a promise that resolves to an object describing the updated state of the pages in the document
Type
Promise.<object>

documentCompletePromise()

Returns:
A promise that resolves when all of the page information is available for the document
Type
Promise.<any>

enableColorSeparations(enabled)

[PDF Document only] Enables or disables the color separations feature for rendering.
Parameters:
Name Type Description
enabled boolean Whether to enable or disable color separations rendering.

enableSeparation(name, enabled)

[PDF Document only] Enables or disables the rendering of a particular color separation.
Parameters:
Name Type Description
name string The name of the separation
enabled boolean Whether to enable or disable the separation

extractPages(pageArray, xfdfString)

[PDF Document only] Extract the given pages from the document. Note that this method will need to wait for the entire file to be downloaded before the change is applied.
Parameters:
Name Type Description
pageArray Array.<number> an array of the page numbers to extract
xfdfString string an XFDF string to merge into the document before extracting
Returns:
a promise that resolves on completion
Type
Promise.<any>

extractPDFNetLayersContext(layers)

[PDF Document only][PDFNetJS full only] Get the updated context of a document as a PDFNet object.
Parameters:
Name Type Description
layers layers
Returns:
a promise that resolves to a PDFNet Context object representing the current layers/OCG state.
Type
Promise.<object>

extractXFDF(pages)

Gets the XFDF data for the document's internal annotations.
Parameters:
Name Type Description
pages Array.<number> An array of page numbers to get the XFDF data for the document. Note: Only one page is supported by XOD documents.
Returns:
A promise that resolves to an object with an xfdfString property and a pages property where pages is the array of page numbers that annotations were extracted from
Type
Promise.<CoreControls.Document.XFDFInfo>

getBookmarks()

Returns an array containing the bookmarks in the document.
Returns:
A promise resolving to an array containing the bookmarks in the current document.
Type
Promise.<Array.<CoreControls.Bookmark>>

getColorSeparations()

[PDF Document only] Gets the color separations available on this document.
Returns:
The color separations of the document
Type
Array.<any>

getDocumentId()

Returns:
returns user defined document id passed in WebViewer constructor constorctor or loadDocument API, e.g. WebViewer({ documentId: 'foo-11', initialDoc: 'url' }) or instance.loadDocument(url, { documentId: 'foo-11' })
Type
string
[PDFTron Server only] Provides a URL to a the PDF with annotations and watermarks merged.
Parameters:
Name Type Argument Description
options Object <optional>
 An optional object containing download options and parameters.
Properties
Name Type Argument Description
filename string <optional>
 The preferred name for the downloaded file on the client side. This has no effect on the backend target of the returned link, only the filename used by the browser when the link is accessed.
Returns:
Will be null if not supported. Otherwise a promise that resolves to an object with a `url` property pointing to the printable PDF.
Type
Promise.<object> | null

getFileData( [options])

[PDF/Office Document only] Asynchronously saves the document and provides the result as an ArrayBuffer. To include annotations in the saved document, please provide an object with the xfdfString property.
Parameters:
Name Type Argument Description
options Object <optional>
 An optional object containing save options and parameters.
Properties
Name Type Argument Description
xfdfString string <optional>
 An xfdf string containing annotation data to be used when saving. This will usually be retrieved by calling exportAnnotations on a CoreControls.AnnotationManager object.
flatten boolean <optional>
 A flag that is only useful when the xfdfString option is used. If true all the annotations in the saved document will be flattened.
finishedWithDocument boolean <optional>
 A flag specifying that the document data may be discarded by the worker after use. Only use this when completely finished with document processing. When handling larger documents this can be useful to avoid memory exhaustion as only one copy of the document needs to be kept.
printDocument boolean <optional>
 If true the saved document data will have an open action specifying that it should be printed. This is mostly only used to trigger print actions in the browser's PDF Viewer.
downloadType string <optional>
 The file type to download as, where the default is the source type. PDF and image files can only be downloaded as PDFs, but office files can be downloaded as "pdf" or as "office" if you want to get the original file without annotations.
flags number <optional>
 The flags with which to save the document. Possible values include CoreControls.SaveOptions.REMOVE_UNUSED (remove unused objects during save) and CoreControls.SaveOptions.LINEARIZED (optimize the document for fast web view and remove unused objects). The default value is CoreControls.SaveOptions.REMOVE_UNUSED.
Returns:
a promise that resolves to an array buffer containing PDF document bytes.
Type
Promise.<ArrayBuffer>

getFilename()

Get the document filename used for downloading.
Returns:
filename of the document.
Type
string

getFileSize( [aggressionLevel])

Get the size of the document in bytes. Throws if the size cannot be found.
Parameters:
Name Type Argument Default Description
aggressionLevel number <optional>
 2 Set the number of failed attempts to allow before throwing. Each attempt calls a method that may take slighly longer than the previous. The order of attempts are as follows: 1) Return the size immediately if we already have the data 2) Make a HEAD request to the server and attempt to read the 'content-length' header 3) Download the full document and return the size For example, setting aggressionLevel to 1 only tries the first method, setting it to 3 tries all the methods. The default is 2
Returns:
The number of bytes
Type
Promise.<number>

getLayersArray()

[PDF Document only] Get an array describing the layers/OCG structure in the document. Each entry in the array is a layer entry the form {obj: string, locked: boolean, visible: boolean, name: titleString, children: [layerEntry1, layerEntry2...]}. The children entry contains an array which may contain additional layer entries. Both the obj and visible are optional. See the layers sample for an example of how to use getLayersArray and setLayersArray.
Returns:
A promise that resolves to an array representing the layers in the PDF document
Type
Promise.<Array.<any>>
Returns an array containing the links on the specified page of the document.
Parameters:
Name Type Description
pageNumber number The page number, one-indexed, that the links are on.
Returns:
An array containing the links on the specified page of the document.
Type
Array.<string>

getMetadata()

Returns an object with metadata associated with the document.
Returns:
A promise that resolves to an object with document metadata
Type
Promise.<object>

getOfflineModeEnabled()

Returns whether offline mode is currently enabled or not.

getPageCount()

Returns the number of pages in a document.
Returns:
The number of the pages in the current document.
Type
number

getPageInfo(pageNumber)

Returns an object containing the width and height of a page.
Parameters:
Name Type Description
pageNumber number The page number of the requested page.
Returns:
An object representing the page info. Contains the properties "width" and "height".
Type
CoreControls.Document.PageInfo

getPageMatrix(pageNumber)

Returns an object representing the transformation matrix for the page.
Parameters:
Name Type Description
pageNumber number The page number of the requested page.
Returns:
An object representing the page matrix.
Type
object

getPageRotation(pageNumber)

Returns the internal degrees of rotation of a page.
Parameters:
Name Type Description
pageNumber number The page number of the requested page.
Returns:
The internal degrees of rotation of a page. (0, 90, 180 or 270)
Type
number

getPDFCoordinates(pageNumber, x, y)

Returns an object with the original x and y coordinates converted to PDF coordinates for the page.
Parameters:
Name Type Description
pageNumber number The page number that the coordinates are on
x number The x coordinate
y number The y coordinate
Returns:
An object with the x and y PDF coordinates
Type
object

getPDFDoc()

Returns the PDFNet.PDFDoc object associated with the document. Note that the full API is required to be enabled and WebViewer Server cannot be enabled.
Returns:
A promise that resolves to the PDFDoc object.
Type
Promise.<PDFNet.PDFDoc>

getPrintablePDF()

[PDFTron Server only] Provides a URL to a the PDF with annotations and watermarks merged, and an open action specifying that it should be printed.
Returns:
Will be null if not supported. Otherwise a promise that resolves to an object with a `url` property pointing to the printable PDF.
Type
Promise.<object> | null

getTextPosition(pageNumber, textStartIndex, textEndIndex)

Gets quads for each of the characters from start to end index.
Parameters:
Name Type Description
pageNumber number The page number that the text is on.
textStartIndex number The position where to start getting character quads from.
textEndIndex number The position (up to, but not including) where to finish getting characters.
Returns:
Resolves with quads, which is an array of objects with (x1,y1,x2,y2,x3,y3,x4,y4)
Type
Promise.<Array.<object>>

getType()

Gets the type of the document.
Returns:
The type of the document (xod, pdf, office, blackbox)
Type
string

getViewerCoordinates(pageNumber, x, y)

Returns an object with the original x and y PDF coordinates converted to Viewer coordinates for the page.
Parameters:
Name Type Description
pageNumber number The page number that the coordinates are on
x number The x coordinate
y number The y coordinate
Returns:
An object with the x and y Viewer coordinates
Type
object

getXODCoordinates(pageNumber, x, y)

Returns an object with the original x and y PDF coordinates converted to XOD coordinates for the page.
Parameters:
Name Type Description
pageNumber number The page number that the coordinates are on
x number The x coordinate
y number The y coordinate
Returns:
An object with the x and y XOD coordinates
Type
object

includesThumbnails()

Used to know if a document contains thumbnails.
Returns:
True if the document contains thumbnails.
Type
boolean

initOfflineDB()

[XOD Document only] Initializes the offline database for use. Must be called before any other offline mode functions are used.
Returns:
Resolves when offline database is ready for use.
Type
Promise.<void>

insertBlankPages(insertBeforeThesePages, width, height)

[PDF Document only] Inserts blank pages before the given list of pages. Both width and height are in units of PDF points.
Parameters:
Name Type Description
insertBeforeThesePages Array.<number> array of page numbers before which to insert blanks
width number width of the blank pages to insert. By default the width is 612 PDF points.
height number height of the blank pages to insert. By default the height is 792 PDF points.
Returns:
a promise that resolves to an object with info for any pages inserted
Type
Promise.<object>

insertPages(sourceDocument [, pageArray] [, insertBeforeThisPage])

[PDF Document only] Inserts a set of pages from the provided Document before a given page number. Note that this method will need to wait for the entire file to be downloaded before the change is applied.
Parameters:
Name Type Argument Description
sourceDocument CoreControls.Document other document from which to take pages (cannot be the same document)
pageArray Array.<number> <optional>
 An optional array of page numbers to extract from the given document. If not passed in, will insert all pages.
insertBeforeThisPage number <optional>
 An optional page number before which to insert the pages. If not passed in, will append to the end.
Returns:
a promise that resolves to an object describing the updated state of the pages in the document
Type
Promise.<object>

isDownloaded()

[XOD Document only] Whether the document has already been downloaded for offline mode or not.

isLinearized()

[PDF Document only] Returns whether the document is linearized or not. Note that this only works for documents that are loaded by URL and if useDownloader is not set to false.
Returns:
Whether the document is linearized or not
Type
boolean

isWebViewerServerDocument()

Gets whether the document will be interacted with as a WebViewer Server document This will return false if the document was loaded from WebViewer Server but forceClientSideInit is set to true
Returns:
Returns whether the document will be interacted with as a WebViewer Server document.
Type
boolean

loadAsync(partRetriever, callback, options)

Initialize a Document so that it can be used to load page canvases.
Parameters:
Name Type Description
partRetriever PartRetrievers.PartRetriever An instance of PartRetriever.
callback CoreControls.Document.LoadAsyncCallback
options an object that can contain the following optional parameters
Properties
Name Type Argument Description
workerTransportPromise Promise.<any> <optional>
 Required to load a PDF or Office file. A promise that will be resolved when a worker transport has been initialized. This can be created by calling CoreControls.initPDFWorkerTransports or CoreControls.initOfficeWorkerTransports as appropriate.
getPassword function <optional>
 A method of the form function(callback) where callback is of the form function(password). getPassword will be called when a password is required to load a PDF document and should call the callback with the retrieved password.
extension string <optional>
 An field used to specify the type of file being read. This is only relevant for PDF viewing and at the moment only works for certain image formats and .pdf
Returns:
Resolves when document is initialized, or rejects with error.
Type
Promise.<void>

loadCanvasAsync(options)

Loads a canvas for a particular page number.
Parameters:
Name Type Description
options Object An object specifying the options for loading the canvas. The following parameters should be properties on this object. The only non-optional parameter is pageNumber.
Properties
Name Type Argument Description
pageNumber number The page number of the requested canvas.
zoom number <optional>
 The zoom value to render the page at.
getZoom function <optional>
 A function that returns the zoom value to render the page at. Use this instead of "zoom" if the value might change in the process of setting up the canvas.
pageRotation CoreControls.PageRotation <optional>
 The rotation of the page. Valid values are CoreControls.PageRotation.E_0, CoreControls.PageRotation.E_90, CoreControls.PageRotation.E_180, CoreControls.PageRotation.E_270.
getPageRotation function <optional>
 A function that returns the rotation of the page. Use this instead of "pageRotation" if the value might change in the process of setting up the canvas.
finishedLoading function <optional>
 A callback called after the list of page resources is retrieved. Return true if rendering should continue, false otherwise.
acquireResources function <optional>
 A function that returns whether resources need to be acquired or not, defaults to true.
resourcesLoaded function <optional>
 A callback called after the page's resources have been loaded. Return true if rendering should continue, false otherwise.
getPageTransform function <optional>
 A function that returns the x and y values of the page's translation.
drawComplete function <optional>
 The callback to call when the canvas has been completely rendered. The first parameter is a canvas object, and the second parameter is the page number.
drawProgressive function <optional>
 The callback to call when the canvas has been partially rendered.
renderRect object <optional>
 An object with x1, y1, x2, y2 properties which is the partial rectangle to render of the entire page. The top left of the page is (0, 0).
useProgress boolean <optional>
 Whether progressive rendering should be used or not.
height number <optional>
 Used to calculate the zoom level if zoom level is not provided. If it's passed the zoom level will be set so the document fits this height. If both width and height are passed the zoom level will be set so the document fits the box delimited by them.
width number <optional>
 Used to calculate the zoom level if zoom level is not provided. If it's passed the zoom level will be set so the document fits this width. If both width and height are passed the zoom level will be set so the document fits the box delimited by them.
multiplier number <optional>
 The quality of the loaded canvas. Must be a positive number. Higher values are higher quality but take longer to complete and use more memory.
source string <optional>
 Indicate the origin of the call. This may be used by the Document's implementation of loadCanvasAsync.
Returns:
An id that can be passed to the corresponding Pause, Resume or Cancel functions
Type
number

loadPageText(pageNumber)

Gets all the text on the requested page.
Parameters:
Name Type Description
pageNumber number The page number that the text is on.
Returns:
A promise that resolves with the page's text.
Type
Promise.<string>

loadThumbnailAsync(pageNumber, onLoadThumbnail)

Loads a thumbnail image for a particular page.
Parameters:
Name Type Description
pageNumber number The page number of the requested thumbnail (1-indexed).
onLoadThumbnail function The callback to call when the thumbnail has been retrieved. Accepts an HTMLImageElement or HTMLCanvasElement as a parameter.
Returns:
The id of the request that can later be used for cancelling the request It is passed an image element if the .xod file contains thumbnails and a canvas element otherwise.
Type
number

mergeDocument(source [, position])

[PDF Document only] Merge a file into the currently opened document
Parameters:
Name Type Argument Description
source string | File | ArrayBuffer | Blob Source parameter, path/url to document or File.
position number <optional>
 Optional position for where to merge the document, default to end of file if nothing entered
Returns:
a promise that resolves on completion
Type
Promise.<any>

movePages(pageArray, insertBeforeThisPage)

[PDF Document only] Moves the pages given in an array so they appear in sequence before a given page number. Note that this method will need to wait for the entire file to be downloaded before the change is applied.
Parameters:
Name Type Description
pageArray Array.<number> the page numbers to move
insertBeforeThisPage number page number before which to insert the other pages
Returns:
a promise that resolves to an object describing the updated state of the pages in the document
Type
Promise.<object>

pauseLoadCanvas(id)

Pauses the loadCanvasAsync call corresponding to the passed in id
Parameters:
Name Type Description
id number The id returned from the loadCanvasAsync call that will be paused.

refreshTextData()

Refresh the text data stored by the viewer. Useful if the text content of the document has changed, e.g. after a redaction.

removePages(pageArray)

[PDF Document only] Removes the given page numbers. Note that this method will need to wait for the entire file to be downloaded before the change is applied.
Parameters:
Name Type Description
pageArray Array.<number> the page numbers to remove
Returns:
a promise that resolves to an object describing the updated state of the pages in the document
Type
Promise.<object>

requirePage(pageNumber)

[PDF Document only] Ensures that a particular page of the pdf document is finished loading before reading, writing or rendering it.
Parameters:
Name Type Description
pageNumber number The page number to ensure completion of loading
Returns:
a promise that resolves when the page has been loaded
Type
Promise.<void>

resumeLoadCanvas(id)

Resumes the loadCanvasAsync call corresponding to the passed in id
Parameters:
Name Type Description
id number The id returned from the loadCanvasAsync call that will be resumed.

rotatePages(pageArray, rotation)

[PDF Document only] Adds the given rotation to the given pages. Note that this method will need to wait for the entire file to be downloaded before the change is applied.
Parameters:
Name Type Description
pageArray Array.<number> an array of the numbers of pages to rotate
rotation CoreControls.PageRotation the page rotation to add
Returns:
a promise that resolves to an object describing the updated state of the pages in the document
Type
Promise.<object>

setLayersArray(layerContext)

[PDF Document only] Update the array describing the layers/OCG structure in order to adjust which layers should be enabled or disabled.
Parameters:
Name Type Description
layerContext Array.<any>
See:
  • getLayersArray

setOfflineModeEnabled(enabled)

[XOD Document only] Sets whether offline mode is enabled or not.
Parameters:
Name Type Description
enabled boolean The new value for whether offline mode is enabled or not.

setOverprintPreviewMode(mode)

[PDF Document only] Set the overprint preview mode to be used when rendering this document.
Parameters:
Name Type Description
mode The mode to use. Possible values are CoreControls.OverprintPreviewMode.OFF, CoreControls.OverprintPreviewMode.ON and CoreControls.OverprintPreviewMode.PDFX_ON

setWatermark(options)

Sets watermark to be added to the document
Parameters:
Name Type Description
options object Object that contains style/content of the watermark
Example
doc.setWatermark({
  diagonal: {
    fontSize: (number),
    fontFamily: (string),
    color: (string),
    opacity: (number (between 0 and 100)),
    text: (string)
  },
  header: {
    fontSize: (number),
    fontFamily: (string),
    color: (string),
    opacity: (number (between 0 and 100)),
    left: (string),
    center: (string),
    right: (string)
  },
  footer: {
    fontSize: (number),
    fontFamily: (string),
    color: (string),
    opacity: (number (between 0 and 100)),
    left: (string),
    center: (string),
    right: (string)
  }
  custom: (function(ctx, pageIndex, pageWidth, pageHeight))
});

To allow more customization of the header/footer, the following can be done:

doc.setWatermark({
diagonal: {
  fontSize: (number),
  fontFamily: (string),
  color: (string),
  opacity: (number (between 0 and 100)),
  text: (string)
},
headerLeft: {
  fontSize: (number),
  fontFamily: (string),
  color: (string),
  opacity: (number (between 0 and 100)),
  text: (string)
},
headerCenter: {
  fontSize: (number),
  fontFamily: (string),
  color: (string),
  opacity: (number (between 0 and 100)),
  text: (string)
},
headerRight: {
  fontSize: (number),
  fontFamily: (string),
  color: (string),
  opacity: (number (between 0 and 100)),
  text: (string)
},
footerLeft: {
  fontSize: (number),
  fontFamily: (string),
  color: (string),
  opacity: (number (between 0 and 100)),
  text: (string)
},
footerCenter: {
  fontSize: (number),
  fontFamily: (string),
  color: (string),
  opacity: (number (between 0 and 100)),
  text: (string)
},
footerRight: {
  fontSize: (number),
  fontFamily: (string),
  color: (string),
  opacity: (number (between 0 and 100)),
  text: (string)
},
custom: (function(ctx, pageIndex, pageWidth, pageHeight))
});

storeOffline(onComplete, onProgress)

[XOD Document only] Downloads the document for offline viewing.
Parameters:
Name Type Description
onComplete function The function that's called when the document has finished being downloaded or the download has been cancelled
onProgress function The function that's called on each update in progress of the download. The fraction downloaded is passed as a parameter. (eg 50% downloaded passes 0.5)

unloadCanvasResources(id)

Unloads resources for the page associated with the loadCanvasAsync call corresponding to the passed in id. So if the loadCanvasAsync call had requested page 2 then page 2's resources will be cleaned up (as long as nothing else requires those resources). Note that the canvas element itself is not touched.
Parameters:
Name Type Description
id number The id returned from the loadCanvasAsync call that will have it's page resources unloaded

unloadResources()

Cleans up the resources associated with the document.

Type Definitions

LoadAsyncCallback( [error])

The callback to call when the Document has been initialized. If there is an error then an error object will be passed to the callback function.
Parameters:
Name Type Argument Description
error Object <optional>
 The error that occurs when initializing the document

PageInfo

Type:
  • Object
Properties:
Name Type Description
width number The width of the page
height number The height of the page

XFDFInfo

Type:
  • Object
Properties:
Name Type Description
xfdfString string The XFDF string
pages Array.<number> Array of page numbers that annotations were extracted from

Events

colorSeparationAdded

Triggered when a color separation is loaded and available on the document.
Parameters:
Name Type Description
colorData object An object with properties of the color separation
Properties
Name Type Description
name string The name of the color separation
rgb Array.<any> An array containing the R, G and B values for the separation

layersUpdated

Triggered when a document's layers/OCG structures change visibility.
Parameters:
Name Type Description
layerContext Array.<any> array of page layers