Apryse WebViewer

Class: DocumentViewer

Core. DocumentViewer

A full-featured control for displaying documents, supporting text selection, text search, and multiple page view modes.

new DocumentViewer()

Creates a new empty DocumentViewer.
Properties:
Name Type Description
defaults object Default values for document viewer. Set FitMode, DisplayMode or Zoom.

Extends

Members

<static> Events

Properties:
Name Type Description
ACTIVE_SEARCH_RESULT_CHANGED string Core.DocumentViewer.activeSearchResultChanged
MOUSE_LEFT_UP string Core.DocumentViewer.mouseLeftUp
MOUSE_LEFT_DOWN string Core.DocumentViewer.mouseLeftDown
CLICK string Core.DocumentViewer.click
TAP string Core.DocumentViewer.tap
LONG_TAP string Core.DocumentViewer.longTap
DBL_CLICK string Core.DocumentViewer.dblClick
KEY_DOWN string Core.DocumentViewer.keyDown
KEY_UP string Core.DocumentViewer.keyUp
MOUSE_ENTER string Core.DocumentViewer.mouseEnter
MOUSE_MOVE string Core.DocumentViewer.mouseMove
MOUSE_LEAVE string Core.DocumentViewer.mouseLeave
MOUSE_RIGHT_DOWN string Core.DocumentViewer.mouseRightDown
MOUSE_RIGHT_UP string Core.DocumentViewer.mouseRightUp
DOCUMENT_UNLOADED string Core.DocumentViewer.documentUnloaded
ANNOTATIONS_LOADED string Core.DocumentViewer.annotationsLoaded
BEFORE_DOCUMENT_LOADED string Core.DocumentViewer.beforeDocumentLoaded
DOCUMENT_LOADED string Core.DocumentViewer.documentLoaded
DISPLAY_PAGE_LOCATION string Core.DocumentViewer.displayPageLocation
NOTIFY string Core.DocumentViewer#event:notify
SEARCH_IN_PROGRESS string Core.DocumentViewer.searchInProgress
TEXT_SELECTED string Core.DocumentViewer.textSelected
TOOL_MODE_UPDATED string Core.DocumentViewer.toolModeUpdated
FIT_MODE_UPDATED string Core.DocumentViewer.fitModeUpdated
ROTATION_UPDATED string Core.DocumentViewer.rotationUpdated
ZOOM_UPDATED string Core.DocumentViewer.zoomUpdated
PAGE_NUMBER_UPDATED string Core.DocumentViewer.pageNumberUpdated
PAGES_UPDATED string Core.DocumentViewer.pagesUpdated
PAGE_COMPLETE string Core.DocumentViewer.pageComplete
DISPLAY_MODE_UPDATED string Core.DocumentViewer.displayModeUpdated
BEGIN_RENDERING string Core.DocumentViewer.beginRendering
FINISHED_RENDERING string Core.DocumentViewer.finishedRendering
TOOL_UPDATED string Core.DocumentViewer.toolUpdated
SNAP_MODE_INITIALIZED string Core.DocumentViewer.snapModeInitialized
BEFORE_SNAP_MODE_INITIALIZED string Core.DocumentViewer.beforeSnapModeInitialized
EMBEDDED_POP_UP_MENU string Core.DocumentViewer.embeddedPopUpMenu
VISIBLE_PAGES_CHANGED string Core.DocumentViewer.visiblePagesChanged

FitMode

Contains a list of available fit modes for the DocumentViewer.
Properties:
Name Type Description
FitWidth function Zoom level is constrained such that the current page's width will exactly fill the available space.
FitPage function Zoom level is constrained such that the current page's width or height will exactly fill the available space.
Zoom function Zoom level is not constrained.

Methods

addEventListener(type, fn [, options])

Add a handler to the given event name
Parameters:
Name Type Argument Description
type string | number The name of the event to listen to
fn function The handler to be called when the event is triggered
options object <optional>
 Optional options object for addEventListener
Properties
Name Type Description
once boolean If true then the handler will be called only once
Inherited From:
Returns:
Returns the object that 'addEventListener' is being called on
Type
object
Example
myObject.addEventListener('eventName', (eventParameter1, eventParameter2) => {
  ...
});

addUserBookmark(pageIndex, text)

Adds a new user bookmark. If one exists, it will be updated.
Parameters:
Name Type Description
pageIndex Number The page index to bookmark.
text String The text associated identifying the bookmark.

clearSearchResults()

Clears all search results from the viewer

clearSelection()

Clears any selected text on all pages.

closeDocument()

Reinitializes data and clears the viewer area content.
Returns:
A promise that resolves when the document is finished closing.
Type
Promise.<void>

disableAlwaysPrintAnnotationsInColor()

Disables printing the annotations always in color.

disableAnnotations()

Disables annotations. Annotations in the document will not be visible.

disableArrowKeyNavigation()

Disable using the left/right arrow keys to switch pages.

disableAutomaticLinking()

Disable automatic linking. If disabled, then any URLs detected in the document text will not automatically be linked.

disableCompositionInput()

Disable composition input and revert to standard text input handling. This switches back to direct character input without composition event processing.
Example
instance.Core.documentViewer.disableCompositionInput();

disableGrayscaleAnnotationsMode()

Disables viewing annotations in grayscale.

disableGrayscaleMode()

Disable viewing document in Grayscale.

disableLoadingAnnotationsFromVisiblePages()

If loading annotations from visible pages was previously enabled, then calling this function will switch back to the default behavior.

disableMemoryRestrictedMode()

Disables the memory-restricted rendering mode and restores normal rendering limits.
Returns:
Type
void

disableReadOnlyMode()

Disables read-only mode in the viewer.

disableRightToLeftPageRendering()

Disable right to left page rendering order.

disableStylusMode()

Disables the stylus annotating mode for all annotation tools.

disableViewportRenderMode()

Disables viewport rendering mode.

displayAdditionalSearchResult(result)

Displays the new search result without clearing previous results.
Parameters:
Name Type Description
result object The result of a search, Core.Search.SearchResult Returned by onResult in Core.DocumentViewer#textSearchInit.

displayAdditionalSearchResults(results)

Displays the new search results without clearing previous results. If you need to display many results at the same time this can be much more efficient than calling displayAdditionalSearchResult for each result
Parameters:
Name Type Description
results Array.<object> An array of search results Core.Search.SearchResult. Returned by onResult in Core.DocumentViewer#textSearchInit.

displayBookmark(bookmark)

