Methods

NutrientOverlay()

A transparent layer that renders React Native components anchored to positions on the PDF, keeping them in sync with pan and zoom. Place it as a sibling of `` inside a container the view fills, so the overlay and the view share the same frame origin: tsx This is the JS-positioned overlay: positions are recomputed from the `documentViewportChanged` event, so items can visibly lag during a fast fling or pinch. Native-driven, jank-free tracking is planned as a follow-up.
Source:

NutrientOverlayItem()

A single overlay element anchored to a PDF coordinate on a given page. Must be rendered inside a NutrientOverlay.
Source:

computeOverlayItemLayout()

Computes the absolute layout for an overlay item. When the item scales with zoom, scaling is centered, so the layout position is offset by half the scaled delta to keep the item's top-left anchored at `screen` without relying on `transformOrigin` (unavailable before React Native 0.74).
Source:

Type Definitions

BlankPDFConfiguration

Properties:
Name Type Attributes Description
name string <optional>
 The name of the new document.
filePath string <optional>
 The directory where the new document should be stored.
width number The width of the new document.
height number The height of the new document.
override boolean If true, will override existing document with the same name.
Source:

DocumentPDFConfiguration

Properties:
Name Type Attributes Description
name string <optional>
 The name of the new document.
filePath string <optional>
 The directory where the new document should be stored.
documents Array.<PDFDocumentConfiguration> An array of the documents that should be used to construct the new document.
override boolean If true, will override existing document with the same name.
Source:

DocumentViewportChangedPayload

Properties:
Name Type Description
documentID string Identifier of the document currently displayed.
pageIndex number The primary (most visible) page index for which visiblePdfRect is reported.
zoomScale number Current zoom factor of the view.
visiblePdfRect Rect Visible region of pageIndex, expressed in PDF points.
contentOffset Point Content offset of the scroll view, in screen points, relative to pageIndex's top-left. Since pageIndex is whichever page is currently anchored (closest to the center of the viewport), this jumps discontinuously when the anchor page changes, e.g. scrolling past a page boundary. It is not a document-absolute offset; use visiblePdfRect and pageIndex together if you need position relative to a specific page instead.
viewportSize object Size of the viewport, in screen points.
Properties
Name Type Description
width number The width of the viewport.
height number The height of the viewport.
Source:

FormFieldResult

Properties:
Name Type Attributes Description
formElement string <optional>
 The form field value
error string <optional>
 The error description
Source:

GeneratePDFConfiguration

Properties:
Name Type Attributes Description
name string <optional>
 The name of the new document.
filePath string <optional>
 The directory where the new document should be stored.
override boolean If true, will override existing document with the same name.
Source:

GeneratePDFResult

Properties:
Name Type Description
fileURL string The path on the filesystem where the new document is stored.
Source:

ImagePDFConfiguration

Properties:
Name Type Attributes Description
name string <optional>
 The name of the new document.
filePath string <optional>
 The directory where the new document should be stored.
images Array.<PDFImage> An array of the images that should be used to construct the new document.
override boolean If true, will override existing document with the same name.
Source:

InstantConfiguration

Properties:
Name Type Description
enableInstantComments boolean Specifies whether adding comment annotations is allowed.
listenToServerChanges boolean Automatically listen for and sync changes from the server.
delay number Delay in seconds before kicking off automatic sync after local changes are made to the editableDocument's annotations.
syncAnnotations boolean Specifies whether added annotations are automatically synced to the server.
Source:

InstantDocumentData

Properties:
Name Type Description
jwt string The JWT received as part of the web response.
serverUrl string The server URL received as part of the web response.
Source:

PDFDocumentConfiguration

Properties:
Name Type Attributes Description
documentPath string The URI to the existing document.
pageIndex number <optional>
 The index of the page that should be used from the document. Starts at 0. If not specified, the entire document will be used.
Source:

PDFDocumentProperties

Properties:
Name Type Description
documentId string The document ID.
pageCount number The number of pages in the document.
isEncrypted boolean Indicates if the PDF document is encrypted (password protected).
Source:

PDFImage

Properties:
Name Type Attributes Description
imageUri string The URI to the image file.
position string <optional>
 The image position on the PDF page. Options are: top, bottom, left, right, center.
rotation number <optional>
 The page rotation, in degrees.
pageMargins PDFTemplatePageMargins <optional>
 The page margins.
pageSize PDFTemplatePageSize <optional>
 The size of the page.
Source:

PDFTemplate

Properties:
Name Type Attributes Description
pageSize PDFTemplatePageSize The size of the page.
backgroundColor string <optional>
 The background color of the page. Can be either a rgba string, for example: rgba(0.871, 0.188, 0.643, 0.5), or standard colors such as blue or yellow.
template string <optional>
 Which template to use. Options are: blank, dot5mm, grid5mm, lines5mm and lines7mm.
rotation number <optional>
 The page rotation, in degrees.
pageMargins PDFTemplatePageMargins <optional>
 The page margins.
Source:

PDFTemplatePageMargins

Properties:
Name Type Description
top number The top margin.
left number The left margin.
right number The right margin.
bottom number The bottom margin.
Source:

PDFTemplatePageSize

Properties:
Name Type Description
width number The width of the page.
height number The height of the page.
Source:

Point

Properties:
Name Type Description
x number The x coordinate.
y number The y coordinate.
Source:

Rect

Properties:
Name Type Description
x number The x coordinate of the origin.
y number The y coordinate of the origin.
width number The width of the rectangle.
height number The height of the rectangle.
Source:

TemplatePDFConfiguration

Properties:
Name Type Attributes Description
name string <optional>
 The name of the new document.
filePath string <optional>
 The directory where the new document should be stored.
templates Array.<PDFTemplate> An array of the templates that should be used to construct the new document.
override boolean If true, will override existing document with the same name.
Source: