PDFTron React Native supports 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, and exact type aliases and constants used in our custom typings can be found in AnnotOptions and Config source folders.
RNPdftron contains static methods for global library initialization, configuration, and utility methods.
Initializes PDFTron SDK with your PDFTron commercial license key. You can run PDFTron in demo mode by passing an empty string.
Parameters:
| Name | Type | Description |
|---|---|---|
| licenseKey | string | your PDFTron license key |
RNPdftron.initialize('your_license_key');Enables JavaScript for PDFTron SDK, by default it is enabled.
Parameters:
| Name | Type | Description |
|---|---|---|
| enabled | bool | whether to enable or disable JavaScript |
RNPdftron.enableJavaScript(true);Gets the current PDFNet version.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| version | string | current PDFNet version |
RNPdftron.getVersion().then((version) => {
console.log("Current PDFNet version:", version);
});Gets the version of current platform (Android/iOS).
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| platformVersion | string | current platform version (Android/iOS) |
RNPdftron.getPlatformVersion().then((platformVersion) => {
console.log("App currently running on:", platformVersion);
});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:
| Name | Type | Description |
|---|---|---|
| fontList | string | the font list available on Android |
RNPdftron.getSystemFontList().then((fontList) => {
console.log("OS font list:", fontList);
});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.
RNPdftron.clearRubberStampCache().then(() => {
console.log("Rubber stamp cache cleared");
});Clear the saved view state such as page number, zoom location etc. (Android only).
This is typically useful when DocumentView is in a sub-navigation component and state-saving is not desired across sessions.
Returns a promise.
RNPdftron.clearSavedViewerState().then(() => {
console.log("Viewer state cleared");
});Encrypts (password-protect) a document (must be a PDF). Note: This function does not lock the document it cannot be used it while the document is opened in the viewer.
Parameters:
| Name | Type | Description |
|---|---|---|
| file path | string | the local file path to the file |
| password | string | the password you would like to set |
| current password | string | the current password, use empty string if no password |
Returns a promise.
Example:
RNPdftron.encryptDocument("/sdcard/Download/new.pdf", "1111", "").then(() => {
console.log("done password");
});Generates a PDF from an Office document.
Parameters:
| Name | Type | Description |
|---|---|---|
| docxPath | string | the local file path to the Office file |
Optional Parameters:
| Name | Type | Description |
|---|---|---|
| applyPageBreaksToSheet | boolean | Whether we should split Excel workheets into pages so that the output resembles print output. |
| displayChangeTracking | boolean | If this option is true, will display office change tracking markup present in the document (i.e, red strikethrough of deleted content and underlining of new content). |
| excelDefaultCellBorderWidth | double | Cell border width for table cells that would normally be drawn with no border. |
| excelMaxAllowedCellCount | int | Conversion will throw an exception if the number of cells in a Microsoft Excel document is above the set MaxAllowedCellCount. |
| locale | string | ISO 639-1 code of the current system locale. For example: 'en-US', 'ar-SA', 'de-DE', etc. |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| resultPdfPath | string | the local file path to the generated PDF |
The user is responsible for cleaning up the temporary file that is generated.
Example:
// With options
RNPdftron.pdfFromOffice("/sdcard/Download/red.xlsx",
{
applyPageBreaksToSheet: true,
displayChangeTracking: true,
excelDefaultCellBorderWidth: 1,
excelMaxAllowedCellCount: 250000,
locale: 'en-US'
})
.then((resultPdfPath) => {
console.log(resultPdfPath);
});
// Without options
RNPdftron.pdfFromOffice("/sdcard/Download/red.xlsx", null).then((resultPdfPath) => {
console.log(resultPdfPath);
});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:
| Name | Type | Description |
|---|---|---|
| docxPath | string | the local file path to the template file |
| json | object | the replacement data in the form of a JSON object |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| resultPdfPath | string | the local file path to the generated PDF |
The user is responsible for cleaning up the temporary file that is generated.
Example:
RNPdftron.pdfFromOfficeTemplate("/sdcard/Download/red.docx", json).then((resultPdfPath) => {
console.log(resultPdfPath);
});Export a PDF page to an image format defined in Config.ExportFormat.
Unlike DocumentView.exportAsImage, this method is static and should only be called before a DocumentView instance has been created or else unexpected behaviour can occur. This method also takes a local file path to the desired PDF.
Parameters:
| Name | Type | Description |
|---|---|---|
| pageNumber | int | the page to be converted; if the value does not refer to a valid page number, the file path will be undefined |
| dpi | double | the output image resolution |
| exportFormat | string | one of Config.ExportFormat constants |
| filePath | string | local file path to pdf |
| transparent | boolean | (only relevant when exported as PNG) whether the background of the image is transparent or the color of the PDF page (typically white) |
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| resultImagePath | string | the temp path of the created image, user is responsible for clean up the cache |
RNPdftron.exportAsImage(1, 92, Config.ExportFormat.BMP, "/sdcard/Download/red.pdf", false).then((resultImagePath) => {
console.log('export', resultImagePath);
});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:
<DocumentView
document={'https://pdftron.s3.amazonaws.com/downloads/pl/PDFTRON_about.pdf'}
/>string
The path or url to the document. Wonday compatibility API.
Example:
<DocumentView
source={'https://pdftron.s3.amazonaws.com/downloads/pl/PDFTRON_about.pdf'}
/>string, optional
The password of the document, if any.
Example:
<DocumentView
password={'password'}
/>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.
<DocumentView
isBase64String={true}
document={'...'} // base 64 string
/>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.
<DocumentView
isBase64String={true}
document={'...'} // base 64 string
base64FileExtension={'.jpeg'}
/>string, optional, defaults to the extension in the document prop.
Used for specifying the extension of the document to be loaded.
<DocumentView
document={"https://pdftron.s3.amazonaws.com/pdfInDisguise.png"}
documentExtension={"pdf"}
/>object, optional
Defines custom headers to use with HTTP/HTTPS requests.
<DocumentView
customHeaders={{headerKey: 'headerValue'}}
/>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.
<DocumentView
readOnly={true}
/>one of the Config.EraserType constants, optional
Sets the default eraser tool type. Value only applied after a clean install.
| Eraser Type | Description |
|---|---|
annotationEraser |
Erases everything as an object; if you touch ink, the entire object is erased. |
hybrideEraser |
Erases ink by pixel, but erases other annotation types as objects. |
inkEraser |
Erases ink by pixel only. Android only. |
<DocumentView
defaultEraserType={Config.EraserType.hybrideEraser}
/>string, optional
Sets the folder path for all save options, this defaults to the app cache path. Android only. Example:
<DocumentView
exportPath="/data/data/com.example/cache/test"
/>string, optional
Sets the cache folder used to cache PDF files opened using a http/https link, this defaults to the app cache path. Android only. Example:
<DocumentView
openUrlPath="/data/data/com.example/cache/test"
/>bool, optional, default to true
Sets whether to remember the last visited page and zoom for a document if it gets opened again.
On iOS this prop only applies to local documents and saves the last visited page. The zoom is not saved.
On Android the zoom and last visited page are saved for both local and remote documents.
Example:
<DocumentView
saveStateEnabled={false}
/>bool, optional, default to true, Android only.
Sets whether the new saved file should open after saving. Example:
<DocumentView
openSavedCopyInNewTab={false}
/>function, optional
This function is called when the document finishes loading.
Parameters:
| Name | Type | Description |
|---|---|---|
| path | string | File path that the document has been saved to |
<DocumentView
onDocumentLoaded = {(path) => {
console.log('The document has finished loading:', path);
}}
/>function, optional
This function is called when the document finishes loading.
Parameters:
| Name | Type | Description |
|---|---|---|
| path | string | File path that the document has been saved to |
<DocumentView
onLoadComplete = {(path) => {
console.log('The document has finished loading:', path);
}}
/>function, optional
This function is called when document opening encounters an error.
Parameters:
| Name | Type | Description |
|---|---|---|
| error | string | Error message produced |
<DocumentView
onDocumentError = {(error) => {
console.log('Error occured during document opening:', error);
}}
/>function, optional
This function is called when document opening encounters an error.
Parameters:
| Name | Type | Description |
|---|---|---|
| error | string | Error message produced |
<DocumentView
onError = {(error) => {
console.log('Error occured during document opening:', error);
}}
/>array of Config.Buttons constants, optional, defaults to none
Defines buttons to be disabled for the viewer.
<DocumentView
disabledElements={[Config.Buttons.userBookmarkListButton]}
/>array of Config.Tools constants, optional, defaults to none
Defines tools to be disabled for the viewer.
<DocumentView
disabledTools={[Config.Tools.annotationCreateLine, Config.Tools.annotationCreateRectangle]}
/>function, optional
This function is called when the current tool changes to a new tool
Parameters:
| Name | Type | Description |
|---|---|---|
| previousTool | string | the previous tool (one of the Config.Tools constants or "unknown tool"), representing the tool before change |
| tool | string | the current tool (one of the Config.Tools constants or "unknown tool"), representing the current tool |
<DocumentView
onToolChanged = {({previousTool, tool}) => {
console.log('Tool has been changed from', previousTool, 'to', tool);
}}
/>boolean, optional, defaults to true, Android only
Defines whether the last tool used in the current viewer session will be the tool selected upon starting a new viewer session.
Example:
<DocumentView
rememberLastUsedTool={false}
/>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:
<DocumentView
leadingNavButtonIcon={Platform.OS === 'ios' ? 'ic_close_black_24px.png' : 'ic_arrow_back_white_24dp'}
/>Note: to add the image file to your application, please follow the steps below:
- 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 here.
- Now you can use the image in the viewer. For example, if you add
button_close.pngto drawable, you could use'button_close'in leadingNavButtonIcon.
- After pods has been installed, open the
.xcworkspacefile for this application in Xcode (in this case, it'sexample.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"
- "+".
- Now you can use the image in the viewer. For example, if you add
button_open.pngto the bundle, you could use'button_open.png'in leadingNavButtonIcon.
bool, optional, defaults to true
Defines whether to show the leading navigation button.
<DocumentView
showLeadingNavButton={true}
/>function, optional
This function is called when the leading navigation button is pressed.
<DocumentView
onLeadingNavButtonPressed = {() => {
console.log('The leading nav has been pressed');
}}
/>String, optional
The file name of the icon to be used as the overflow menu button. The button will use the specified icon if it is valid, and the default icon otherwise.
Note: to add the image file to your application, follow the steps under the Note section of leadingNavButtonIcon.
Example:
<DocumentView
overflowMenuButtonIcon={Platform.OS === 'ios' ? 'ic_close_black_24px.png' : 'ic_arrow_back_white_24dp'}
/>bool, optional, defaults to true
Defines whether the document slider of the viewer is enabled.
<DocumentView
documentSliderEnabled={false}
/>array of Config.ViewModePickerItem constants, optional, defaults to none.
Defines view mode items to be hidden in the view mode dialog.
<DocumentView
hideViewModeItems={[
Config.ViewModePickerItem.Crop,
Config.ViewModePickerItem.Rotation,
Config.ViewModePickerItem.ColorMode,
Config.ViewModePickerItem.ReaderModeSettings,
]}
/>bool, optional, defaults to true
Defines whether the tablet layout should be used on tablets. Otherwise uses the same layout as phones. Android only.
<DocumentView
tabletLayoutEnabled={true}
/>bool, optional, defaults to true
Defines whether the download dialog should be shown. Android only.
<DocumentView
downloadDialogEnabled={true}
/>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.
<DocumentView
bottomToolbarEnabled={false}
/>bool, optional, defaults to false
Defines whether preset bar is hidden or not
<DocumentView
hidePresetBar={true}
/>array of Config.DefaultToolbars constants or custom toolbar objects, optional, defaults to none
Defines custom toolbars. If passed in, the default toolbars will no longer appear. When indicating the icon of a custom toolbar item, ensure that the resource for either Android or iOS exists. It is possible to mix and match with default toolbars. See example below:
const myToolItem = {
[Config.CustomToolItemKey.Id]: 'add_page',
[Config.CustomToolItemKey.Name]: 'Add page',
// An example of custom Android icon:
[Config.CustomToolItemKey.Icon]: 'ic_add_blank_page_white',
// An example of custom iOS icon:
//[Config.CustomToolItemKey.Icon]: 'pencil.circle',
};
const myToolbar = {
[Config.CustomToolbarKey.Id]: 'myToolbar',
[Config.CustomToolbarKey.Name]: 'myToolbar',
[Config.CustomToolbarKey.Icon]: Config.ToolbarIcons.FillAndSign,
[Config.CustomToolbarKey.Items]: [Config.Tools.annotationCreateArrow, Config.Tools.annotationCreateCallout, myToolItem, Config.Buttons.undo]
};
<DocumentView
annotationToolbars={[Config.DefaultToolbars.Annotate, myToolbar]}
/>function, optional
This function is called when the current toolbar has changed.
Parameters:
| Name | Type | Description |
|---|---|---|
| toolbar | string | The current toolbar. One of the Config.DefaultToolbars constants or the id of a custom toolbar object. |
<DocumentView
onCurrentToolbarChanged = {({toolbar}) => {
console.log('toolbar changed to: ' + toolbar);
}}
/>function, optional
This function is called when a custom toolbar tool item is clicked
Parameters:
| Name | Type | Description |
|---|---|---|
| id | string | the Config.CustomToolItemKey.Id defined in the tool |
<DocumentView
onAnnotationToolbarItemPress = {({id}) => {
console.log('toolbar item press: ' + id);
}}
/>array of Config.DefaultToolbars constants, optional, defaults to none
Defines which default annotation toolbars should be hidden. Note that this prop should be used when annotationToolbars is not defined.
<DocumentView
hideDefaultAnnotationToolbars={[Config.DefaultToolbars.Annotate, Config.DefaultToolbars.Favorite]}
/>array of Config.ThumbnailsViewItem constants, optional, defaults to none
Defines which default thumbnail view items should be hidden. Note: InsertFromPhoto item is for iOS only On Android, photo and camera are both included in InsertFromImage
<DocumentView
hideThumbnailsViewItems={[Config.ThumbnailsViewItem.InsertPages, Config.ThumbnailsViewItem.ExportPages]}
/>bool, optional, defaults to false
Defines whether to show the toolbar switcher in the top toolbar.
<DocumentView
hideAnnotationToolbarSwitcher={false}
/>one of the Config.DefaultToolbars constants or the id of a custom toolbar object, optional, defaults to none
Defines which annotationToolbar should be selected when the document is opened.
<DocumentView
initialToolbar={Config.DefaultToolbars.Draw}
/>bool, optional, defaults to false
Defines whether to hide both the top app nav bar and the annotation toolbar.
<DocumentView
hideTopToolbars={false}
/>bool, optional, defaults to false
Defines whether to hide the top navigation app bar.
<DocumentView
hideTopAppNavBar={true}
/>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.
<DocumentView
hideToolbarsOnTap={false}
/>bool, optional, defaults to false, android only
Defines whether the toolbars will be gone at startup.
Android
<DocumentView
hideToolbarsOnAppear={true}
/>array of Config.Buttons constants, optional, only the tabs, search, view mode, thumbnails, outline, undo, share, reflow, edit pages, save copy, print, file attachment, layers, digital signatures and close buttons are supported on Android
Customizes the right bar section of the top app nav bar. If passed in, the default right bar section will not be used.
<DocumentView
topAppNavBarRightBar={[Config.Buttons.reflowButton, Config.Buttons.outlineListButton]}
/>array of Config.Buttons constants, 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.
<DocumentView
bottomToolbar={[Config.Buttons.reflowButton, Config.Buttons.outlineListButton]}
/>bool, optional, defaults to false, android only
Defines whether the viewer will add padding to take account of the system status bar.
<DocumentView
padStatusBar={true}
/>array of Config.Buttons constants, optional, defaults to none
Defines the option buttons in the top app nav bar or the bottom toolbar that will skip default behavior when pressed.
They will still be displayed in the toolbar, and the function onToolbarButtonPress will be called where custom behavior can be implemented.
<DocumentView
overrideToolbarButtonBehavior={[Config.Buttons.shareButton, Config.Buttons.searchButton]}
onToolbarButtonPress={({id}) => {
if (id === Config.Buttons.shareButton) {
console.log('Share button pressed');
} else if (id === Config.Buttons.searchButton) {
console.log('Search button pressed');
}
}}
/>function, optional
This function is called when a toolbar item passed in to overrideToolbarButtonBehavior is pressed.
Parameters:
| Name | Type | Description |
|---|---|---|
| id | string | one of Config.Buttons constants representing the item that has been pressed |
<DocumentView
overrideToolbarButtonBehavior={[Config.Buttons.shareButton, Config.Buttons.searchButton]}
onToolbarButtonPress={({id}) => {
if (id === Config.Buttons.shareButton) {
console.log('Share button pressed');
} else if (id === Config.Buttons.searchButton) {
console.log('Search button pressed');
}
}}
/>one of the Config.FitMode constants, optional, default value is Config.FitMode.FitWidth
Defines the fit mode (default zoom level) of the viewer.
<DocumentView
fitMode={Config.FitMode.FitPage}
/>Defines the fit mode (default zoom level) of the viewer. Parameters:
| Mode | Value | Description |
|---|---|---|
| fitPage (default) | 0 | fits the whole page |
| fit width | 1 | fits page using width |
| fit hieght | 2 | fits page using height |
<DocumentView
fitPolicy={2}
/>bool, optional, defaults to true, Android only.
Defines whether the viewer should maintain zoom level when flipping pages.
<DocumentView
maintainZoomEnabled={true}
/>one of the Config.LayoutMode constants, optional, default value is Config.LayoutMode.Continuous
Defines the layout mode of the viewer.
<DocumentView
layoutMode={Config.LayoutMode.FacingContinuous}
/>function, optional
This function is called when the layout of the viewer has been changed.
<DocumentView
onLayoutChanged = {() => {
console.log('Layout has been updated.');
}}
/>number, optional
Defines the initial page number that viewer displays when the document is opened. Note that page numbers are 1-indexed.
<DocumentView
initialPageNumber={5}
/>number, optional
Defines the initial page number that viewer displays when the document is opened. Note that page numbers are 1-indexed.
<DocumentView
page={5}
/>number, optional
Defines the currently displayed page number. Different from initialPageNumber, changing this prop value at runtime will change the page accordingly.
<DocumentView
pageNumber={5}
/>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.
<DocumentView
pageChangeOnTap={true}
/>bool, optional, defaults to true
Defines whether to show the page indicator for the viewer.
<DocumentView
pageIndicatorEnabled={true}
/>bool, optional, defaults to true
Defines whether the keyboard shortcuts of the viewer are enabled.
<DocumentView
keyboardShortcutsEnabled={false}
/>function, optional
This function is called when the page number has been changed.
Parameters:
| Name | Type | Description |
|---|---|---|
| previousPageNumber | int | the previous page number |
| pageNumber | int | the current page number |
<DocumentView
onPageChanged = {({previousPageNumber, pageNumber}) => {
console.log('Page number changes from', previousPageNumber, 'to', pageNumber);
}}
/>function, optional
This function is called when a page has been moved in the document.
Parameters:
| Name | Type | Description |
|---|---|---|
| previousPageNumber | int | the previous page number |
| pageNumber | int | the current page number |
<DocumentView
onPageMoved = {({previousPageNumber, pageNumber}) => {
console.log('Page moved from', previousPageNumber, 'to', pageNumber);
}}
/>function, optional
This function is called when pages are added to the document.
Parameters:
| Name | Type | Description |
|---|---|---|
| pageNumbers | array | An array of the page numbers that were added to the document |
<DocumentView
onPagesAdded = {({pageNumbers}) => {
console.log('Pages added:', pageNumbers);
}}
/>function, optional
This function is called when pages are rotated.
Parameters:
| Name | Type | Description |
|---|---|---|
| pageNumbers | array | An array of the page numbers that were rotated |
<DocumentView
onPagesRotated = {({pageNumbers}) => {
console.log('Pages rotated:', pageNumbers);
}}
/>function, optional
This function is called when pages are removed from the document.
Parameters:
| Name | Type | Description |
|---|---|---|
| pageNumbers | array | An array of the page numbers that were removed from the document |
<DocumentView
onPagesRemoved = {({pageNumbers}) => {
console.log('Pages removed:', pageNumbers);
}}
/>double, optional
This prop defines the zoom of the document
<DocumentView
zoom={2.0}
/>double, optional
This prop defines the zoom of the document. Same as zoom. Wonday compatibility API.
<DocumentView
scale={2.0}
/>function, optional
This function is called when the zoom scale has been changed.
Parameters:
| Name | Type | Description |
|---|---|---|
| zoom | double | the current zoom ratio of the document |
<DocumentView
onZoomChanged = {(zoom) => {
console.log('Current zoom ratio is', zoom);
}}
/>function, optional
This function is called when the zoom scale has been changed.
Parameters:
| Name | Type | Description |
|---|---|---|
| zoom | double | the current zoom ratio of the document |
<DocumentView
onScaleChanged = {(scale) => {
console.log('Current scale ratio is', scale);
}}
/>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:
| Name | Type | Description |
|---|---|---|
| zoom | double | the current zoom ratio of the document |
<DocumentView
onZoomFinished = {(zoom) => {
console.log('Current zoom ratio is', zoom);
}}number, optional
Defines the horizontal scroll position in the current document viewer.
<DocumentView
horizontalScrollPos={50}
/>number, optional
Defines the vertical scroll position in the current document viewer.
<DocumentView
verticalScrollPos={50}
/>function, optional
This function is called when the scroll position has been changed.
Parameters:
| Name | Type | Description |
|---|---|---|
| horizontal | number | the horizontal position of the scroll |
| vertical | number | the vertical position of the scroll |
<DocumentView
onScrollChanged = {({horizontal, vertical}) => {
console.log('Current scroll position is', horizontal, 'horizontally, and', vertical, 'vertically.');
}}bool, optional, iOS only, defaults to false
Determines whether scrollbars will be hidden on the viewer.
<DocumentView
hideScrollbars={true}
/>bool, optional, defaults to true, will be available on iOS in version 9.1.2 and greater
Whether to show images in reflow mode.
<DocumentView
imageInReflowEnabled={false}
/>one of the Config.ReflowOrientation constants, optional, defaults to the viewer's scroll direction.
Sets the scrolling direction of the reflow control.
<DocumentView
reflowOrientation={Config.ReflowOrientation.Vertical}
/>array of Config.Tools constants, optional, defaults to none
Defines annotation types that will not show in the annotation (long-press) menu.
<DocumentView
hideAnnotationMenu={[Config.Tools.annotationCreateArrow, Config.Tools.annotationEraserTool]}
/>array of Config.AnnotationMenu constants, optional, default contains all the items
Defines the menu items that can show when an annotation is selected.
<DocumentView
annotationMenuItems={[Config.AnnotationMenu.search, Config.AnnotationMenu.share]}
/>array of Config.AnnotationMenu constants, optional, defaults to none
Defines the menu items that will skip default behavior when pressed. They will still be displayed in the annotation menu, and the function onAnnotationMenuPress will be called where custom behavior can be implemented.
<DocumentView
overrideAnnotationMenuBehavior={[Config.AnnotationMenu.copy]}
/>function, optional
This function is called when an annotation menu item passed in to overrideAnnotationMenuBehavior is pressed.
Parameters:
| Name | Type | Description |
|---|---|---|
| annotationMenu | string | One of Config.AnnotationMenu constants, representing which item has been pressed |
| annotations | array | An array of {id: string, pageNumber: number, type: string, screenRect: object, pageRect: object} objects.id is the annotation identifier and type is one of the Config.Tools constants. screenRect was formerly called rect. Both rects are represented with {x1: number, y1: number, x2: number, y2: number, width: number, height: number} objects. |
<DocumentView
onAnnotationMenuPress = {({annotationMenu, annotations}) => {
console.log('Annotation menu item', annotationMenu, 'has been pressed');
annotations.forEach(annotation => {
console.log('The id of selected annotation is', annotation.id);
console.log('The page number of selected annotation is', annotation.pageNumber);
console.log('The type of selected annotation is', annotation.type);
console.log('The screenRect of selected annotation is', annotation.screenRect);
console.log('The pageRect of selected annotation is', annotation.pageRect);
});
}}
/>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.
<DocumentView
longPressMenuEnabled={true}
/>array of Config.LongPressMenu constants, optional, default contains all the items
Defines menu items that can show when long press on text or blank space.
<DocumentView
longPressMenuItems={[Config.LongPressMenu.copy, Config.LongPressMenu.read]}
/>array of Config.LongPressMenu constants, optional, defaults to none
Defines the menu items on long press that will skip default behavior when pressed. They will still be displayed in the long press menu, and the function onLongPressMenuPress will be called where custom behavior can be implemented.
<DocumentView
overrideLongPressMenuBehavior={[Config.LongPressMenu.search]}
/>function, optional
This function is called if the pressed long press menu item is passed in to overrideLongPressMenuBehavior
Parameters:
| Name | Type | Description |
|---|---|---|
| longPressMenu | string | One of Config.LongPressMenu constants, representing which item has been pressed |
| longPressText | string | the selected text if pressed on text, empty otherwise |
<DocumentView
onLongPressMenuPress = {({longPressMenu, longPressText}) => {
console.log('Long press menu item', longPressMenu, 'has been pressed');
if (longPressText !== '') {
console.log('The selected text is', longPressText);
}
}}
/>array of Config.Actions constants, optional, defaults to none
Defines actions that will skip default behavior, such as external link click. The function onBehaviorActivated will be called where custom behavior can be implemented, whenever the defined actions occur.
<DocumentView
overrideBehavior={[Config.Actions.linkPress]}
/>function, optional
This function is called if the activated behavior is passed in to overrideBehavior
Parameters:
| Name | Type | Description |
|---|---|---|
| action | string | One of Config.Actions constants, representing which action has been activated |
| data | object | A JSON object that varies depending on the action |
Data param table:
| Action | Data param |
|---|---|
Config.Actions.linkPress |
{url: string} |
Config.Actions.stickyNoteShowPopUp |
{id: string, pageNumber: number, type: string, screenRect: {x1: number, y1: number, x2: number, y2: number, width: number, height: number}, pageRect: {x1: number, y1: number, x2: number, y2: number, width: number, height: number}}. Type is one of the Config.Tools constants. screenRect was formerly called rect. |
<DocumentView
onBehaviorActivated = {({action, data}) => {
console.log('Activated action is', action);
if (action === Config.Actions.linkPress) {
console.log('The external link pressed is', data.url);
} else if (action === Config.Actions.stickyNoteShowPopUp) {
console.log('Sticky note has been activated, but it would not show a pop up window.');
}
}}
/>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.
<DocumentView
multiTabEnabled={true}
/>string, optional, default is the file name
Set the tab title if multiTabEnabled is true.
<DocumentView
multiTabEnabled={true}
tabTitle={'tab1'}
/>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.
<DocumentView
multiTabEnabled={true}
maxTabCount={5}
/>function, optional
The function is activated when a tab is changed.
Please note that this API is meant for tab-specific changes. If you would like to know when the document finishes loading instead, see the onDocumentLoaded event.
Parameters:
| Name | Type | Description |
|---|---|---|
| currentTab | string | The file path of current tab's document |
<DocumentView
multiTabEnabled={true}
onTabChanged={({currentTab}) => {
console.log("The current tab is ", currentTab);
}}
/>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.
<DocumentView
collabEnabled={true}
currentUser={'Pdftron'}
/>string, required if collabEnabled is set to true
Defines the current user. Created annotations will have their title (author) set to this string.
<DocumentView
collabEnabled={true}
currentUser={'Pdftron'}
/>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.)
<DocumentView
collabEnabled={true}
currentUser={'Pdftron'}
currentUserName={'Hello_World'}
/>one of the Config.AnnotationManagerEditMode constants, optional, default value is Config.AnnotationManagerEditMode.Own
Sets annotation manager edit mode when collabEnabled is true.
| Mode | Description |
|---|---|
Config.AnnotationManagerEditMode.Own |
In this mode, you can edit only your own changes |
Config.AnnotationManagerEditMode.All |
In this mode, you can edit everyone's changes |
<DocumentView
collabEnabled={true}
currentUser={'Pdftron'}
annotationManagerEditMode={Config.AnnotationManagerEditMode.All}
/>one of the Config.AnnotationManagerUndoMode constants, optional, default value is Config.AnnotationManagerUndoMode.Own
Sets annotation manager undo mode when collabEnabled is true.
| Mode | Description |
|---|---|
Config.AnnotationManagerUndoMode.Own |
In this mode, you can undo only your own changes |
Config.AnnotationManagerUndoMode.All |
In this mode, you can undo everyone's changes |
<DocumentView
collabEnabled={true}
currentUser={'Pdftron'}
annotationManagerUndoMode={Config.AnnotationManagerUndoMode.All}
/>boolean, optional, defaults to true
Defines whether to show an annotation's reply review state.
<DocumentView
collabEnabled={true}
currentUser={'Pdftron'}
replyReviewStateEnabled={true}
/>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.
<DocumentView
annotationPermissionCheckEnabled={true}
/>string, optional
Defines the author name for all annotations created on the current document. Exported xfdfCommand will include this piece of information.
<DocumentView
annotationAuthor={'PDFTron'}
/>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.
<DocumentView
continuousAnnotationEditing={true}
/>bool, optional, defaults to true
If true, ink tool will use multi-stroke mode. Otherwise, each stroke is a new ink annotation.
<DocumentView
inkMultiStrokeEnabled={true}
/>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.
<DocumentView
selectAnnotationAfterCreation={true}
/>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:
| Name | Type | Description |
|---|---|---|
| action | string | the action that occurred (add, delete, modify, undo, redo) |
| xfdfCommand | string | an xfdf string containing info about the edit |
| annotations | array | an array of annotation data. When collaboration is enabled data comes in the format {id: string}, otherwise the format is {id: string, pageNumber: number, type: string}. In both cases, the data represents the annotations that have been changed. type is one of the Config.Tools constants |
<DocumentView
onExportAnnotationCommand = {({action, xfdfCommand, annotations}) => {
console.log('Annotation edit action is', action);
console.log('The exported xfdfCommand is', xfdfCommand);
annotations.forEach((annotation) => {
console.log('Annotation id is', annotation.id);
if (!this.state.collabEnabled) {
console.log('Annotation pageNumber is', annotation.pageNumber);
console.log('Annotation type is', annotation.type);
}
});
}}
collabEnabled={this.state.collabEnabled}
currentUser={'Pdftron'}
/>function, optional
This function is called when an annotation(s) is selected.
Parameters:
| Name | Type | Description |
|---|---|---|
| annotations | array | array of annotation data in the format {id: string, pageNumber: number, type: string, screenRect: {x1: number, y1: number, x2: number, y2: number, width: number, height: number}, pageRect: {x1: number, y1: number, x2: number, y2: number, width: number, height: number}}, representing the selected annotations. Type is one of the Config.Tools constants. screenRect was formerly called rect. |
<DocumentView
onAnnotationsSelected = {({annotations}) => {
annotations.forEach(annotation => {
console.log('The id of selected annotation is', annotation.id);
console.log('It is in page', annotation.pageNumber);
console.log('Its type is', annotation.type);
});
}}
/>function, optional
This function is called if a change has been made to an annotation(s) in the current document.
Note: When an annotation is flattened, it also gets deleted, so both onAnnotationChanged and onAnnotationFlattened are called.
Parameters:
| Name | Type | Description |
|---|---|---|
| action | string | the action that occurred (add, delete, modify) |
| annotations | array | array of annotation data in the format {id: string, pageNumber: number, type: string}, representing the annotations that have been changed. type is one of the Config.Tools constants |
<DocumentView
onAnnotationChanged = {({action, annotations}) => {
console.log('Annotation edit action is', action);
annotations.forEach(annotation => {
console.log('The id of changed annotation is', annotation.id);
console.log('It is in page', annotation.pageNumber);
console.log('Its type is', annotation.type);
});
}}
/>function, optional
This function is called if an annotation(s) has been flattened in the current document.
Parameters:
| Name | Type | Description |
|---|---|---|
| annotations | array | array of annotation data in the format {id: string, pageNumber: number, type: string}, representing the annotations that have been changed. type is one of the Config.Tools constants. ids returned via the event listener can be null. |
<DocumentView
onAnnotationFlattened={({annotations}) => {
annotations.forEach(annotation => {
console.log('The id of changed annotation is', annotation.id);
console.log('It is in page', annotation.pageNumber);
console.log('Its type is', annotation.type);
});
}}
/>function, optional
This function is called if a change has been made to form field values. Additionally signatures type fields will have the fieldHasAppearance value defined. The hasAppearance indicates whether the signature field was signed or not
Parameters:
| Name | Type | Description |
|---|---|---|
| fields | array | array of field data in the format {fieldName: string, fieldType: string, fieldValue: any, fieldHasAppearance: boolean}, representing the fields that have been changed |
<DocumentView
onFormFieldValueChanged = {({fields}) => {
fields.forEach(field => {
console.log('The name of the changed field is', field.fieldName);
console.log('The type of the changed field is', field.fieldType);
console.log('The value of the changed field is', field.fieldValue);
console.log('The hasAppearance of the changed field is', field.fieldHasAppearance);
});
}}
/>bool, optional, default value is true
If document editing is enabled, then this value determines if the annotation list is editable.
<DocumentView
annotationsListEditingEnabled={true}
/>array of Config.Tools constants, optional, defaults to none.
Defines annotation types that cannot be edited after creation.
<DocumentView
disableEditingByAnnotationType={[Config.Tools.annotationCreateTextSquiggly, Config.Tools.annotationCreateEllipse]}
/>bool, optional, default to true, Android only.
Sets whether the pdf should have highlighter smoothing. Example
<DocumentView
highlighterSmoothingEnabled={false}
/>array of Config.Tools constants, optional, defaults to none
Defines types to be excluded from the annotation list. Example use:
<DocumentView
excludedAnnotationListTypes={[Config.Tools.annotationCreateEllipse, Config.Tools.annotationCreateRectangle, Config.Tools.annotationCreateRedaction]}
/>function, optional
This function is called if a change has been made to user bookmarks.
Parameters:
| Name | Type | Description |
|---|---|---|
| bookmarkJson | string | the list of current bookmarks in JSON format |
<DocumentView
onBookmarkChanged = {({bookmarkJson}) => {
console.log('Bookmarks have been changed. Current bookmark collection is', bookmarkJson);
}}
/>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.
<DocumentView
userBookmarksListEditingEnabled={true}
/>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.
<DocumentView
signSignatureFieldsWithStamps={true}
/>bool, optional, defaults to true
Defines whether to show saved signatures for re-use when using the signing tool.
<DocumentView
showSavedSignatures={true}
/>bool, optional, defaults to true.
Defines whether to store new signatures when using the signing tool.
<DocumentView
storeNewSignature={true}
/>number, optional
Defines the maximum number of signatures you can create for a document.
<DocumentView
maxSignatureCount={3}
/>bool, optional, defaults to true. Android only.
Defines whether to show the option to pick images in the signature dialog.
<DocumentView
photoPickerEnabled={true}
/>array of objects containing keys red, green, and blue, optional
The colors that the user can select to create a signature. Maximum of three colors.
On Android, when this config is set, the user will not be able to customize each color shown. Defaults to black, blue, green for Android, and black, blue, red for iOS.
<DocumentView
signatureColors={[
{ 'red': 255, 'green': 0, 'blue': 0 },
{ 'red': 0, 'green': 0, 'blue': 0 },
]}
/>function, optional
This function is called when the number of saved signatures has been changed (added or deleted).
<DocumentView
onSavedSignaturesChanged={() => {
console.log('Number of saved signatures changed');
}}
/>array of Config.ThumbnailFilterMode constants, optional
Defines filter modes that should be hidden in the thumbnails browser.
<DocumentView
hideThumbnailFilterModes={[Config.ThumbnailFilterMode.Annotated]}
/>bool, optional, defaults to true
Defines whether user can modify the document using the thumbnail view (eg add/remove/rotate pages).
<DocumentView
thumbnailViewEditingEnabled={true}
/>function, optional
This function is called immediately before a text search begins, either through user actions, or function calls such as findText.
<DocumentView
onTextSearchStart = {() => {
console.log('Text search has started');
}}
/>function, optional
This function is called after a text search is finished or canceled.
Parameters:
| Name | Type | Description |
|---|---|---|
| found | bool | whether a result is found. If no, it could be caused by not finding a matching result in the document, invalid text input, or action cancellation (user actions or cancelFindText) |
| textSelection | object | the text selection, in the format {html: string, unicode: string, pageNumber: number, quads: [[{x: number, y: number}, {x: number, y: number}, {x: number, y: number}, {x: number, y: number}], ...]}. If no such selection could be found, this would be null |
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.
<DocumentView
onTextSearchResult = {({found, textSelection}) => {
if (found) {
console.log('Found selection on page', textSelection.pageNumber);
for (let i = 0; i < textSelection.quads.length; i ++) {
const quad = textSelection.quads[i];
console.log('selection boundary quad', i);
for (const quadPoint of quad) {
console.log('A quad point has coordinates', quadPoint.x, quadPoint.y);
}
}
}
}}
/>bool, optional
Define whether antialiasing should be applied. It is enabled by default
<DocumentView
enableAntialiasing={true}
/>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.
<DocumentView
useStylusAsPen={true}
/>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.
<DocumentView
followSystemDarkMode={false}
/>bool, optional, defaults to true
Defines whether document is automatically saved by the viewer.
<DocumentView
autoSaveEnabled={true}
/>bool, optional, defaults to false
Defines whether to automatically resize the bounding box of free text annotations when editing.
<DocumentView
autoResizeFreeTextEnabled={true}
/>bool, optional, defaults to false
Defines whether to restrict data usage when viewing online PDFs.
<DocumentView
restrictDownloadUsage={true}
/>bool, optional, defaults to true, Android only
Deprecated. Use the showQuickNavigationButton prop instead.
Defines whether the page stack navigation buttons will appear in the viewer.
<DocumentView
pageStackEnabled={false}
/>bool, optional, defaults to true
Defines whether the quick navigation buttons will appear in the viewer.
<DocumentView
showQuickNavigationButton={false}
/>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.
<DocumentView
showNavigationListAsSidePanelOnLargeDevices={true}
/>function, optional
This function is called when the state of the current document's undo/redo stack has been changed.
<DocumentView
onUndoRedoStateChanged = {() => {
console.log("Undo/redo stack state changed");
}}
/>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:
| Name | Type | Description |
|---|---|---|
| path | string | the document path |
this._viewer.getDocumentPath().then((path) => {
console.log('The path to current document is: ' + path);
});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:
| Name | Type | Description |
|---|---|---|
| filePath | string | the location of the saved document, or the base64 string of the pdf in the case of base64 |
this._viewer.saveDocument().then((filePath) => {
console.log('saveDocument:', filePath);
});Sets the color post processing transformation mode for the viewer.
Parameters:
| Name | Type | Description |
|---|---|---|
| colorPostProcessMode | string | color post processing transformation mode, should be a Config.ColorPostProcessMode constant |
this._viewer.setColorPostProcessMode(Config.ColorPostProcessMode.NightMode);Sets the white and black color for the color post processing transformation.
Parameters:
| Name | Type | Description |
|---|---|---|
| whiteColor | object | the white color for the color post processing transformation, in the format {red: number, green: number, blue: number}. alpha could be optionally included (only Android would apply alpha), and all numbers should be in range [0, 255] |
| blackColor | object | the black color for the color post processing transformation, in the same format as whiteColor |
const whiteColor = {"red": 0, "green": 0, "blue": 255};
const blackColor = {"red": 255, "green": 0, "blue": 0};
this._viewer.setColorPostProcessColors(whiteColor, blackColor);Sets the current tool mode.
Returns a Promise.
Parameters:
| Name | Type | Description |
|---|---|---|
| toolMode | string | One of Config.Tools constants, representing to tool mode to set |
this._viewer.setToolMode(Config.Tools.annotationCreateFreeHand).then(() => {
// done switching tools
});Commits the current tool, only available for multi-stroke ink and poly-shape.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| committed | bool | true if either ink or poly-shape tool is committed, false otherwise |
this._viewer.commitTool().then((committed) => {
// committed: true if either ink or poly-shape tool is committed, false otherwise
});Sets the annotation toolbar item corresponding to the given string key enabled/disabled.
Returns a Promise.
Parameters:
| Name | Type | Description |
|---|---|---|
| itemId | string | one of the constants defined in Config.Tools or the Config.CustomToolItemKey.Id defined in a custom tool item object |
| enable | boolean | whether to enable or disable the item |
this._viewer
.setAnnotationToolbarItemEnabled(
Config.Tools.annotationCreateSignature,
false,
)
.then(() => {
console.log('disabled');
});Gets the current page count of the document.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| pageCount | int | the current page count of the document |
this._viewer.getPageCount().then((pageCount) => {
console.log('pageCount', pageCount);
});Sets current page of the document.
Parameters:
| Name | Type | Description |
|---|---|---|
| pageNumber | integer | the page number to be set as the current page; 1-indexed |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| success | bool | whether the setting process was successful |
this._viewer.setCurrentPage(4).then((success) => {
if (success) {
console.log("Current page is set to 4.");
}
});function, optional
This method gets all the fields for a particular page. If no page number is passed the method gets the Fields for all the pages. Additionally if a field of type signature is present it will have a hasAppearance which is a boolean to represent whether a signature field was signed. The hasAppearance field will be undefined for all other fields except signature.
Parameters:
| Name | Type | Description |
|---|---|---|
| pageNumber | integer | the page number to be set as the current page; 1-indexed |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| fields | array | array of field data in the format {fieldName: string, fieldType: string, fieldValue: any,fieldHasAppearance: boolean}, representing the fields that have been changed |
this._viewer.getAllFields(1).then((fields) => {
fields.forEach(field => {
console.log('The name of the field is', field.fieldName);
console.log('The type of the field is', field.fieldType);
console.log('The value of the field is', field.fieldValue);
console.log('The hasAppearance of the field is', field.fieldHasAppearance);
});
});Go to the previous page of the document. If on first page, it would stay on first page.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| success | bool | whether the setting process was successful (no change due to staying in first page counts as being successful) |
this._viewer.gotoPreviousPage().then((success) => {
if (success) {
console.log("Go to previous page.");
}
});Go to the next page of the document. If on last page, it would stay on last page.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| success | bool | whether the setting process was successful (no change due to staying in last page counts as being successful) |
this._viewer.gotoNextPage().then((success) => {
if (success) {
console.log("Go to next page.");
}
});Go to the first page of the document.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| success | bool | whether the setting process was successful |
this._viewer.gotoFirstPage().then((success) => {
if (success) {
console.log("Go to first page.");
}
});Go to the last page of the document.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| success | bool | whether the setting process was successful |
this._viewer.gotoLastPage().then((success) => {
if (success) {
console.log("Go to last page.");
}
});Opens a go-to page dialog. If the user inputs a valid page number into the dialog, the viewer will go to that page.
Returns a Promise.
this._viewer.showGoToPageView();Gets the crop box for specified page as a JSON object.
Parameters:
| Name | Type | Description |
|---|---|---|
| pageNumber | integer | the page number for the target crop box. It is 1-indexed |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| cropBox | object | an object with information about position (x1, y1, x2 and y2) and size (width and height) |
this._viewer.getPageCropBox(1).then((cropBox) => {
console.log('bottom-left coordinate:', cropBox.x1, cropBox.y1);
console.log('top-right coordinate:', cropBox.x2, cropBox.y2);
console.log('width and height:', cropBox.width, cropBox.height);
});Gets the visible pages in the current viewer as an array.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| visiblePages | array | a list of visible pages in the current viewer |
this._viewer.getVisiblePages().then((visiblePages) => {
for (const page of visiblePages) {
console.log('page', page, 'is visible.')
}
});Gets the rotation value of all pages in the current document.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| pageRotation | number | the rotation degree of all pages, one of 0, 90, 180 or 270 (clockwise). |
this._viewer.getPageRotation().then((pageRotation) => {
console.log('The current page rotation degree is' + pageRotation);
});Rotates all pages in the current document in clockwise direction (by 90 degrees).
Returns a Promise.
this._viewer.rotateClockwise();Rotates all pages in the current document in counter-clockwise direction (by 90 degrees).
Returns a Promise.
this._viewer.rotateCounterClockwise();Displays a rotate dialog. Android only.
The dialog allows users to rotate pages of the opened document by 90, 180 and 270 degrees. It also displays a thumbnail of the current page at the selected rotation angle.
Returns a Promise.
this._viewer.showRotateDialog();Imports remote annotation command to local document. Can be used in both local and collaboration mode.
Parameters:
| Name | Type | Description |
|---|---|---|
| xfdfCommand | string | the XFDF command string |
| initialLoad | bool | whether this is for initial load. Will be false by default |
Returns a Promise.
const xfdfCommand = '<?xml version="1.0" encoding="UTF-8"?><xfdf xmlns="http://ns.adobe.com/xfdf/" xml:space="preserve"><add><circle style="solid" width="5" color="#E44234" opacity="1" creationdate="D:20201218025606Z" flags="print" date="D:20201218025606Z" name="9d0f2d63-a0cc-4f06-b786-58178c4bd2b1" page="0" rect="56.4793,584.496,208.849,739.369" title="PDF" /></add><modify /><delete /><pdf-info import-version="3" version="2" xmlns="http://www.pdftron.com/pdfinfo" /></xfdf>';
this._viewer.importAnnotationCommand(xfdfCommand);Imports XFDF annotation string to the current document. Can be used in both local and collaboration mode.
Parameters:
| Name | Type | Description |
|---|---|---|
| xfdf | string | annotation string in XFDF format for import |
| replace | boolean | whether to replace existing form and annotation data with those imported from the XFDF string |
Returns a Promise. Promise Parameters:
| Name | Type | Description |
|---|---|---|
| importedAnnotations | Array | A list of Annotation object that contain id and pageNumber as members |
const xfdf = '<?xml version="1.0" encoding="UTF-8"?>\n<xfdf xmlns="http://ns.adobe.com/xfdf/" xml:space="preserve">\n\t<add>\n\t\t<circle style="solid" width="5" color="#E44234" opacity="1" creationdate="D:20220406184336Z" flags="print" date="D:20220406184336Z" name="ca1165b2-5cd3-43f7-adcd-ff1ad13bceeb" page="1" rect="277.088,681.657,334.525,737.238" title="" />\n\t</add>\n\t<modify />\n\t<delete />\n\t<pdf-info import-version="4" version="2" xmlns="http://www.pdftron.com/pdfinfo" />\n</xfdf>';
this._viewer.importAnnotations(xfdf).then((importedAnnotations)=>{
importedAnnotations.forEach((annotation) => {
console.log("id: " + annotation.id);
console.log("pageNumber: " + annotation.pageNumber);
})
});Extracts XFDF from the current document.
Parameters:
| Name | Type | Description |
|---|---|---|
| options | object | key: annotList, type: array. If specified, annotations with the matching id and pageNumber will be exported; otherwise, all annotations in the current document will be exported. |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| xfdf | string | annotation string in XFDF format |
Without options:
this._viewer.exportAnnotations().then((xfdf) => {
console.log('XFDF for all annotations:', xfdf);
});With options:
// annotList is an array of annotation data in the format {id: string, pageNumber: int}
const annotations = [{id: 'annot1', pageNumber: 1}, {id: 'annot2', pageNumber: 3}];
this._viewer.exportAnnotations({annotList: annotations}).then((xfdf) => {
console.log('XFDF for 2 specified annotations', xfdf);
});Flattens the forms and (optionally) annotations in the current document.
Parameters:
| Name | Type | Description |
|---|---|---|
| formsOnly | bool | Defines whether only forms are flattened. If false, all annotations will be flattened |
Returns a Promise.
// flatten forms and annotations in the current document.
this._viewer.flattenAnnotations(false);Deletes the specified annotations in the current document.
Parameters:
| Name | Type | Description |
|---|---|---|
| annotations | array | Defines which annotation to be deleted. Each element is in the format {id: string, pageNumber: int} |
Returns a Promise.
// delete annotations in the current document.
this._viewer.deleteAnnotations([
{
id: 'annotId1',
pageNumber: 1,
},
{
id: 'annotId2',
pageNumber: 2,
}
]);Selects the specified annotation in the current document.
Parameters:
| Name | Type | Description |
|---|---|---|
| id | string | the id of the target annotation |
| pageNumber | integer | the page number where the targe annotation is located. It is 1-indexed |
Returns a Promise.
// select annotation in the current document.
this._viewer.selectAnnotation('annotId1', 1);Sets flags for specified annotations in the current document. The flagValue controls whether a flag will be set to or removed from the annotation.
Note: the old function setFlagForAnnotations is deprecated. Please use this one.
Parameters:
| Name | Type | Description |
|---|---|---|
| annotationFlagList | array | A list of annotation flag operations. Each element is in the format {id: string, pageNumber: int, flag: One of Config.AnnotationFlags constants, flagValue: bool} |
Returns a Promise.
// Set flag for annotations in the current document.
this._viewer.setFlagsForAnnotations([
{
id: 'annotId1',
pageNumber: 1,
flag: Config.AnnotationFlags.noView,
flagValue: true
},
{
id: 'annotId2',
pageNumber: 5,
flag: Config.AnnotationFlags.lockedContents,
flagValue: false
}
]);Sets properties for specified annotation in the current document, if it is valid.
Note: the old function setPropertyForAnnotation is deprecated. Please use this one.
Parameters:
| Name | Type | Description |
|---|---|---|
| annotationId | string | the unique id of the annotation |
| pageNumber | integer | the page number where annotation is located. It is 1-indexed |
| propertyMap | object | an object containing properties to be set. Available properties are listed below |
Properties in propertyMap:
| Name | Type | Markup exclusive | Example |
|---|---|---|---|
| rect | object | no | {x1: 1, y1: 2, x2: 3, y2: 4} |
| contents | string | no | "contents" |
| subject | string | yes | "subject" |
| title | string | yes | "title" |
| contentRect | object | yes | {x1: 1, y1: 2, x2: 3, y2: 4} |
| customData | object | no | {key: value} |
| strokeColor | object | no | {red: 255, green: 0, blue: 0} |
Returns a promise.
// Set properties for annotation in the current document.
this._viewer.setPropertiesForAnnotation('Pdftron', 1, {
rect: {
x1: 1.1, // left
y1: 3, // bottom
x2: 100.9, // right
y2: 99.8 // top
},
contents: 'Hello World',
subject: 'Sample',
title: 'set-prop-for-annot',
customData: {
key1: 'value1',
key2: 'value2',
key3: 'value3'
},
strokeColor: {
"red": 255,
"green": 0,
"blue": 0
}
});Gets properties for specified annotation in the current document, if it is valid.
Parameters:
| Name | Type | Description |
|---|---|---|
| annotationId | string | the unique id of the annotation |
| pageNumber | integer | the page number where annotation is located. It is 1-indexed |
Available Properties:
| Name | Type | Markup exclusive | Example |
|---|---|---|---|
| rect | object | no | {x1: 1, y1: 1, x2: 2, y2: 2, width: 1, height: 1} |
| contents | string | no | "Contents" |
| subject | string | yes | "Subject" |
| title | string | yes | "Title" |
| contentRect | object | yes | {x1: 1, y1: 1, x2: 2, y2: 2, width: 1, height: 1} |
| strokeColor | object | no | {red: 255, green: 0, blue: 0} |
Returns a promise.
Promise Parameters:
| Name | Type | Description | Example |
|---|---|---|---|
| propertyMap | object | the non-null properties of the annotation | {contents: 'Contents', strokeColor: {red: 255, green: 0, blue: 0}, rect: {x1: 1, y1: 1, x2: 2, y2: 2, width: 1, height: 1}} |
// Get properties for annotation in the current document.
this._viewer.getPropertiesForAnnotation('Pdftron', 1).then((properties) => {
if (properties) {
console.log('Properties for annotation: ', properties);
}
})Sets whether all annotations and forms should be rendered. This method affects the viewer and does not change the document.
Unlike setVisibilityForAnnotation, this method is used to show and hide all annotations and forms in the viewer.
Parameters:
| Name | Type | Description |
|---|---|---|
| drawAnnotations | bool | whether all annotations and forms should be rendered |
Returns a promise.
this._viewer.setDrawAnnotations(false);Sets visibility for specified annotation in the current document, if it is valid. Note that if drawAnnotations is set to false in the viewer, this function would not render the annotation even if visibility is true.
Parameters:
| Name | Type | Description |
|---|---|---|
| annotationId | string | the unique id of the annotation |
| pageNumber | integer | the page number where annotation is located. It is 1-indexed |
| visibility | bool | whether the annotation should be visible |
Returns a promise.
this._viewer.setVisibilityForAnnotation('Pdftron', 1, true);Enables or disables highlighting form fields. It is disabled by default.
Parameters:
| Name | Type | Description |
|---|---|---|
| highlightFields | bool | whether form fields should be highlighted |
this._viewer.setHighlightFields(true);Gets an annotation at the (x, y) position in screen coordinates, if any.
Parameters:
| Name | Type | Description |
|---|---|---|
| x | integer | the x-coordinate of the point |
| y | integer | the y-coordinate of the point |
| distanceThreshold | double | maximum distance from the point (x, y) to the annotation for it to be considered a hit (in dp) |
| minimumLineWeight | double | For very thin lines, it is almost impossible to hit the actual line. This specifies a minimum line thickness (in screen coordinates) for the purpose of calculating whether a point is inside the annotation or not (in dp) |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| annotation | object | the annotation found in the format of {id: string, pageNumber: number, type: string, screenRect: {x1: number, y1: number, x2: number, y2: number, width: number, height: number}, pageRect: {x1: number, y1: number, x2: number, y2: number, width: number, height: number}}. type is one of the Config.Tools constants. screenRect was formerly called rect. |
this._viewer.getAnnotationAtPoint(167, 287, 100, 10).then((annotation) => {
if (annotation) {
console.log('Annotation found at point (167, 287) has id:', annotation.id);
}
})Gets the list of annotations at a given line in screen coordinates. Note that this is not an area selection. It should be used similar to getAnnotationAtPoint, except that this should be used when you want to get multiple annotations which are overlaying with each other.
Parameters:
| Name | Type | Description |
|---|---|---|
| x1 | integer | the x-coordinate of an endpoint on the line |
| y1 | integer | the y-coordinate of an endpoint on the line |
| x2 | integer | the x-coordinate of the other endpoint on the line, usually used as a threshold |
| y2 | integer | the y-coordinate of the other endpoint on the line, usually used as a threshold |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| annotations | array | list of annotations at the target line, each in the format of {id: string, pageNumber: number, type: string, screenRect: {x1: number, y1: number, x2: number, y2: number, width: number, height: number}, pageRect: {x1: number, y1: number, x2: number, y2: number, width: number, height: number}}. type is one of the Config.Tools constants. screenRect was formerly called rect. |
this._viewer.getAnnotationListAt(0, 0, 200, 200).then((annotations) => {
for (const annotation of annotations) {
console.log('Annotation found at line has id:', annotation.id);
}
})Gets the list of annotations on a given page.
Parameters:
| Name | Type | Description |
|---|---|---|
| pageNumber | integer | the page number where annotations are located. It is 1-indexed |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| annotations | array | list of annotations on the target page, each in the format of {id: string, pageNumber: number, type: string, screenRect: {x1: number, y1: number, x2: number, y2: number, width: number, height: number}, pageRect: {x1: number, y1: number, x2: number, y2: number, width: number, height: number}}. type is one of the Config.Tools constants. screenRect was formerly called rect. |
this._viewer.getAnnotationsOnPage(2).then((annotations) => {
for (const annotation of annotations) {
console.log('Annotation found on page 2 has id:', annotation.id);
}
})Gets an annotation's customData property.
Parameters:
| Name | Type | Description |
|---|---|---|
| annotationId | string | the unique id of the annotation |
| pageNumber | integer | the page number where annotation is located. It is 1-indexed |
| key | string | the unique key associated with the customData property |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| value | string | the customData property associated with the given key |
this._viewer.setPropertiesForAnnotation("annotation1", 2, {
customData: {
data: "Nice annotation"
}
}).then(() => {
this._viewer.getCustomDataForAnnotation("annotation1", 2, "data").then((value) => {
console.log(value === "Nice annotation");
})
})Sets a field flag value on one or more form fields.
Parameters:
| Name | Type | Description |
|---|---|---|
| fields | array | list of field names for which the flag should be set |
| flag | int | flag to be set. Number should be a Config.FieldFlags constant |
| value | bool | value to set for flag |
Returns a Promise.
this._viewer.setFlagForFields(['First Name', 'Last Name'], Config.FieldFlags.ReadOnly, true);Sets field values on one or more form fields.
Note: the old function setValueForFields is deprecated. Please use this one instead.
Parameters:
| Name | Type | Description |
|---|---|---|
| fieldsMap | object | map of field names and values which should be set |
Returns a Promise.
this._viewer.setValuesForFields({
'textField1': 'Test',
'textField2': 1234,
'checkboxField1': true,
'checkboxField2': false,
'radioButton1': 'Yes',
'radioButton2': 'No'
});Get type and value information of a field using its name.
Parameters:
| Name | Type | Description |
|---|---|---|
| fieldName | string | name of the field |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| field | object | an object with information key fieldName, fieldValue (undefined for fields with no values) and fieldType(one of button, checkbox, radio, text, choice, signature and unknown), or undefined if such field does not exist |
this._viewer.getField('someFieldName').then((field) => {
if (field !== undefined) {
console.log('field name:', field.fieldName);
console.log('field value:', field.fieldValue);
console.log('field type:', field.fieldType);
}
});Displays the annotation tab of the existing list container. If this tab has been disabled, the method does nothing.
Returns a Promise.
this._viewer.openAnnotationList();Display a page thumbnails view.
This view allows users to navigate pages of a document. If thumbnailViewEditingEnabled is true, the user can also manipulate the document, including add, remove, re-arrange, rotate and duplicate pages.
Returns a Promise.
this._viewer.openThumbnailsView();Sets the current annotationToolbar for the viewer.
Returns a Promise.
Parameters:
| Name | Type | Description |
|---|---|---|
| toolbar | string | the toolbar to enable. Should be one of the Config.DefaultToolbars constants or the id of a custom toolbar object. |
this._viewer.setCurrentToolbar(Config.DefaultToolbars.Insert).then(() => {
// done switching toolbar
});Handles the back button in search mode. Android only.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| handled | bool | whether the back button is handled successfully |
this._viewer.handleBackButton().then((handled) => {
if (!handled) {
BackHandler.exitApp();
}
});Imports user bookmarks into the document. The input needs to be a valid bookmark JSON format.
Parameters:
| Name | Type | Description |
|---|---|---|
| bookmarkJson | String | needs to be in valid bookmark JSON format, for example {"0": "Page 1"}. The page numbers are 1-indexed |
Returns a Promise.
this._viewer.importBookmarkJson("{\"0\": \"Page 1\", \"3\": \"Page 4\"}");Displays the bookmark tab of the existing list container. If this tab has been disabled, the method does nothing.
Returns a Promise.
this._viewer.openBookmarkList();Closes all tabs in a multi-tab environment.
Returns a Promise.
// Do this only when DocumentView has multiTabEnabled = true
this._viewer.closeAllTabs();Opens the tab switcher in a multi-tab environment.
Returns a Promise.
// Do this only when DocumentView has multiTabEnabled = true
this._viewer.openTabSwitcher();Returns the current zoom scale of current document viewer.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| zoom | double | current zoom scale in the viewer |
this._viewer.getZoom().then((zoom) => {
console.log('Zoom scale of the current document is:', zoom);
});Sets the minimum and maximum zoom bounds of current viewer.
Parameters:
| Name | Type | Description |
|---|---|---|
| zoomLimitMode | String | one of the constants in Config.ZoomLimitMode, defines whether bounds are relative to the standard zoom scale in the current viewer or absolute |
| minimum | double | the lower bound of the zoom limit range |
| maximum | double | the upper bound of the zoom limit range |
Returns a Promise.
this._viewer.setZoomLimits(Config.ZoomLimitMode.Absolute, 1.0, 3.5);Sets the zoom scale in the current document viewer with a zoom center.
Parameters:
| Name | Type | Description |
|---|---|---|
| zoom | double | the zoom ratio to be set |
| x | int | the x-coordinate of the zoom center |
| y | int | the y-coordinate of the zoom center |
Returns a Promise.
this._viewer.zoomWithCenter(3.0, 100, 300);Zoom the viewer to a specific rectangular area in a page.
Parameters:
| Name | Type | Description |
|---|---|---|
| pageNumber | int | the page number of the zooming area (1-indexed) |
| rect | map | The rectangular area with keys x1 (left), y1(bottom), y1(right), y2(top). Coordinates are in double |
Returns a Promise.
this._viewer.zoomToRect(3, {'x1': 1.0, 'y1': 2.0, 'x2': 3.0, 'y2': 4.0});Zoom to a paragraph that contains the specified coordinate. If no paragraph contains the coordinate, the zooming would not happen.
Parameters:
| Name | Type | Description |
|---|---|---|
| x | int | the x-coordinate of the target coordinate |
| y | int | the y-coordinate of the target coordinate |
| animated | bool | whether the transition is animated |
Returns a Promise.
this._viewer.smartZoom(100, 200, true);Returns the horizontal and vertical scroll position of current document viewer.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| horizontal | number | current horizontal scroll position |
| vertical | number | current vertical scroll position |
this._viewer.getScrollPos().then(({horizontal, vertical}) => {
console.log('Current horizontal scroll position is:', horizontal);
console.log('Current vertical scroll position is:', vertical);
});Returns whether the viewer is currently in reflow mode.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| inReflow | bool | whether the viewer is in reflow mode |
this._viewer.isReflowMode().then((inReflow) => {
console.log(inReflow ? 'in reflow mode' : 'not in reflow mode');
});Allows the user to programmatically enter and exit reflow mode.
Returns a promise.
this._viewer.toggleReflow();Returns the canvas size of current document viewer.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| width | number | current width of canvas |
| height | number | current height of canvas |
this._viewer.getCanvasSize().then(({width, height}) => {
console.log('Current canvas width is:', width);
console.log('Current canvas height is:', height);
});Converts points from page coordinates to screen coordinates in the viewer.
Parameters:
| Name | Type | Description |
|---|---|---|
| points | array | list of points, each in the format {x: number, y: number}. You could optionally have a pageNumber: number in the object. Without specifying, the page system is referring to the current page |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| convertedPoints | array | list of converted points in screen system, each in the format {x: number, y: number}. It would be empty if conversion is unsuccessful |
// convert (50, 50) on current page and (100, 100) on page 1 from page system to screen system
this._viewer.convertPagePointsToScreenPoints([{x: 50, y: 50}, {x: 100, y:100, pageNumber: 1}]).then((convertedPoints) => {
convertedPoints.forEach(point => {
console.log(point);
})
});Converts points from screen coordinates to page coordinates in the viewer.
Parameters:
| Name | Type | Description |
|---|---|---|
| points | array | list of points, each in the format {x: number, y: number}. You could optionally have a pageNumber: number in the object. Without specifying, the page system is referring to the current page |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| convertedPoints | array | list of converted points in page system, each in the format {x: number, y: number}. It would be empty if conversion is unsuccessful |
// convert (50, 50) and (100, 100) from screen system to page system, on current page and page 1 respectively
this._viewer.convertScreenPointsToPagePoints([{x: 50, y: 50}, {x: 100, y:100, pageNumber: 1}]).then((convertedPoints) => {
convertedPoints.forEach(point => {
console.log(point);
})
});Returns the page number that contains the point on screen.
Parameters:
| Name | Type | Description |
|---|---|---|
| x | number | the x-coordinate of the screen point |
| y | number | the y-coordinate of the screen point |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| pageNumber | number | the page number of the screen point |
this._viewer.getPageNumberFromScreenPoint(10.0,50.5).then((pageNumber) => {
console.log('The page number of the screen point is', pageNumber);
});Sets whether the control will render progressively or will just draw once the entire view has been rendered.
Parameters:
| Name | Type | Description |
|---|---|---|
| progressiveRendering | bool | whether to render progressively |
| initialDelay | number | delay before the progressive rendering timer is started, in milliseconds |
| interval | number | delay between refreshes, in milliseconds |
Returns a Promise.
// delay for 10s before start, and refresh every 1s
this._viewer.setProgressiveRendering(true, 10000, 1000);Enables or disables image smoothing. The rasterizer allows a trade-off between rendering quality and rendering speed. This function can be used to indicate the preference between rendering speed and quality.
Parameters:
| Name | Type | Description |
|---|---|---|
| imageSmoothing | bool | whether to enable image smoothing |
Returns a Promise.
this._viewer.setImageSmoothing(false);Enables or disables support for overprint and overprint simulation. Overprint is a device dependent feature and the results will vary depending on the output color space and supported colorants (i.e. CMYK, CMYK+spot, RGB, etc).
Parameters:
| Name | Type | Description |
|---|---|---|
| overprint | string | the mode of overprint, should be a Config.OverprintMode constant |
Returns a Promise.
this._viewer.setOverprint(Config.OverprintMode.Off);Sets whether borders of each page are visible in the viewer, which is disabled by default.
Parameters:
| Name | Type | Description |
|---|---|---|
| pageBorderVisibility | bool | whether borders of each page are visible in the viewer |
this._viewer.setPageBorderVisibility(true);Enables or disables transparency grid (check board pattern) to reflect page transparency, which is disabled by default.
Parameters:
| Name | Type | Description |
|---|---|---|
| pageTransparencyGrid | bool | whether to use the transparency grid |
this._viewer.setPageTransparencyGrid(true);Sets the background color of the viewer.
Parameters:
| Name | Type | Description |
|---|---|---|
| backgroundColor | object | the background color, in the format {red: number, green: number, blue: number}, each number in range [0, 255] |
this._viewer.setBackgroundColor({red: 0, green: 0, blue: 255}); // blue colorSets the default page color of the viewer.
Parameters:
| Name | Type | Description |
|---|---|---|
| defaultPageColor | object | the default page color, in the format {red: number, green: number, blue: number}, each number in range [0, 255] |
this._viewer.setDefaultPageColor({red: 0, green: 255, blue: 0}); // green colorSearch for a term and all matching results will be highlighted.
Returns a Promise.
Parameters:
| Name | Type | Description |
|---|---|---|
| searchString | string | the text to search for |
| matchCase | bool | indicates if it is case sensitive |
| matchWholeWord | bool | indicates if it matches an entire word only |
this._viewer.startSearchMode('PDFTron', false, false);Finishes the current text search and remove all the highlights.
Returns a Promise.
this._viewer.exitSearchMode();Searches asynchronously, starting from the current page, for the given text. PDFViewCtrl automatically scrolls to the position so that the found text is visible.
Returns a Promise.
Parameters:
| Name | Type | Description |
|---|---|---|
| searchString | string | the text to search for |
| matchCase | bool | indicates if it is case sensitive |
| matchWholeWord | bool | indicates if it matches an entire word only |
| searchUp | bool | indicates if it searches upward |
| regExp | bool | indicates if searchString is a regular expression |
this._viewer.findText('PDFTron', false, false, true, false);Cancels the current text search thread, if exists.
Returns a Promise.
this._viewer.cancelFindText();Displays a search bar that allows the user to enter and search text within a document.
Returns a Promise.
this._viewer.openSearch();Returns the text selection on a given page, if any.
Parameters:
| Name | Type | Description |
|---|---|---|
| pageNumber | number | the specified page number. It is 1-indexed |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| selection | object | the text selection, in the format {html: string, unicode: string, pageNumber: number, quads: [[{x: number, y: number}, {x: number, y: number}, {x: number, y: number}, {x: number, y: number}], ...]}. If no such selection could be found, this would be null |
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.
this._viewer.getSelection(2).then((selection) => {
if (selection) {
console.log('Found selection on page', selection.pageNumber);
for (let i = 0; i < selection.quads.length; i ++) {
const quad = selection.quads[i];
console.log('selection boundary quad', i);
for (const quadPoint of quad) {
console.log('A quad point has coordinates', quadPoint.x, quadPoint.y);
}
}
}
});Returns whether there is a text selection in the current document.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| hasSelection | bool | whether a text selection exists |
this._viewer.hasSelection().then((hasSelection) => {
console.log('There is a selection in the document.');
});Clears any text selection in the current document.
Returns a Promise.
this._viewer.clearSelection();Returns the page range (beginning and end) that has text selection on it.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| begin | number | the first page to have selection, -1 if there are no selections |
| end | number | the last page to have selection, -1 if there are no selections |
this._viewer.getSelectionPageRange().then(({begin, end}) => {
if (begin === -1) {
console.log('There is no selection');
} else {
console.log('The selection range is from', begin, 'to', end);
}
});Returns whether there is a text selection on the specified page in the current document.
Parameters:
| Name | Type | Description |
|---|---|---|
| pageNumber | number | the specified page number. It is 1-indexed |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| hasSelection | bool | whether a text selection exists on the specified page |
this._viewer.hasSelectionOnPage(5).then((hasSelection) => {
if (hasSelection) {
console.log('There is a selection on page 5 in the document.');
}
});Selects the text within the given rectangle region.
Parameters:
| Name | Type | Description |
|---|---|---|
| rect | object | the rectangle region in the format of x1: number, x2: number, y1: number, y2: number |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| selected | bool | whether there is text selected |
this._viewer.selectInRect({x1: 0, y1: 0, x2: 200.5, y2: 200.5}).then((selected) => {
console.log(selected);
});Returns whether there is text in given rectangle region.
Parameters:
| Name | Type | Description |
|---|---|---|
| rect | object | the rectangle region in the format of x1: number, x2: number, y1: number, y2: number |
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| hasText | bool | whether there is text in the region |
this._viewer.isThereTextInRect({x1: 0, y1: 0, x2: 200, y2: 200}).then((hasText) => {
console.log(hasText);
});Selects all text on the page.
Returns a Promise.
this._viewer.selectAll();Undo the last modification.
Returns a Promise.
this._viewer.undo();Redo the last modification.
Returns a Promise.
this._viewer.redo();Checks whether an undo operation can be performed from the current snapshot.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| canUndo | bool | whether it is possible to undo from the current snapshot |
this._viewer.canUndo().then((canUndo) => {
console.log(canUndo ? 'undo possible' : 'no action to undo');
});Checks whether a redo operation can be perfromed from the current snapshot.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| canRedo | bool | whether it is possible to redo from the current snapshot |
this._viewer.canRedo().then((canRedo) => {
console.log(canRedo ? 'redo possible' : 'no action to redo');
});Gets a list of absolute file paths to PDFs containing the saved signatures.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| signatures | array | an array of string containing the absolute file paths; if there are no saved signatures, the value is an empty array |
this._viewer.getSavedSignatures().then((signatures) => {
if (signatures.length > 0) {
signatures.forEach((signature) => {
console.log(signature);
});
}
})Retrieves the absolute file path to the folder containing the saved signature PDFs.
For Android, to get the folder containing the saved signature JPGs, use getSavedSignatureJpgFolder.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| path | string | the absolute file path to the folder |
this._viewer.getSavedSignatureFolder().then((path) => {
if (path != null) {
console.log(path);
}
})Retrieves the absolute file path to the folder containing the saved signature JPGs. Android only.
To get the folder containing the saved signature PDFs, use getSavedSignatureFolder.
Returns a Promise.
Promise Parameters:
| Name | Type | Description |
|---|---|---|
| path | string | the absolute file path to the folder |
this._viewer.getSavedSignatureJpgFolder().then((path) => {
if (path != null) {
console.log(path);
}
})Export a PDF page to an image format defined in Config.ExportFormat.
Unlike RNPdftron.exportAsImage, this is a viewer method and should only be called after the document has been loaded or else unexpected behaviour can occur. This method uses the PDF that is associated with the viewer, and does not take a local file path to the desired PDF.
Parameters:
| Name | Type | Description |
|---|---|---|
| pageNumber | int | the page to be converted; if the value does not refer to a valid page number, the file path will be undefined |
| dpi | double | the output image resolution |
| exportFormat | string | one of the Config.ExportFormat constants |
| transparent | boolean | (only relevant when exported as PNG) whether the background of the image is transparent or opaque white |
Returns a Promise.
| Name | Type | Description |
|---|---|---|
| path | string | the temp path of the created image, user is responsible for clean up the cache |
this._viewer.exportAsImage(1, 92, Config.ExportFormat.BMP, false).then((path) => {
console.log('export', path);
});Displays the page crop option. Android only.
Returns a Promise.
this._viewer.showCrop();Displays the outline tab of the existing list container. If this tab has been disabled, the method does nothing.
Returns a Promise.
this._viewer.openOutlineList();On Android it displays the layers dialog while on iOS it displays the layers tab of the existing list container. If this tab has been disabled or there are no layers in the document, the method does nothing.
Returns a Promise.
this._viewer.openLayersList();Displays the existing list container. Its current tab will be the one last opened.
Returns a Promise.
this._viewer.openNavigationLists();Displays the view settings.
Requires a source rect in screen co-ordinates. On iOS this rect will be the anchor point for the view. The rect is ignored on Android.
Returns a Promise.
Parameters:
| Name | Type | Description |
|---|---|---|
| rect | map | The rectangular area in screen co-ordinates with keys x1 (left), y1(bottom), y1(right), y2(top). Coordinates are in double format. |
this._viewer.showViewSettings({'x1': 10.0, 'y1': 10.0, 'x2': 20.0, 'y2': 20.0});Displays the add pages view.
Requires a source rect in screen co-ordinates. On iOS this rect will be the anchor point for the view. The rect is ignored on Android.
Returns a Promise.
Parameters:
| Name | Type | Description |
|---|---|---|
| rect | map | The rectangular area in screen co-ordinates with keys x1 (left), y1(bottom), y1(right), y2(top). Coordinates are in double format. |
this._viewer.showAddPagesView({'x1': 10.0, 'y1': 10.0, 'x2': 20.0, 'y2': 20.0});Displays the share copy view.
Requires a source rect in screen co-ordinates. On iOS this rect will be the anchor point for the view. The rect is ignored on Android.
Returns a Promise.
Parameters:
| Name | Type | Description |
|---|---|---|
| rect | map | The rectangular area in screen co-ordinates with keys x1 (left), y1(bottom), y1(right), y2(top). Coordinates are in double format. |
| flattening | bool | Whether the shared copy should be flattened before sharing. |
this._viewer.shareCopy({'x1': 10.0, 'y1': 10.0, 'x2': 20.0, 'y2': 20.0}, true);Forces application theme to either Config.ThemeOptions constants, optional
Requires followSystemDarkMode={false} in order for functionality of this prop
<DocumentView
forceAppTheme={Config.ThemeOptions.ThemeDark}
/>Sets the form field's highlight color on the PDF.
Parameters:
| Name | Type | Description |
|---|---|---|
| fieldHightlightColor | object | the form field highlight color, in the format {red: number, green: number, blue: number, alpha: number}, each number in range [0, 255] |
this._viewer.setFormFieldHighlightColor({red: 0, green: 0, blue: 255, alpha: 128}); // blue colorbool, optional, defaults to true (Android Only)
Defines whether the viewer disables long press quick menu in read-only. If false, the UI will not allow the user to long press to open the quick menu.
<DocumentView
enableReadingModeQuickMenu={false}
/>