If the bookmark is an internal link then it scrolls the viewer so that the position of the bookmark is in the upper-left corner of the viewer. If it's an external URL then it opens the URL. If the bookmark is a JavaScript action then it executes the action.
Parameters:
Name Type Description
bookmark Core.Bookmark A bookmark that specifies the location to go to. Returned by Core.Document#getBookmarks.

displayFirstPage()

Scrolls the viewer so that the upper-left corner of the document's first page is in the upper-left corner of the viewer.

displayLastPage()

Scrolls the viewer so that the upper-left corner of the document's last page is in the upper-left corner of the viewer.

displayPageLocation(pageNumber, horizontalPosition, verticalPosition [, doNotJumpIfInView])

Shifts the current viewport of the viewer such that it can display the specified viewer coordinate position. Please refer to https://docs.apryse.com/documentation/web/guides/coordinates/#viewer-page-coordinates for more details.
Parameters:
Name Type Argument Description
pageNumber number The page number the location is on.
horizontalPosition number The horizontal position from the x-axis origin of the page (in viewer page coordinates).
verticalPosition number The vertical position from the y-axis of the page (in viewer page coordinates).
doNotJumpIfInView boolean <optional>
 If true, then if the page location is currently in view don't cause the viewer to shift.

displaySearchResult(result [, jump])

Scrolls the viewer so that the position of the search result is in the middle of the viewer.
Parameters:
Name Type Argument Description
result object The result of a search, Core.Search.SearchResult. Returned by onResult in Core.DocumentViewer#textSearchInit.
jump function <optional>
 The callback for navigating to the found result. This is optional and will jump to the correct location in the DocumentViewer if no parameter is passed.

dispose()

Disposes the current document's data.

downloadRemainingAnnotations()

DocumentViewer starts downloading annotations in the background page by page. Calling this function will cause it to immediately request all annotations that have not been downloaded yet which speeds up the annotation loading at the cost of some up front extra processing. Note that after calling this function the annotations will not have finished downloadeding yet. Use the getAnnotationsLoadedPromise function which resolves when all annotation have been downloaded.

drawSelection(pageNumber)

Draws the text selection for the specified page. Should be called after calling AnnotationManager's drawAnnotations function if the selection should still be shown.
Parameters:
Name Type Description
pageNumber number The page number to draw the selection on.

enableAlwaysPrintAnnotationsInColor()

Enables printing the annotations always in color. By default, if grayscale mode is enabled, annotations are printed in grayscale.

enableAnnotations()

Enables annotations. Any annotations in the document will be visible.

enableArrowKeyNavigation()

Enable using the left/right arrow keys to switch pages.

enableAutomaticLinking()

Enable automatic linking. If enabled, then any URLs detected in the document text will automatically be linked.

enableCompositionInput()

Enable composition input for handling complex text input methods (e.g., IME for Asian languages). This allows the editor to properly handle multi-character input sequences and composition events.
Example
instance.Core.documentViewer.enableCompositionInput();

enableGrayscaleAnnotationsMode()

Enables viewing annotations in grayscale.

enableGrayscaleMode()

Enable viewing document in Grayscale.

enableLoadingAnnotationsFromVisiblePages()

Enables annotations to only be loaded from the visible pages and removed when a page is no longer visible. Note that when enabling this option only annotations on the visible pages will be exported or included in the downloaded document.

enableMemoryRestrictedMode()

Enables a memory-restricted rendering mode optimized for constrained environments. Note: this mode is not supported in Spreadsheet Editor. This applies aggressive limits to canvas size/count, disables caching/viewport rendering, and caps zoom.
Returns:
Type
void

enableReadOnlyMode()

Enables read-only mode in the viewer. In this mode, no page manipulation features can be done from the thumbnail panel of the UI.

enableRightToLeftPageRendering()

Enable the right to left page rendering order.

enableStylusMode()

Puts all annotation tools in the stylus annotating mode. When in this mode, finger movements will scroll the document and using a stylus device will annotate the document.

enableViewportRenderMode()

Enables viewport rendering mode. This only renders the part of the page that is visible within the viewport.

getAccessibleReadingOrderManager()

Returns the AccessibleReadingOrderManager used by this DocumentViewer.
Returns:
An instance of AccessibleReadingOrderManager.
Type
Core.AccessibleReadingOrderManager

getActiveSearchResult()

Gets the currently active search result.
Returns:
SearchResult Core.Search.SearchResult.
Type
object

getAnnotationHistoryManager()

Returns the AnnotationHistoryManager used by this DocumentViewer.
Returns:
An instance of AnnotationHistoryManager.
Type
Core.AnnotationHistoryManager

getAnnotationManager()

Returns the AnnotationManager used by this DocumentViewer.
Returns:
An instance of AnnotationManager.
Type
Core.AnnotationManager

getAnnotationsLoadedPromise()

Gets a promise that resolves when the annotations in the current document have all been loaded.
Returns:
Promise that resolves when the annotations in the current document have loaded.
Type
Promise.<any>

getColorSeparationsAtPoint(pageNumber, x, y)

Gets the color separation values for the specified point. The x and y values should be in page coordinates.
Parameters:
Name Type Description
pageNumber number The page number of the point.
x number The x value of the point.
y number The y value of the point.
Returns:
A list of objects which each have the name of the separation and the saturation percentage of the color at the point [{ name, value }, ...].
Type
Array.<any>

getCompleteRotation(pageNumber)

Returns the complete rotation of the page including the document's rotation.
Parameters:
Name Type Description
pageNumber number The page number to get that page's rotation.
Returns:
The current complete rotation.
Type
Core.PageRotation

getContentEditHistoryManager()

Returns the ContentEditHistoryManager used by this DocumentViewer.
Returns:
An instance of ContentEditHistoryManager.
Type
Core.ContentEditHistoryManager

getContentEditManager()

Returns the ContentEditManager used by this DocumentViewer.
Returns:
An instance of ContentEditManager.
Type
Core.ContentEditManager

getCurrentPage()

Returns the current page number.
Returns:
The current 1-indexed page number.
Type
number

getCurrentSearchMode()

Returns the current search mode, controlling options such as case sensitivity and regex flags.
Returns:
currentMode Core.Search.Mode
Type
number

getDisplayModeManager()

Returns the DisplayModeManager used by this DocumentViewer.
Returns:
An instance of DisplayModeManager.
Type
Core.DisplayModeManager

getDocument()

Returns the Document that is currently being displayed by the viewer.
Returns:
Returns the current document.
Type
Core.Document

