API for React Native PDF viewer

Apryse React Native now has support for TypeScript. Since not all customers use the language, the typings used in this document will be described using normal JavaScript types. For TypeScript users, type information is automatically provided while coding. They can also be found in our TypeScript source files.

RNPdftron contains static methods for global library initialization, configuration, and utility methods.

Initializes Apryse SDK with your Apryse commercial license key. You can run Apryse in demo mode by passing an empty string.

Parameters:

ScriptRNPdftron.initialize('your_license_key');

Enables JavaScript for Apryse SDK, by default it is enabled.

Parameters:

ScriptRNPdftron.enableJavaScript(true);

Gets the current PDFNet version.

Returns a Promise.

Promise Parameters:

1RNPdftron.getVersion().then((version) => {
2  console.log("Current PDFNet version:", version);
3});

Gets the version of current platform (Android/iOS).

Returns a Promise.

Promise Parameters:

1RNPdftron.getPlatformVersion().then((platformVersion) => {
2  console.log("App currently running on:", platformVersion);
3});

Gets the font list available on the OS (Android only). This is typically useful when you are mostly working with non-ASCII characters in the viewer.

Returns a Promise.

Promise Parameters:

1RNPdftron.getSystemFontList().then((fontList) => {
2  console.log("OS font list:", fontList);
3});

Clear the information and bitmap cache for rubber stamps (Android only). This is typically useful when the content of rubber stamps has been changed in the viewer.

Returns a promise.

1RNPdftron.clearRubberStampCache().then(() => {
2  console.log("Rubber stamp cache cleared");
3});

Encrypts (password-protects) a document. Note: This function does not lock the document and cannot be used while the document is opened in the viewer.

Parameters:

Returns a promise.

Example:

1RNPdftron.encryptDocument("/sdcard/Download/new.pdf", "1111", "").then(() => {
2  console.log("done password");
3});

Generates a PDF using a template in the form of an Office document and replacement data in the form of a JSON object. For more information please see our template guide.

Parameters:

Returns a Promise.

Promise Parameters:

The user is responsible for cleaning up the temporary file that is generated.

Example:

1RNPdftron.pdfFromOfficeTemplate("/sdcard/Download/red.docx", json).then((resultPdfPath) => {
2  console.log(resultPdfPath);
3});

A React component for displaying documents of different types such as PDF, docx, pptx, xlsx and various image formats.

string, required

The path or url to the document.

Example:

1<DocumentView
2  document={'https://pdftron.s3.amazonaws.com/downloads/pl/PDFTRON_about.pdf'}
3/>

string, optional

The password of the document, if any.

Example:

1<DocumentView
2  password={'password'}
3/>

bool, optional, defaults to false

If true, document prop will be treated as a base64 string. If it is not the base64 string of a pdf file, base64FileExtension is required.

When viewing a document initialized with a base64 string (i.e. a memory buffer), a temporary file is created on Android and iOS.

1<DocumentView
2  isBase64String={true}
3  document={'...'} // base 64 string
4/>

string, required if using base64 string of a non-pdf file, defaults to ".pdf"

The file extension for the base64 string in document, if isBase64String is true.

1<DocumentView
2  isBase64String={true}
3  document={'...'} // base 64 string
4  base64FileExtension={'.jpeg'}
5/>

object, optional

Defines custom headers to use with HTTP/HTTPS requests.

1<DocumentView
2  isBase64String={true}
3  document={'...'} // base 64 string
4/>

bool, optional, defaults to false

Defines whether the viewer is read-only. If true, the UI will not allow the user to change the document.

1<DocumentView
2  readOnly={true}
3/>

function, optional

This function is called when the document finishes loading.

1<DocumentView
2  onDocumentLoaded = {(path) => { 
3    console.log('The document has finished loading:', path); 
4  }}
5/>

function, optional

This function is called when document opening encounters an error.

1<DocumentView
2  onDocumentError = {(error) => { 
3    console.log('Error occured during document opening:', error); 
4  }}
5/>

