PDFTron React Native

Config

Defines configuration constants for the viewer. See Config.ts for the full list of constants.

Due to the length of the source file, we have included links to the exact lines of the source code where these APIs have been implemented.

Source: Config.js line 1

Members

Buttons

Buttons define the various kinds of buttons for the viewer

Source: Config.js line 18
Constants:
  • editToolButton
  • viewControlsButton
  • freeHandToolButton
  • highlightToolButton
  • underlineToolButton
  • squigglyToolButton
  • strikeoutToolButton
  • rectangleToolButton
  • ellipseToolButton
  • lineToolButton
  • arrowToolButton
  • polylineToolButton
  • polygonToolButton
  • cloudToolButton
  • signatureToolButton
  • freeTextToolButton
  • stickyToolButton
  • calloutToolButton
  • stampToolButton
  • toolsButton
  • searchButton
  • shareButton
  • editPagesButton
  • viewLayersButton
  • printButton
  • closeButton
  • saveCopyButton
  • saveIdenticalCopyButton
  • saveFlattenedCopyButton
  • formToolsButton
  • fillSignToolsButton
  • moreItemsButton
  • digitalSignatureButton
  • thumbnailsButton
  • listsButton
  • thumbnailSlider
  • outlineListButton
  • annotationListButton
  • userBookmarkListButton
  • reflowButton
  • editMenuButton
  • cropPageButton
  • undo
  • redo
  • addPageButton
  • saveReducedCopyButton
  • saveCroppedCopyButton
  • savePasswordCopyButton

Tools

Tools define the various kinds of tools for the viewer

Source: Config.js line 73
Constants:
  • annotationEdit
  • textSelect
  • multiSelect
  • pan
  • annotationEraserTool
  • annotationCreateSticky
  • annotationCreateFreeHand
  • annotationCreateTextHighlight
  • annotationCreateTextUnderline
  • annotationCreateTextSquiggly
  • annotationCreateTextStrikeout
  • annotationCreateFreeText
  • annotationCreateCallout
  • annotationCreateSignature
  • annotationCreateLine
  • annotationCreateArrow
  • annotationCreatePolyline
  • annotationCreateStamp
  • annotationCreateRubberStamp
  • annotationCreateRectangle
  • annotationCreateEllipse
  • annotationCreatePolygon
  • annotationCreatePolygonCloud
  • annotationCreateDistanceMeasurement
  • annotationCreatePerimeterMeasurement
  • annotationCreateAreaMeasurement
  • annotationCreateFileAttachment
  • annotationCreateSound
  • annotationCreateRedaction
  • annotationCreateLink
  • annotationCreateRedactionText
  • annotationCreateLinkText
  • annotationCreateFreeHighlighter
  • annotationCreateSmartPen
  • formCreateTextField
  • formCreateCheckboxField
  • formCreateSignatureField
  • formCreateRadioField
  • formCreateComboBoxField
  • formCreateListBoxField
  • pencilKitDrawing

FitMode

FitMode define how a page should fit relative to the viewer, alternatively, the default zoom level

Source: Config.js line 122
Constants:
  • FitPage
  • FitWidth
  • FitHeight
  • Zoom

LayoutMode

LayoutMode defines the layout mode of the viewer

Source: Config.js line 132
Constants:
  • Single
  • Continuous
  • Facing
  • FacingContinuous
  • FacingCover
  • FacingCoverContinuous

FieldFlags

FieldFlags define the property flags for a form field

Source: Config.js line 144
Constants:
  • ReadOnly
  • Required

AnnotationMenu

AnnotationMenu defines the menu items when an annotation is selected

Source: Config.js line 152
Constants:
  • style
  • note
  • copy
  • duplicate
  • delete
  • flatten
  • editText
  • editInk
  • search
  • share
  • markupType
  • read
  • screenCapture
  • playSound
  • openAttachment
  • calibrate

EraserType

EraserType defines the type of eraser that will be used when eraser is selected

Source: Config.js line 174
Constants:
  • annotationEraser
  • hybrideEraser
  • inkEraser

LongPressMenu

LongPressMenu defines the menu items when a long press on empty space or text occurs

Source: Config.js line 183
Constants:
  • copy
  • paste
  • search
  • share
  • read

Actions

Actions define potentially overridable action to the viewer

Source: Config.js line 194
Constants:
  • linkPress
  • stickyNoteShowPopUp

AnnotationFlags

AnnotationFlags define the flags for any annotation in the document

Source: Config.js line 202
Constants:
  • hidden
  • invisible
  • locked
  • lockedContents
  • noRotate
  • noView
  • noZoom
  • print
  • readOnly
  • toggleNoView

DefaultToolbars

DefaultToolbars define a set of pre-designed toolbars for easier customization

Source: Config.js line 218
Constants:
  • View
  • Annotate
  • Draw
  • Insert
  • FillAndSign
  • PrepareForm
  • Measure
  • Pens
  • Redaction
  • Favorite

ToolbarIcons

ToolbarIcons define default toolbar icons for use for potential custom toolbars

Source: Config.js line 234
Constants:
  • View
  • Annotate
  • Draw
  • Insert
  • FillAndSign
  • PrepareForm
  • Measure
  • Pens
  • Redaction
  • Favorite

CustomToolbarKey

CustomToolbarKey defines the necessary keys for a custom toolbar

Source: Config.js line 250
Constants:
  • Id
  • Name
  • Icon
  • Items

ThumbnailFilterMode

ThumbnailFilterMode defines filter modes in the thumbnails browser

Source: Config.js line 260
Constants:
  • Annotated
  • Bookmarked

Conversion

Conversion defines conversion sources and destinations

Source: Config.js line 268
Constants:
  • Screen
  • Canvas
  • Page

ViewModePickerItem

ViewModePickerItem defines view mode items in the view mode dialog

Source: Config.js line 277
Constants:
  • Crop
  • Rotation
  • ColorMode

ZoomLimitMode

ZoomLimitMode defines the limit mode for zoom in the current document viewer

Source: Config.js line 286
Constants:
  • None
  • Absolute
  • Relative

OverprintMode

OverprintMode defines when overprint would be applied in the viewer

Source: Config.js line 295
Constants:
  • On
  • Off
  • OnlyPDFX

ColorPostProcessMode

ColorPostProcessMode defines color modifications after rendering in the viewer

Source: Config.js line 304
Constants:
  • None
  • Invert
  • GradientMap
  • NightMode

ReflowOrientation

ReflowOrientation defines the scrolling direction when in reflow viewing mode

Source: Config.js line 314
Constants:
  • Horizontal
  • Vertical

ExportFormat

Export to format

Source: Config.js line 322
Constants:
  • BMP
  • JPEG
  • PNG

AnnotationManagerEditMode

AnnotationManagerEditMode determines whose changes can be edited.

Source: Config.js line 331
Constants:
  • Own
  • All

AnnotationManagerUndoMode

AnnotationManagerUndoMode determines whose changes can be undone.

Source: Config.js line 339
Constants:
  • Own
  • All