getExactViewportRegionRect(pageNumber)

Returns the exact viewport rendering region if viewport rendering is enabled.
Parameters:
Name Type Description
pageNumber number The page number.
Returns:
Returns the current viewport rendering region.
Type
object

getFitMode()

Returns the current fit mode.
Returns:
The current fit mode. Will be one of the properties from Core.DocumentViewer#FitMode.
Type
function

getMargin()

Returns a pixel value, representing the left, right, top and bottom margins.
Returns:
The margin value.
Type
number

getMeasurementManager()

Returns the MeasurementManager used by this DocumentViewer.
Returns:
An instance of MeasurementManager.
Type
Core.MeasurementManager

getPageCount()

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

getPageHeight(pageNumber)

Get the current height of the specified page, taking into account rotation.
Parameters:
Name Type Description
pageNumber number The page number.
Returns:
The height of the page.
Type
number

getPageRotations()

Gets the individual page rotations of the document. Only returns pages that have been rotated individually.
Returns:
An object with keys that are page indexes (1-indexed) and values that are rotation values.
Type
object

getPageSearchResults( [pageNumber])

Gets results of the current search.
Parameters:
Name Type Argument Description
pageNumber number <optional>
 The page number to return search hits from. If omitted, returns hits from all pages.
Returns:
Returns an array of Core.Search.SearchResult
Type
Array.<Core.Search.SearchResult>

getPageWidth(pageNumber)

Get the current width of the specified page, taking into account rotation.
Parameters:
Name Type Description
pageNumber number The page number.
Returns:
The width of the page.
Type
number

getPageZoom(pageNumber)

Gets the zoom value for a particular page.
Parameters:
Name Type Description
pageNumber number The page number.
Returns:
Returns page's zoom value.
Type
number

getPDFCoordinatesFromMouseEvent(event)

Get the PDF coordinates of the current mouse event.
Parameters:
Name Type Description
event MouseEvent A DOM mouse event.
Returns:
Returns an object with the x and y PDF coordinates of the mouse event.
Type
object

getRotation( [pageNumber])

Returns the current viewing rotation.
Parameters:
Name Type Argument Description
pageNumber number <optional>
 Optionally pass the page number to get the specific page's rotation.
Returns:
The current viewing rotation.
Type
Core.PageRotation
Example
PageRotation['E_0'] = 0 (0 degrees) <br/>
PageRotation['E_90'] = 1 (90 degrees) <br/>
PageRotation['E_180'] = 2 (180 degrees) <br/>
PageRotation['E_270'] = 3 (270 degrees) <br/>

getScrollViewElement()

Gets the scrollview element that is being used by DocumentViewer.
Returns:
The scrollview DOM element that DocumentViewer appends pages to.
Type
Element

getSelectedText( [pageNumber])

Returns the text selected by text selection tool or search.
Parameters:
Name Type Argument Description
pageNumber number <optional>
 Optionally pass the 1-indexed page number.
Returns:
Selected text.
Type
string

getSelectedTextQuads( [pageNumber])

Returns the quads of the text selected by text selection tool or search.
Parameters:
Name Type Argument Description
pageNumber number <optional>
 Optionally pass the 1-indexed page number.
Returns:
Selected text quads.
Type
object

getSpreadsheetEditorManager()

Returns the SpreadsheetEditorManager used by this DocumentViewer.
Returns:
An instance of SpreadsheetEditorManager.
Type
Core.SpreadsheetEditor.SpreadsheetEditorManager

getTextSelectionSensitivity()

Gets the current selection sensitivity value used for text selection detection. The selection sensitivity determines the minimum distance between the mouse pointer and the text selection rectangle required to initiate text selection.
Returns:
The current selection rectangle sensitivity value in pixels
Type
number
Example
```typescript
const threshold = documentViewer.getTextSelectionSensitivity();
console.log(`Current selection threshold: ${threshold}px`);
```

getTool(Name)

Returns a specific tool from the tool mode map.
Parameters:
Name Type Description
Name string | Core.Tools.ToolNames of the tool, e.g., 'AnnotationEdit'.
Returns:
The requested tool from the tool mode map.
Type
Core.Tools.Tool

getToolMode()

Returns the current tool.
Returns:
The current tool.
Type
Core.Tools.Tool

getToolModeMap()

Returns the tool mode map object.
Returns:
The tool mode map object.
Type
object

getUserBookmarks()

Gets the user bookmarks.
Returns:
An object with the bookmarked page indices as the key and associated title as the value.
Type
object

getViewerCoordinatesFromMouseEvent(event)

Gets the viewer page coordinates of the current mouse event.
Parameters:
Name Type Description
event MouseEvent A DOM mouse event.
Returns:
Returns an object with the x and y viewer coordinates of the mouse event.
Type
object

getViewerElement()

Gets the viewer element that is being used by DocumentViewer.
Returns:
The viewer DOM element that DocumentViewer appends pages to.
Type
Element

getViewportRegionRect(pageNumber)

Returns the current viewport rendering region if viewport rendering is enabled.
Parameters:
Name Type Description
pageNumber number The page number.
Returns:
Returns the current viewport rendering region.
Type
object

getWatermark()

Gets the watermark options that had been previously set.
Returns:
Returns a promise containing the watermark options.
Type
Promise.<object>

getZoomLevel()

Returns the current zoom level.
Returns:
The current zoom level.
Type
number

isAlwaysPrintAnnotationsInColorEnabled()

Returns whether always print annotations in color is enabled for printing the document.
Returns:
Whether print annotations in color is enabled or not.
Type
boolean

isAutomaticLinkingEnabled()

Returns whether add automatic link is enabled.
Returns:
Whether add automatic link is enabled.
Type
boolean

isCompositionActive()

Returns whether composition input is currently enabled. Composition input allows handling of complex text input methods such as IME for Asian languages.
Returns:
True if composition input is enabled, false otherwise
Type
boolean
Example
const isActive = instance.Core.documentViewer.isCompositionActive();
console.log('Composition input enabled:', isActive);

isGrayscaleAnnotationsModeEnabled()

Returns whether grayscale annotations mode is enabled for viewing the document.
Returns:
Whether grayscale annotation mode is enabled or not.
Type
boolean

isGrayscaleModeEnabled()

Returns whether grayscale mode is enabled for viewing the document.
Returns:
Whether grayscale mode is enabled or not.
Type
boolean

isInViewportRenderMode()

Returns a boolean to denote if viewer is in viewport rendering mode.
Returns:
The boolean to denote if in viewport render mode.
Type
boolean

isMemoryRestrictedModeEnabled()

Returns a boolean to denote if viewer is in memory restricted rendering mode.
Returns:
The boolean to denote if in memory restricted rendering mode.
Type
boolean

isRightToLeftPageRenderingEnabled()

Returns whether right to left page rendering is enabled.
Returns:
True if right to left page rendering is enabled, false otherwise.
Type
boolean

isStylusModeEnabled()

Returns whether stylus annotating mode is enabled.
Returns:
Returns whether stylus annotating mode is enabled.
Type
boolean

loadBlankOfficeEditorDocument()

Load a blank Word document for editing.

loadDocument(src [, options])

Initialize the viewer and load the given file into the viewer.
Parameters:
Name Type Argument Description
src string | File | ArrayBuffer | Blob | Core.Document | Core.PDFNet.PDFDoc Source parameter, path/URL to document or File.
options Core.LoadDocumentOptions <optional>
 Load document options.
Returns:
A promise that resolves when the document is finished loading.
Type
Promise.<void>

openURI(uri, isOpenInNewWindow)

Opens the given URI.
Parameters:
Name Type Description
uri string The URI to open.
isOpenInNewWindow boolean Whether to open the URI in a new window.

recalculateLayout(pagesToRecalculate)

Request a recalculation of page layout and rerender all pages. For use when modifying the underlying Document without using the provided page modification functions (cropPages, rotatePages...).
Parameters:
Name Type Description
pagesToRecalculate Array.<number> An array of page numbers (1-indexed) that should be recalculated.

refreshAll()

Invalidates the rendering cache for all pages and removes embedded thumbnails for viewer optimized PDF.

refreshPage(pageNumber)

Invalidates the rendering cache for the specified page.
Parameters:
Name Type Description
pageNumber number The page number of the page (1-indexed).

removeContent(removeData, rotationChanged, isZoomChanged)

Removes all the page content from the DOM. Also clear the cache if the zoom or rotation has changed.
Parameters:
Name Type Description
removeData boolean Whether or not to remove all event handlers and data on the elements.
rotationChanged boolean Whether rotation has changed.
isZoomChanged boolean Whether zoom has changed.

removeEventListener( [type] [, fn])

Remove a handler of the given event name and namespace (if given) or with a function reference
Parameters:
Name Type Argument Description
type string | number <optional>
 The name of the event to remove the handler of with an optional namespace.
fn function <optional>
 The handler associated with this event to be removed. If fn is undefined, all the handlers of the given event namespace will be removed. If you are not passing in this parameter then a namespace must be used with the event name.
Inherited From:
Returns:
Returns the object that 'removeEventListener' is being called on
Type
object
Example
myObject.removeEventListener('eventName.namespace');
myObject.removeEventListener('eventName', fn);

removeUserBookmark(pageIndex)

Removes a user bookmark.
Parameters:
Name Type Description
pageIndex Number The page index to remove.

replace(searchResults, replacement)

A simple text replace API that allows replacing text in the currently displayed document. Search results can be generated using the search or textSearchInit APIs.
Parameters:
Name Type Description
searchResults Array.<Core.Search.SearchResult> An array of search results containing the text to replace.
replacement string The text to replace the found text with.
Returns:
A promise that resolves when the replacement is complete.
Type
Promise.<void>
Example
// Search for text and replace first 50 results using streaming
const searchStream = documentViewer.search('old text');
const results = [];
let count = 0;

for await (const result of searchStream) {
  results.push(result);
  count++;
  if (count >= 50) break; // Stop after 50 results
}

// Replace the found results with new text
await documentViewer.replace(results, 'new text');
console.log(`Replaced ${results.length} occurrences`);

// Get all results at once and replace everything
const searchStream = documentViewer.search('error');
const allResults = await searchStream.getAll();
await documentViewer.replace(allResults, 'corrected');
console.log(`Replaced all ${allResults.length} occurrences of 'error' with 'corrected'`);

rotateClockwise( [pageNumber])

Rotates all pages in the currently displayed document clockwise by 90 degrees.
Parameters:
Name Type Argument Description
pageNumber number <optional>
 Optionally pass the page number to rotate only a specific page.

rotateCounterClockwise( [pageNumber])

Rotates all pages in the currently displayed document counter-clockwise by 90 degrees.
Parameters:
Name Type Argument Description
pageNumber number <optional>
 Optionally pass the page number to rotate only a specific page.

scrollViewUpdated()

This function must be called after modifying the scroll view element's dimensions or properties. The scroll view is the element returned from documentViewer.getScrollViewElement().
A streaming text search API that returns a ReadableStream of search results. This is useful for large documents where you want to process results incrementally using streams.
Parameters:
Name Type Argument Description
pattern string The text to search for.
modeOptions number | Array.<number> <optional>
 The search mode options from Core.Search.Mode, controlling options such as case sensitivity and search direction. Can be a single mode or an array of modes.
searchOptions object <optional>
 Additional search options.
Properties
Name Type Argument Description
startPage number <optional>
 Page to start the search on (1-indexed).
endPage number <optional>
 Page to end the search on inclusively (1-indexed).
See:
Returns:
A ReadableStream that yields search results with an added getAll() method.
Type
Core.Search.SearchStream
Example
// Process search results using for await (modern approach)
const searchStream = documentViewer.search('search term');
for await (const result of searchStream) {
  console.log('Found result:', result);
}

// Or get all results at once (efficient - uses the same search stream)
const searchStream = documentViewer.search('search term');
const allResults = await searchStream.getAll();
console.log('All results:', allResults);

// Note: getAll() can be called multiple times and will return the same cached results

select(pt1, pt2)

Selects the text content of the document given two page coordinates.
Parameters:
Name Type Description
pt1 Starting page coordinate. Requires properties x, y and pageNumber.
pt2 Ending page coordinate. Requires properties x, y and pageNumber.

setActiveSearchResult(result)

Sets the active search result, causing it to be displayed as a different color and visible on the screen.
Parameters:
Name Type Description
result object The result of a search, Core.Search.SearchResult. Returned by onResult in Core.DocumentViewer#textSearchInit.

setAnnotationImportOptions(options)

Sets the options that are used when importing annotations from a document asynchronously. These are the options that will be passed to AnnotationManager.importAnnotations.
Parameters:
Name Type Description
options object The options for importing.
Properties
Name Type Description
batchSize number The number of annotations to import in each batch.
batchDelay number The amount of time in milliseconds to delay between importing each batch.

setBookmarkIconShortcutVisibility(isEnabled)

Shows or hides the bookmark icon shortcuts on the top right corner of each page.
Parameters:
Name Type Description
isEnabled boolean Whether to show or hide the bookmark icon shortcuts.

setBookmarkShortcutToggleOffFunction(callback)

Accepts a function that runs when the bookmark icon shortcut on the top right corner of a page is toggled off.
Parameters:
Name Type Description
callback Core.DocumentViewer.onToggleOffBookmarkShortcut A callback function that takes a 0-index based as parameter that removes a bookmark from the bookmark icon shortcut.

setBookmarkShortcutToggleOnFunction(callback)

Accepts a function that runs when the bookmark icon shortcut on the top right corner of a page is toggled on.
Parameters:
Name Type Description
callback Core.DocumentViewer.onToggleOnBookmarkShortcut A callback function that takes a 0-index based as parameter that adds a bookmark from the bookmark icon shortcut.

setCurrentPage(pageNumber, isSmoothScroll)

Sets the current page. Updates the current page and jumps to it.
Parameters:
Name Type Description
pageNumber number The page number to jump to.
isSmoothScroll boolean If set to true, the viewer will scroll in a smooth way.

setDefaultPageColor(color)

Sets default background color for pages, default is white.
Parameters:
Name Type Description
color string Background color value.

setDocumentXFDFRetriever(retriever)

Sets the XFDF retriever that will be called when a document is being loaded. The XFDF returned from the retriever will be merged into the document. It is recommended to use this function instead of annotationManager.importAnnotations if you are loading XFDF from your server so that you don't need to wait for the annotationsLoaded event to be triggered. setDocumentXFDFRetriever will ensure that the annotation data is merged at the right time and as early as possible.
Parameters:
Name Type Description
retriever Core.DocumentViewer.DocumentXFDFRetriever | null A retriever function that returns a Promise which should resolve to the XFDF string that is going to be merged into the document.
Returns:
A promise that resolves when the retriever has been set.
Type
Promise.<void>
Example
instance.Core.documentViewer.setDocumentXFDFRetriever(async (documentId) => {
  const documentXFDFString = await fetchDocumentXFDFFromServer(documentId);
  return documentXFDFString;
})

setFitMode(fitMode)

Sets how the document will scale to fit the size of the scrollviewer's viewport. Also re-renders content to the appropriate zoom level. Only renders if a document has been loaded.
Parameters:
Name Type Description
fitMode function A fit mode property from Core.DocumentViewer#FitMode.

setInternalAnnotationsTransform(handler)

Allows you to transform (or replace) the internal annotations of the document. Note that to handle annotations using PDFNetJS without useDownloader: false you will also want to call setPagesUpdatedInternalAnnotationsTransform.
Parameters:
Name Type Description
handler function A handler function that takes annotation data as the first parameter and a callback that is called when the transformed data is ready as the second parameter.

setMargin(margin)

Sets the pixel value to use for the left, right, top and bottom margins.
Parameters:
Name Type Description
margin number The margin value to set.

setOpenURIHandler(openURIHandler)

Sets the open URI handler.
Parameters:
Name Type Description
openURIHandler function Function that takes in a URI and a boolean indicating whether to open in a new window.
Returns:
Type
void

setPageRotations(rotations)

Sets the individual page rotations of multiple pages at once. Pages that aren't specified will use the default document rotation.
Parameters:
Name Type Description
rotations object An object with keys that are page indexes (1-indexed) and values that are rotation values. Rotations should be specified as {Core.PageRotation}s.

setPagesUpdatedInternalAnnotationsTransform(handler)

Allows you to transform (or replace) the internal annotations of the document when pages receive an update event. This includes when using PDFNetJS with downloader enabled (default) on a linearized document. For completeness you will also want to call setInternalAnnotationsTransform.
Parameters:
Name Type Description
handler function A handler function that takes annotation data as the first parameter, an array of updated page numbers as a second parameter and a callback that is called when the transformed data is ready as a third parameter.

setPageVisibilityCallback(callback)

Sets the callback function that will be called when a page is newly visible in the viewer.
Parameters:
Name Type Description
callback function A function that takes in a page number indicating the page that is now visible.

setPageZoom(pageNumber, zoom)

Sets the zoom for a particular page. Should be followed by a call to updateView to actually render the page.
Parameters:
Name Type Description
pageNumber number The page number.
zoom number Zoom value for page.

setRotation(pageRotation [, pageNumber])

Sets the current viewing rotation.
Parameters:
Name Type Argument Description
pageRotation Core.PageRotation Desired viewing rotation.
pageNumber number <optional>
 Optionally pass the page number to set the specific page's rotation.

setScrollViewElement(scrollViewElement)

Sets the scrollview element that DocumentViewer will append rendered pages to.
Parameters:
Name Type Description
scrollViewElement Element The scrollview DOM element to be used.

setSearchHighlightColors(colorOptions)

Sets the color to use when highlighting text from searching.
Parameters:
Name Type Description
colorOptions object An object with searchResult or activeSearchResult properties set as a color, e.g., 'rgba(0, 0, 200, 0.5)'.
Example
documentViewer.setSearchHighlightColors({
  searchResult: 'rgba(255, 0, 0, 0.5)',
  activeSearchResult: 'rgba(0, 255, 0, 0.5)'
});

setSearchPageBatchSize(searchBatchSize)

[PDF Document only] Set the number of pages to search at a time. Searching more pages at a time will speed up searching but decrease page rendering responsiveness while a search is ongoing. Default is 50.
Parameters:
Name Type Description
searchBatchSize number The number of pages to search at a time

setTextHighlightColor(color)

Sets the color to use when highlighting text from text selection.
Parameters:
Name Type Description
color string The color to set, e.g., 'rgba(0, 0, 200, 0.3)'.

setTextSelectionSensitivity(sensitivity)

Sets the sensitivity value for text selection detection. This determines the minimum distance between the mouse pointer and the text selection rectangle required to initiate text selection. Setting a higher sensitivity value allows for more sensitive (less precise) text selection, while a lower value requires the mouse pointer to be closer to the text selection rectangle. The default value for this setting is 1 pixel.
Parameters:
Name Type Description
sensitivity The minimum threshold value for selection sensitivity in pixels
Returns:
void
Example
```typescript
documentViewer.setTextSelectionSensitivity(10);
```

setToolMode(tool)

Sets the tool mode. Also removes selection caused by text selection or search.
Parameters:
Name Type Description
tool Core.Tools.Tool An instance of the tool mode.

setUserBookmarks(newBookmarks)

Sets the user bookmarks.
Parameters:
Name Type Description
newBookmarks Object.<number, string> A map of bookmarked pages.

setViewerElement(viewerElement)

Sets the viewer element that DocumentViewer will append rendered pages to.
Parameters:
Name Type Description
viewerElement Element The viewer DOM element to be used.

setWatermark(options)

Sets watermark to be added to documents. Instead of an options object you can also pass a Promise that resolves with the watermark options object. If the document hasn't been loaded yet then DocumentViewer will wait to finish loading it until the watermark options are ready.
Parameters:
Name Type Description
options object Object that contains style/content of the watermark.
Properties
Name Type Argument Default Description
diagonal object <optional>
 Settings for a diagonal watermark.
Properties
Name Type Argument Default Description
text string <optional>
 The text content to be rendered as a diagonal watermark.
fontSize number <optional>
 20 The font size of the text, measured in pixels (px).
fontFamily string <optional>
 'sans-serif' The font type.
color string <optional>
 'black' The color of the text.
opacity number <optional>
 100 The percentage of opacity for the watermark.
header object <optional>
 Settings for a header watermark.
Properties
Name Type Argument Default Description
left string <optional>
 The text content to be rendered at the left side of the header.
center string <optional>
 The text content to be rendered at the center of the header.
right string <optional>
 The text content to be rendered at the right side of the header.
fontSize number <optional>
 20 The font size of the text, measured in pixels (px).
fontFamily string <optional>
 'sans-serif' The font type.
color string <optional>
 'black' The color of the text.
opacity number <optional>
 100 The percentage of opacity for the watermark.
footer object <optional>
 Settings for a footer watermark.
Properties
Name Type Argument Default Description
left string <optional>
 The text content to be rendered at the left side of the footer.
center string <optional>
 The text content to be rendered at the center of the footer.
right string <optional>
 The text content to be rendered at the right side of the footer.
fontSize number <optional>
 20 The font size of the text, measured in pixels (px).
fontFamily string <optional>
 'sans-serif' The font type.
color string <optional>
 'black' The color of the text.
opacity number <optional>
 100 The percentage of opacity for the watermark.
custom Core.DocumentViewer.CustomWatermarkCallback <optional>
 Function that is invoked for each page, to fully customize which page(s) have a watermark render, and how they should be rendered.
shouldDrawOverAnnotations boolean <optional>
 false Toggles if the watermark should be drawn over annotations.
Returns:
A promise that resolves when the watermark is set.
Type
Promise.<void>
Example
documentViewer.setWatermark({
  diagonal: {
    text: (string),
    fontSize: (number || 20),
    fontFamily: (string || 'sans-serif'),
    color: (string || 'black'),
    opacity: (number || 100)
  },
  header: {
    left: (string),
    center: (string),
    right: (string),
    fontSize: (number || 20),
    fontFamily: (string || 'sans-serif'),
    color: (string || 'black'),
    opacity: (number || 100)
  },
  footer: {
    left: (string)
    center: (string),
    right: (string),
    fontSize: (number || 20),
    fontFamily: (string || 'sans-serif'),
    color: (string || 'black'),
    opacity: (number || 100),
  },
  custom: (function(ctx, pageIndex, pageWidth, pageHeight)),
  shouldDrawOverAnnotations: (boolean || false)
});

setWatermarkRenderQuality(multiplier)

Sets the render quality multiplier for watermark rasterization when embedded printing or downloading. This setting does not affect how the watermark appears in the viewer — it only applies to printed or downloaded output.
Parameters:
Name Type Description
multiplier number A scaling factor for the internal canvas used in watermark rendering. For example, 2 doubles the resolution. Must be between 1 and 10. The default value is 1, which means no scaling.

snapToNearest(pageNumber, x, y [, modeOptions])

Returns the path coordinate within the page that is closest to the queried point.
Parameters:
Name Type Argument Description
pageNumber number The page number the point is on.
x number The x position to calculate the snap point from.
y number The y position to calculate the snap point from.
modeOptions number | Array.<number> <optional>
 Array of mode values from the enum for optional snapping modes.
Returns:
A promise that resolves to the SnapData object.
Type
Promise.<Core.DocumentViewer.SnapData>

startSemanticDiff(documentViewer [, options])

Compare the text of documents on both DocumentViewers and add annotations to mark the differences.
Parameters:
Name Type Argument Description
documentViewer Core.DocumentViewer Other documentViewer to diff with.
options object <optional>
 Configuration options.
Properties
Name Type Argument Default Description
beforeColor Core.Annotations.Color <optional>
 { R: 255, G: 73, B: 73, A: 0.4 } Color for the highlight annotations on the before document.
afterColor Core.Annotations.Color <optional>
 { R: 21, G: 205, B: 131, A: 0.4 } Color for the highlight annotations on the after document.
extraMoveHighlight boolean <optional>
 false Whether to highlight text in between short-distance moves.
Returns:
Returns an object with the following properties { doc1Annotations, doc2Annotations, diffCount }.
Type
Promise.<object>

stopPageRender(pageNumber)

Stops the rendering of the specified page.
Parameters:
Name Type Description
pageNumber number The number of the page whose rendering should be stopped.

stopSemanticDiff()

Remove the annotations that mark the differences. This method can be invoked in either of the documentViewer in semantic comparing mode.
Returns:
A promise that resolves when the semantic diff is stopped.
Type
Promise.<void>

textSearchInit(pattern [, modeOptions] [, searchOptions])

Searches for a particular text string on the currently displayed Document, starting on the current page unless otherwise specified.
Parameters:
Name Type Argument Description
pattern string The text to search for.
modeOptions number | Array.<number> <optional>
 The search mode options from Core.Search.Mode, controlling options such as case sensitivity and search direction.
searchOptions object <optional>
 An object that can contain the following optional parameters
Properties
Name Type Argument Description
fullSearch boolean <optional>
 If true, a search of the entire document will be performed. Otherwise, a single search will be performed.
onResult function <optional>
 (result) The callback function that is called when the search returns a result.
onPageEnd function <optional>
 (result) The callback function that is called when reaching the end of the page (if using page_stop mode).
onDocumentEnd function <optional>
 () The callback function that is called when reaching the end of the document.
onError function <optional>
 (result) The callback function that is called when search failed or regex has syntax error.
startPage number <optional>
 Page to start the search on (1-indexed).
endPage number <optional>
 Page to end the search on inclusively (1-indexed). The search may complete when the search term is found, when the entire document has been searched, and, depending on the search options, at the end of every page.
See:

trigger(type [, data])

Calls the handlers of the event name with given data
Parameters:
Name Type Argument Description
type string | number event name of which the handlers will be called.
data * <optional>
 data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers
Inherited From:
Returns:
Returns the object that 'trigger' is being called on
Type
object
Example
myObject.trigger('eventName');
myObject.trigger('eventName', [eventParameter1, eventParameter2]);

triggerAsync(type [, data])

Calls the handlers of the event name with given data *asynchronously*. It's different from Core.EventHandler#trigger in that it can be awaited to ensure all async handlers have finished executing code
Parameters:
Name Type Argument Description
type string | number event name of which the handlers will be called.
data * <optional>
 data that will be passed to the handlers. If data is an array, it will be spread and then passed to the handlers
Inherited From:
Returns:
Returns the object that 'triggerAsync' is being called on
Type
Promise.<Object>
Example
myObject.triggerAsync('eventName');
myObject.triggerAsync('eventName', [eventParameter1, eventParameter2]);

unmount()

Unmount the documentViewer from the DOM and clean up any related events and resources.
Updates old xod (version <= 1.2) link annotations in the annotationManager.
Parameters:
Name Type Description
pageNumber number The 1-indexed page number to update.

updateView( [visiblePages] [, currentPageNumber])

Removes previously drawn pages that are no longer visible and draws pages that are visible and have not been drawn. If visiblePages are provided then those pages are rendered otherwise visiblePages are calculated depending on where the DIV elements for the pages are located.
Parameters:
Name Type Argument Description
visiblePages Array.<number> <optional>
 An array of integers representing the pages to render.
currentPageNumber number <optional>
 The number of the page that is currently visible in the viewer.

updateVisiblePages( [visiblePages])

Notifies the document viewer that the visible pages have changed but does not draw any pages.
Parameters:
Name Type Argument Description
visiblePages Array.<number> <optional>
 An array of integers representing the pages to render.

zoomTo(zoom [, x] [, y])

Adjusts the viewer's zoom factor, and positions the point (x,y) at the upper left corner of the viewer. Only renders if a document has been loaded.
Parameters:
Name Type Argument Description
zoom number Zoom value.
x number <optional>
 Horizontal position to scroll to.
y number <optional>
 Vertical position to scroll to.

zoomToMouse(zoom, offsetX, offsetY [, event])

Adjusts the viewer's zoom factor and positions the point on the document under the mouse at the same position after zooming in.
Parameters:
Name Type Argument Description
zoom number Zoom value.
offsetX number The x offset from the mouse position to the viewer's position (e.g. taking into account toolbars).
offsetY number The y offset from the mouse position to the viewer's position (e.g. taking into side panels).
event MouseEvent <optional>
 A DOM mouse event. If used then the mouse will be zoomed to the location of where this event originated.

Type Definitions

CustomWatermarkCallback(ctx, pageIndex, pageWidth, pageHeight)

Parameters:
Name Type Description
ctx CanvasRenderingContext2D The Canvas Context that determines how the watermark will be rendered. Edit the text styles attributes to change the rendering styling.
pageIndex number The index of the current page.
pageWidth number The width of the current page.
pageHeight number The height of the current page.

DocumentXFDFRetriever(docId)

Parameters:
Name Type Description
docId string The ID of the document that is being loaded.
Returns:
A promise that resolves to an XFDF string, or an array of XFDF commands.
Type
Promise.<(string|Array.<string>)>

embeddedPopUpMenuData

Type:
  • Object
Properties:
Name Type Description
popUpMenuItems Array.<(string|Array.<string>)> An array where each element is a string corresponding to a menu item, or an Array meant for rendering a separate sub-menu.
fieldName string The name of the field where the popUpMenu API was called.
onSelect function Function that accepts the user's chosen selection in the popUpMenu as a parameter, and resolves the promise instantiated when popUpMenu was called.

onToggleOffBookmarkShortcut(pageIndex)

Parameters:
Name Type Description
pageIndex number A parameter for the 0-index based page number
Returns:
Type
void

onToggleOnBookmarkShortcut(pageIndex)

Parameters:
Name Type Description
pageIndex number A parameter for the 0-index based page number
Returns:
Type
void

pagesUpdatedChanges

Type:
  • Object
Properties:
Name Type Description
added Array.<number> Array of page numbers that were added.
removed Array.<number> Array of page numbers that were removed.
moved Object An object mapping page number changes. E.g. if Page 2 was moved to now be page 3 it would be: { 2: 3, 3: 2 }.
contentChanged Array.<number> Array of page numbers that had their content change.
annotationsChanged Array.<number> Array of page numbers that had their annotations change.
rotationChanged Array.<number> Array of page numbers that had their rotation change.
linearizedUpdate boolean Boolean representing whether this page update was from the initial download of the file when the proper page sizes are loaded. This will only happen for linearized PDFs.

SnapData

Type:
  • Object
Properties:
Name Type Description
x number The x position of the nearest point.
y number The y position of the nearest point.
mode number The effective mode that was used to find this snap point.
modeName string The name of the effective mode that was used to find this snap point.

Events

activeSearchResultChanged

Triggered when the active search result has changed.
Parameters:
Name Type Description
result object The new active search result, Core.Search.SearchResult.

annotationsLoaded

Triggered when all the annotations embedded in the document have been loaded.

beforeDocumentLoaded

Triggered just before the document has been loaded into the viewer.

beforeSnapModeInitialized

Triggered when tool.setSnapMode() gets called the first time with a loaded document, or when a new document is loaded with a snap mode set on the active tool.

beginRendering

Triggered when DocumentViewer starts rendering pages.

click

Triggered for the click event in the DocumentViewer's viewing area.
Parameters:
Name Type Description
nativeEvt object Event object of the native JavaScript event.

compareAnnotationsLoaded

Triggered when Core.DocumentViewer.startSemanticDiff is called.
Parameters:
Name Type Description
doc1Annotations object Highlight annotations marking the difference on the first document.
doc2Annotations object Highlight annotations marking the difference on the second document.
diffCount object The number of differences between the two documents.

dblClick

Triggered for the dblClick event in the DocumentViewer's viewing area.
Parameters:
Name Type Description
nativeEvt object Event object of the native JavaScript event.

displayModeUpdated

Triggered when the display mode is updated.
Returns:
The new display mode of the viewer.
Type
Core.VirtualDisplayMode

displayPageLocation

Triggered when a page location should be displayed.
Parameters:
Name Type Description
pageNum number The 1-indexed page number.
verticalOffset number The offset from the top of the page.
horizontalOffset number The offset from the left of the page.

documentLoaded

Triggered when a new document has been loaded.

documentUnloaded

Triggered when the current document has been closed and unloaded.

embeddedPopUpMenu

Triggered when a Widget is clicked that triggers the Embedded JavaScript popUpMenu API.
Parameters:
Name Type Description
popUpMenuData Core.DocumentViewer.embeddedPopUpMenuData Data provided from the Embedded JavaScript popUpMenu API being called.

embeddedThumbnailComplete

Triggered when an embedded thumbnail of a viewer-optimized pdf is completely loaded.
Parameters:
Name Type Description
pageNum number The 1-indexed page number.

finishedRendering

Triggered when DocumentViewer finishes rendering pages.

fitModeUpdated

Triggered when the fit mode has changed.
Parameters:
Name Type Description
fitMode object The fit mode that has been changed to e.g. documentViewer.FitMode.FitWidth.

keyDown

Triggered for the keyDown event in the DocumentViewer's viewing area.
Parameters:
Name Type Description
nativeEvt object Event object of the native JavaScript event.

keyUp

Triggered for the keyUp event in the DocumentViewer's viewing area.
Parameters:
Name Type Description
nativeEvt object Event object of the native JavaScript event.

longTap

Triggered on mobile when there is a long tap in the DocumentViewer's viewing area. This is the equivalent of the desktop right click. Long taps are defined as pressing a mouse and holding it down for 500ms before releasing it. If e.preventDefault() is called, the currently selected tool won't get activated. Use this to provide your custom handling of this event, for example adding a menu after a long tap.
Parameters:
Name Type Description
nativeEvt object Event object of the native JavaScript event.

mouseEnter

Triggered for the mouseEnter event in the DocumentViewer's viewing area.
Parameters:
Name Type Description
nativeEvt object Event object of the native JavaScript event.

mouseLeave

Triggered for the mouseLeave event in the DocumentViewer's viewing area.
Parameters:
Name Type Description
nativeEvt object Event object of the native JavaScript event.

mouseLeftDown

Triggered for the mouseLeftButtonDown event in the DocumentViewer's viewing area. Attach like documentViewer.addEventListener('mouseLeftDown', callback).
Parameters:
Name Type Description
nativeEvt object Event object of the native JavaScript event.

mouseLeftUp

Triggered for the mouseLeftButtonUp event in the DocumentViewer's viewing area.
Parameters:
Name Type Description
nativeEvt object Event object of the native JavaScript event.

mouseMove

Triggered for the mouseMove event in the DocumentViewer's viewing area.
Parameters:
Name Type Description
nativeEvt object Event object of the native JavaScript event.

mouseRightDown

Triggered for the mouseRightButtonDown event in the DocumentViewer's viewing area.
Parameters:
Name Type Description
nativeEvt object Event object of the native JavaScript event.

mouseRightUp

Triggered for the mouseRightButtonUp event in the DocumentViewer's viewing area.
Parameters:
Name Type Description
nativeEvt object Event object of the native JavaScript event.

notify

Triggered when there is a notification relating to searching or annotation permissions.
Parameters:
Name Type Description
type string The type of notification that has occurred.

pageComplete

Triggered when a page has been completely rendered.
Parameters:
Name Type Description
pageNum number The 1-indexed page number.
canvas HTMLCanvasElement The canvas for the page.

pageNumberUpdated

Triggered when the page number is updated.
Parameters:
Name Type Description
pageNumber number The new page number (1-indexed).

pagesUpdated

Triggered when the layout has changed because pages have permanently been added, removed, moved or changed in some other way.
Parameters:
Name Type Description
changes Core.DocumentViewer.pagesUpdatedChanges An object with keys added, removed, moved and contentChanged, indicating which pages have changed.

rotationUpdated

When the viewer temporary page rotation has changed. This event is not fired if the page is permanently rotated through doc.rotatePages.
Parameters:
Name Type Argument Description
rotation Core.PageRotation The new viewing rotation.
pageNumber number <optional>
 Optionally the specific page number that had its rotation changed.

searchInProgress

Triggered when a search starts or ends. When Core.DocumentViewer#clearSearchResults is executed searchInProgress event is triggered with both inProgress and isFullSearch arguments to be undefined. This can be used to differentiate the search that hasn’t been started versus the search that was done.
Parameters:
Name Type Description
inProgress boolean Whether a search is in progress or not.
isFullSearch boolean Whether this is a full text search or not.

searchResultsChanged

Triggered when the search results list has changed.
Parameters:
Name Type Description
results Array.<object> The new search results, Core.Search.SearchResult.

snapModeInitialized

Triggered when snap mode has successfully finished initializing.

tap

Triggered when there is a tap in the DocumentViewer's viewing area. Taps are defined as a mouse down and up within a short time period and within a short distance.
Parameters:
Name Type Description
nativeEvt object Event object of the native JavaScript event.

textSelected

Triggered when the selected text has changed.
Parameters:
Name Type Description
quads Array.<Core.Math.Quad> An array of bounding box quads of the selected text.
text string The selected text.
pageNumber number The page number that the text was selected on.

toolModeUpdated

Triggered when the tool mode has changed.
Parameters:
Name Type Description
newToolObject object The tool object that has been changed to.
oldToolObject object The tool object that has been changed from.

toolUpdated

Triggered when the tool styles or tool name have changed.
Parameters:
Name Type Description
toolModeClass object The tool object that has been changed.

userBookmarksChanged

Triggered when user bookmarks have been changed.
Parameters:
Name Type Description
current Object.<number, string> An object map with the bookmarked page numbers as keys and their associated text as values.
eventInfo object An object containing event details.
Properties
Name Type Description
added Array.<number> An array of page numbers that were added.
updated Array.<number> An array of page numbers that were updated.
removed Array.<number> An array of page numbers that were removed.

visiblePagesChanged

Triggered when the visible pages have changed.
Parameters:
Name Type Description
visiblePages Array.<number> An array of page numbers (1-indexed) that are visible.

zoomUpdated

Triggered when the zoom level has been updated.
Parameters:
Name Type Description
zoom number The new zoom level of the viewer.