array of string, optional, defaults to none

Defines buttons to be disabled for the viewer. Strings should be Config.Buttons constants.

1<DocumentView
2  disabledElements={[Config.Buttons.userBookmarkListButton]}
3/>

array of string, optional, defaults to none

Defines tools to be disabled for the viewer. Strings should be Config.Tools constants.

1<DocumentView
2  disabledTools={[Config.Tools.annotationCreateLine, Config.Tools.annotationCreateRectangle]}
3/>

function, optional

This function is called when the current tool changes to a new tool

Parameters:

1<DocumentView
2  onToolChanged = {({previousTool, tool}) => {
3    console.log('Tool has been changed from', previousTool, 'to', tool);
4  }}
5/>

string, optional

The file name of the icon to be used for the leading navigation button. The button will use the specified icon if it is valid, and the default icon otherwise.

Example:

1<DocumentView
2  leadingNavButtonIcon={Platform.OS === 'ios' ? 'ic_close_black_24px.png' : 'ic_arrow_back_white_24dp'}
3/>

Note: to add the image file to your application, please follow the steps below:

1. Android

Add the image resource to the drawable directory in example/android/app/src/main/res. For details about supported file types and potential compression, check out this guide.

2. Now you can use the image in the viewer. For example, if you add button_close.png to drawable, you could use 'button_close' in leadingNavButtonIcon.

iOS

1. After pods has been installed, open the .xcworkspace file for this application in Xcode (in this case, it's example.xcworkspace), and navigate through the list below. This would allow you to add resources, in this case, an image, to your project.

• "Project navigator"
• "example" (or the app name)
• "Build Phases"
• "Copy Bundle Resources"
• "+".

2. Now you can use the image in the viewer. For example, if you add button_open.png to the bundle, you could use 'button_open.png' in leadingNavButtonIcon.

bool, optional, defaults to true

Defines whether to show the leading navigation button.

1<DocumentView
2  showLeadingNavButton={true}
3/>

function, optional

This function is called when the leading navigation button is pressed.

1<DocumentView
2  onLeadingNavButtonPressed = {() => {
3    console.log('The leading nav has been pressed');
4  }}
5/>

bool, optional, defaults to true

Defines whether the document slider of the viewer is enabled.

1<DocumentView
2  documentSliderEnabled={false}
3/>

array of string, optional, defaults to none.

Defines view mode items to be hidden in the view mode dialog. Strings should be Config.ViewModePickerItem constants.

1<DocumentView
2  hideViewModeItems={[
3    Config.ViewModePickerItem.Crop,
4    Config.ViewModePickerItem.Rotation,
5    Config.ViewModePickerItem.ColorMode
6  ]}
7/>

bool, optional, defaults to true

Deprecated. Use hideTopAppNavBar prop instead.

bool, optional, defaults to true

Defines whether the bottom toolbar of the viewer is enabled.

1<DocumentView
2  bottomToolbarEnabled={false}
3/>

array of objects, options (one of Config.DefaultToolbars constants or custom toolbar object)

Defines custom toolbars. If passed in, the default toolbars will no longer appear. It is possible to mix and match with default toolbars. See example below:

1const myToolbar = {
2  [Config.CustomToolbarKey.Id]: 'myToolbar',
3  [Config.CustomToolbarKey.Name]: 'myToolbar', 
4  [Config.CustomToolbarKey.Icon]: Config.ToolbarIcons.FillAndSign,
5  [Config.CustomToolbarKey.Items]: [Config.Tools.annotationCreateArrow, Config.Tools.annotationCreateCallout, Config.Buttons.undo]
6};
7...
8<DocumentView
9  annotationToolbars={[Config.DefaultToolbars.Annotate, myToolbar]}
10/>

array of strings, optional, defaults to none

Defines which default annotation toolbars should be hidden. Note that this prop should be used when annotationToolbars is not defined. Strings should be Config.DefaultToolbars constants.

1<DocumentView
2  hideDefaultAnnotationToolbars={[Config.DefaultToolbars.Annotate, Config.DefaultToolbars.Favorite]}
3/>

bool, optional, defaults to false

Defines whether to show the toolbar switcher in the top toolbar.

1<DocumentView
2  hideAnnotationToolbarSwitcher={false}
3/>

bool, optional, defaults to false

Defines whether to hide both the top app nav bar and the annotation toolbar.

1<DocumentView
2  hideTopToolbars={false}
3/>

bool, optional, defaults to false

Defines whether to hide the top navigation app bar.

1<DocumentView
2  hideTopAppNavBar={true}
3/>

bool, optional, defaults to true

Defines whether an unhandled tap in the viewer should toggle the visibility of the top and bottom toolbars. When false, the top and bottom toolbar visibility will not be toggled and the page content will fit between the bars, if any.

1<DocumentView
2  hideToolbarsOnTap={false}
3/>

array of strings, optional, iOS only

Customizes the right bar section of the top app nav bar. If passed in, the default right bar section will not be used. Strings should be Config.Buttons constants.

1<DocumentView
2  topAppNavBarRightBar={[Config.Buttons.reflowButton, Config.Buttons.outlineListButton]}
3/>

array of strings, optional, only the outline list, thumbnail list, share, view mode, search, and reflow buttons are supported on Android

Defines a custom bottom toolbar. If passed in, the default bottom toolbar will not be used. Strings should be Config.Buttons constants.

1<DocumentView
2  bottomToolbar={[Config.Buttons.reflowButton, Config.Buttons.outlineListButton]}
3/>

bool, optional, defaults to false, Android only

Defines whether the viewer will add padding to take account of the system status bar.

1<DocumentView
2  padStatusBar={true}
3/>

string, optional, default value is 'FitWidth'

Defines the fit mode (default zoom level) of the viewer. String should be one of Config.FitMode constants.

1<DocumentView
2  fitMode={Config.FitMode.FitPage}
3/>

string, optional, default value is 'Continuous'

Defines the layout mode of the viewer. String should be one of Config.LayoutMode constants.

1<DocumentView
2  layoutMode={Config.LayoutMode.FacingContinuous}
3/>

function, optional

This function is called when the layout of the viewer has been changed.

1<DocumentView
2  onLayoutChanged = {() => {
3    console.log('Layout has been updated.');
4  }}
5/>

number, optional

Defines the initial page number that viewer displays when the document is opened. Note that page numbers are 1-indexed.

1<DocumentView
2  initialPageNumber={5}
3/>

number, optional

Defines the currently displayed page number. Different from initialPageNumber, changing this prop value at runtime will change the page accordingly.

1<DocumentView
2  pageNumber={5}
3/>

bool, optional, defaults to true

Defines whether the viewer should change pages when the user taps the edge of a page, when the viewer is in a horizontal viewing mode.

1<DocumentView
2  pageChangeOnTap={true}
3/>

bool, optional, defaults to true

Defines whether to show the page indicator for the viewer.

1<DocumentView
2  pageIndicatorEnabled={true}
3/>

bool, optional, defaults to true, iOS only

Defines whether the keyboard shortcuts of the viewer are enabled.

1<DocumentView
2  keyboardShortcutsEnabled={false}
3/>

function, optional

This function is called when the page number has been changed.

Parameters:

1<DocumentView
2  onPageChanged = {({previousPageNumber, pageNumber}) => {
3    console.log('Page number changes from', previousPageNumber, 'to', pageNumber); 
4  }}
5/>

function, optional

This function is called when the zoom scale has been changed.

Parameters:

1<DocumentView
2  onZoomChanged = {(zoom) => {
3    console.log('Current zoom ratio is', zoom); 
4  }}
5/>

function, optional

This function is called when a zooming has been finished. For example, if zoom via gesture, this is called on gesture release.

Parameters:

1<DocumentView
2  onZoomFinished = {(zoom) => {
3    console.log('Current zoom ratio is', zoom);
4  }}

number, optional

Defines the horizontal scroll position in the current document viewer.

1<DocumentView
2  horizontalScrollPos={50}
3/>

number, optional

Defines the vertical scroll position in the current document viewer.

1<DocumentView
2  verticalScrollPos={50}
3/>

function, optional

This function is called when the scroll position has been changed.

Parameters:

1<DocumentView
2  onScrollChanged = {({horizontal, vertical}) => {
3    console.log('Current scroll position is', horizontal, 'horizontally, and', vertical, 'vertically.');
4  }}

bool, optional, defaults to true

Whether to show images in reflow mode.

1<DocumentView
2  imageInReflowEnabled={false}
3/>

string, optional, default value is 'Horizontal'. Android only.

Sets the scrolling direction of the reflow control. Strings should be Config.ReflowOrientation constants.

1<DocumentView
2  reflowOrientation={Config.ReflowOrientation.Vertical} 
3/>

array of strings, optional, defaults to none

Defines annotation types that will not show in the annotation (long-press) menu. Strings should be Config.Tools constants.

1<DocumentView
2  hideAnnotationMenu={[Config.Tools.annotationCreateArrow, Config.Tools.annotationEraserTool]}
3/>

array of strings, optional, default contains all the items

Defines the menu items that can show when an annotation is selected. Strings should be Config.AnnotationMenu constants.

1<DocumentView
2  annotationMenuItems={[Config.AnnotationMenu.search, Config.AnnotationMenu.share]}
3/>

array of strings, optional, defaults to none

Defines the menu items that will skip default behavior when pressed. Strings should be Config.AnnotationMenu constants. They will still be displayed in the annotation menu, and the function onAnnotationMenuPress will be called where custom behavior can be implemented.

1<DocumentView
2  overrideAnnotationMenuBehavior={[Config.AnnotationMenu.copy]}
3/>

function, optional

This function is called when an annotation menu item passed in to overrideAnnotationMenuBehavior is pressed.

Parameters:

1<DocumentView
2  onAnnotationMenuPress = {({annotationMenu, annotations}) => {
3    console.log('Annotation menu item', annotationMenu, 'has been pressed');
4    annotations.forEach(annotation => {
5      console.log('The id of selected annotation is', annotation.id);
6      console.log('The page number of selected annotation is', annotation.pageNumber);
7      console.log('The type of selected annotation is', annotation.type);
8      console.log('The lower left corner of selected annotation is', annotation.x1, annotation.y1);
9    });
10  }}
11/>

bool, optional, defaults to true

Defines whether to show the popup menu of options when the user long presses on text or blank space on the document.

1<DocumentView
2  longPressMenuEnabled={true}
3/>

array of strings, optional, default contains all the items

Defines menu items that can be shown when long pressing on text or blank space. Strings should be Config.LongPressMenu constants.

1<DocumentView
2  longPressMenuItems={[Config.LongPressMenu.copy, Config.LongPressMenu.read]}
3/>

array of strings, optional, defaults to none

Defines the menu items on long press that will skip default behavior when pressed. Strings should be Config.LongPressMenu constants. They will still be displayed in the long press menu, and the function onLongPressMenuPress will be called where custom behavior can be implemented.

1<DocumentView
2  overrideLongPressMenuBehavior={[Config.LongPressMenu.search]}
3/>

function, optional

This function is called if the pressed long press menu item is passed in to overrideLongPressMenuBehavior

Parameters:

1<DocumentView
2  onLongPressMenuPress = {({longPressMenu, longPressText}) => {
3    console.log('Long press menu item', longPressMenu, 'has been pressed');
4    if (longPressText !== '') {
5      console.log('The selected text is', longPressText);
6    }
7  }}
8/>

array of string, optional, defaults to none

Defines actions that will skip default behavior, such as external link click. Strings should be Config.Actions constants. The function onBehaviorActivated will be called where custom behavior can be implemented, whenever the defined actions occur.

1<DocumentView
2  overrideBehavior={[Config.Actions.linkPress]}
3/>

function, optional

This function is called if the activated behavior is passed in to overrideBehavior

Parameters:

NameTypeDescriptionactionstringOne of Config.Actions constants, representing which action has been activateddataobjectA JSON object that varies depending on the action

Data param table:

Data param table:

1<DocumentView
2  onBehaviorActivated = {({action, data}) => {
3    console.log('Activated action is', action);
4    if (action === Config.Actions.linkPress) {
5      console.log('The external link pressed is', data.url);
6    } else if (action === Config.Actions.stickyNoteShowPopUp) {
7      console.log('Sticky note has been activated, but it would not show a pop up window.');
8    }
9  }}
10/>

bool, optional, defaults to false

Defines whether viewer will use tabs in order to have more than one document open simultaneously (like a web browser). Changing the document prop value will cause a new tab to be opened with the associated file.

1<DocumentView
2  multiTabEnabled={true}
3/>

string, optional, default is the file name

Set the tab title if multiTabEnabled is true.

1<DocumentView
2  multiTabEnabled={true} // requirement
3  tabTitle={'tab1'}
4/>

number, optional, defaults to unlimited

Sets the limit on the maximum number of tabs that the viewer could have at a time. Open more documents after reaching this limit will overwrite the old tabs.

1<DocumentView
2  multiTabEnabled={true} // requirement
3  maxTabCount={5}
4/>

bool, optional, defaults to false

Defines whether to enable realtime collaboration. If true then currentUser must be set as well for collaboration mode to work. Feature set may vary between local and collaboration mode

1<DocumentView
2  collabEnabled={true}
3  currentUser={'Pdftron'}
4/>

string, required if collabEnabled is set to true

Defines the current user. Created annotations will have their title (author) set to this string.

1<DocumentView
2  collabEnabled={true}
3  currentUser={'Pdftron'}
4/>

string, optional

Defines the current user name. Will set the user name only if collabEnabled is true and currentUser is defined. This should be used only if you want the user's display name to be different than the annotation's title/author (in the case that currentUser is an ID rather than a human-friendly name.)

1<DocumentView
2  collabEnabled={true}
3  currentUser={'Pdftron'}
4  currentUserName={'Hello_World'}
5/>

bool, optional, defaults to false

Defines whether an annotation's permission flags will be respected when it is selected. For example, a locked annotation can not be resized or moved.

1<DocumentView
2  annotationPermissionCheckEnabled={true}
3/>

string, optional

Defines the author name for all annotations created on the current document. Exported xfdfCommand will include this piece of information.

1<DocumentView
2  annotationAuthor={'Apryse'}
3/>

bool, optional, defaults to true

If true, the active annotation creation tool will remain in the current annotation creation tool. Otherwise, it will revert to the "pan tool" after an annotation is created.

1<DocumentView
2  continuousAnnotationEditing={true}
3/>

bool, optional, defaults to true

Defines whether an annotation is selected after it is created. On iOS, this functions for shape and text markup annotations only.

1<DocumentView
2  selectAnnotationAfterCreation={true}
3/>

function, optional

This function is called if a change has been made to annotations in the current document. Unlike onAnnotationChanged, this function has an XFDF command string as its parameter. If you are modifying or deleting multiple annotations, then on Android the function is only called once, and on iOS it is called for each annotation.

Parameters:

Known Issues
On iOS, there is currently a bug that prevents the last XFDF from being retrieved when modifying annotations while collaboration mode is enabled.

1<DocumentView
2  onExportAnnotationCommand = {({action, xfdfCommand, annotations}) => {
3    console.log('Annotation edit action is', action);
4    console.log('The exported xfdfCommand is', xfdfCommand);
5    annotations.forEach((annotation) => {
6      console.log('Annotation id is', annotation.id);
7      if (!this.state.collabEnabled) {
8        console.log('Annotation pageNumber is', annotation.pageNumber);
9        console.log('Annotation type is', annotation.type);
10      }
11    });
12  }}
13  collabEnabled={this.state.collabEnabled}
14  currentUser={'Pdftron'}
15/>

function, optional

This function is called when an annotation(s) is selected.

Parameters:

1<DocumentView
2  onAnnotationsSelected = {({annotations}) => {
3    annotations.forEach(annotation => {
4      console.log('The id of selected annotation is', annotation.id);
5      console.log('It is in page', annotation.pageNumber);
6      console.log('Its type is', annotation.type);
7      console.log('Its lower left corner has coordinate', annotation.rect.x1, annotation.rect.y1);
8    });
9  }}
10/>

function, optional

This function is called if a change has been made to an annotation(s) in the current document.

Parameters:

1<DocumentView
2  onAnnotationChanged = {({action, annotations}) => {
3    console.log('Annotation edit action is', action);
4    annotations.forEach(annotation => {
5      console.log('The id of changed annotation is', annotation.id);
6      console.log('It is in page', annotation.pageNumber);
7      console.log('Its type is', annotation.type);
8    });
9  }}
10/>

function, optional

This function is called if a change has been made to form field values.

Parameters:

1<DocumentView
2  onFormFieldValueChanged = {({fields}) => {
3    console.log('Annotation edit action is', action);
4    annotations.forEach(annotation => {
5      console.log('The id of changed annotation is', annotation.id);
6      console.log('It is in page', annotation.pageNumber);
7    });
8  }}
9/>

bool, optional, Android only, default value is true

If document editing is enabled, then this value determines if the annotation list is editable.

1<DocumentView
2  annotationListEditingEnabled={true}
3/>

function, optional

This function is called if a change has been made to user bookmarks.

Parameters:

1<DocumentView
2  onBookmarkChanged = {({bookmarkJson}) => {
3    console.log('Bookmarks have been changed. Current bookmark collection is', bookmarkJson);
4  }}
5/>

bool, optional, default value is true

Defines whether the bookmark list can be edited. If the viewer is readonly then bookmarks on Android are still editable but are saved to the device rather than the PDF.

1<DocumentView
2  userBookmarksListEditingEnabled={true}
3/>

bool, optional, defaults to false

Defines whether signature fields will be signed with image stamps. This is useful if you are saving XFDF to remote source.

1<DocumentView
2  signSignatureFieldsWithStamps={true}
3/>

bool, optional, defaults to true

Defines whether to show saved signatures for re-use when using the signing tool.

1<DocumentView
2  showSavedSignatures={true}
3/>

array of strings, optional

Defines filter modes that should be hidden in the thumbnails browser. Strings should be Config.ThumbnailFilterMode constants

1<DocumentView
2  hideThumbnailFilterModes={[Config.ThumbnailFilterMode.Annotated]}
3/>

bool, optional, defaults to true

Defines whether user can modify the document using the thumbnail view (e.g. add/remove/rotate pages).

1<DocumentView
2  thumbnailViewEditingEnabled={true}
3/>
4

function, optional

This function is called immediately before a text search begins, either through user actions, or function calls such as findText.

1<DocumentView
2  onTextSearchStart = {() => {
3    console.log('Text search has started');
4  }}
5/>

function, optional

This function is called after a text search is finished or canceled.

Parameters:

quads indicate the quad boundary boxes for the selection, which could have a size larger than 1 if selection spans across different lines. Each quad have 4 points with x, y coordinates specified in number, representing a boundary box. The 4 points are in counter-clockwise order, though the first point is not guaranteed to be on lower-left relatively to the box.

1<DocumentView
2  onTextSearchResult = {({found, textSelection}) => {
3    if (found) {
4      console.log('Found selection on page', textSelection.pageNumber);
5      for (let i = 0; i < textSelection.quads.length; i ++) {
6        const quad = textSelection.quads[i];
7        console.log('selection boundary quad', i);
8        for (const quadPoint of quad) {
9          console.log('A quad point has coordinates', quadPoint.x, quadPoint.y);
10        }
11      }
12    }
13  }}
14/>

bool, optional, defaults to true

Defines whether a stylus should act as a pen when in pan mode. If false, it will act as a finger.

1<DocumentView
2  useStylusAsPen={true}
3/>

bool, optional, Android and iOS 13+ only, defaults to true

Defines whether the UI will appear in a dark color when the system is dark mode. If false, it will use viewer setting instead.

1<DocumentView
2  followSystemDarkMode={false}
3/>

bool, optional, defaults to true

Defines whether document is automatically saved by the viewer.

1<DocumentView
2  autoSaveEnabled={true}
3/>

bool, optional, defaults to false

Defines whether to restrict data usage when viewing online PDFs.

1<DocumentView
2  restrictDownloadUsage={true}
3/>

bool, optional, defaults to true, Android only

Defines whether the page stack navigation buttons will appear in the viewer.

1<DocumentView
2  pageStackEnabled={false}
3/>

bool, optional, defaults to true, Android only

Defines whether the quick navigation buttons will appear in the viewer.

1<DocumentView
2  showQuickNavigationButton={false}
3/>

bool, optional, defaults to true on Android and false on iOS

Defines whether the navigation list will be displayed as a side panel on large devices such as iPads and tablets.

1<DocumentView
2  showNavigationListAsSidePanelOnLargeDevices={true}
3/>

Returns the path of the current document. If isBase64String is true, this would be the path to the temporary pdf file converted from the base64 string in document.

Returns a Promise.

Promise Parameters:

1this._viewer.getDocumentPath().then((path) => {
2  console.log('The path to current document is: ' + path);
3});

Saves the current document. If isBase64String is true, this would be the base64 string encoded from the temporary pdf file, which is created from the base64 string in document.

Returns a Promise.

Promise Parameters:

1this._viewer.saveDocument().then((filePath) => {
2  console.log('saveDocument:', filePath);
3});

Sets the color post processing transformation mode for the viewer.

Parameters:

1this._viewer.setColorPostProcessMode(Config.ColorPostProcessMode.NightMode);

Sets the white and black color for the color post processing transformation.

Parameters:

1const whiteColor = {"red": 0, "green": 0, "blue": 255};
2const blackColor = {"red": 255, "green": 0, "blue": 0};
3this._viewer.setColorPostProcessColors(whiteColor, blackColor);

Sets the current tool mode.

Parameters:

1this._viewer.setToolMode(Config.Tools.annotationCreateFreeHand);

Commits the current tool, only available for multi-stroke ink and poly-shape.

Returns a Promise.

Promise Parameters:

1this._viewer.commitTool().then((committed) => {
2  // committed: true if either ink or poly-shape tool is committed, false otherwise
3});

Gets the total number of pages in the currently displayed document.

Returns a Promise.

Promise Parameters:

1this._viewer.getPageCount().then((pageCount) => {
2  console.log('pageCount', pageCount);
3});

Sets current page of the document.

Parameters:

Returns a Promise.

Promise Parameters:

1this._viewer.setCurrentPage(4).then((success) => {
2  if (success) {
3    console.log("Current page is set to 4.");
4  }
5});

Go to the previous page of the document. If on first page, it would stay on first page.

Returns a Promise.

Promise Parameters:

1this._viewer.gotoPreviousPage().then((success) => {
2  if (success) {
3    console.log("Go to previous page.");
4  }
5});

Go to the next page of the document. If on last page, it would stay on last page.

Returns a Promise.

Promise Parameters:

1this._viewer.gotoNextPage().then((success) => {
2  if (success) {
3    console.log("Go to next page.");
4  }
5});

Go to the first page of the document.

Returns a Promise.

Promise Parameters:

1this._viewer.gotoFirstPage().then((success) => {
2  if (success) {
3    console.log("Go to first page.");
4  }
5});

Go to the last page of the document.

Returns a Promise.

Promise Parameters:

1this._viewer.gotoLastPage().then((success) => {
2  if (success) {
3    console.log("Go to last page.");
4  }
5});

Gets the crop box for specified page as a JSON object.

Parameters: