Namespace: PSPDFKit

The user starts drawing an annotation.

The user stops drawing an annotation.

The user starts typing text into an annotation.

The user stops typing text into an annotation.

The user starts choosing an item from the picker presented.

Used for image annotations, stamp annotations and ink signature annotations.

Note that the annotation included in this event will not have any matching field values (including ID) compared to the annotation in a PSPDFKit.AnnotationsWillChangeReason.SELECT_END event. This is because the actual annotation hasn't been created yet. As a result, this annotation is used only to identify the type of annotation being selected. The only exception to this is the inkSignature field in a PSPDFKit.Annotations.InkAnnotation, which is set to true to distiguish it from a regular ink annotation.

The user stops choosing an item from the picker presented.

Used for image annotations, stamp annotations and ink signature annotations.

Note: An empty PSPDFKit.AnnotationsWillChangeEvent#annotations list indicates that the selection was cancelled.

Note that this will not be fired when cancelling the system dialog for selecting an image, because there is no way to detect when this occurs.

The user starts moving an annotation around.

The user stops moving an annotation around.

The user starts resizing an annotation.

The user stops resizing an annotation.

The user initiates the delete process. This will be emitted when the deletion confirmation dialog appears.

The user ends the delete process. This will be emitted when the user confirms or cancels the intention to delete an annotation.

An empty PSPDFKit.AnnotationsWillChangeEvent#annotations list indicates that the deletion was cancelled.

The value of one of the properties of the annotation is changed by the user. e.g. the color or the stroke width.

Saves immediately whenever an attribute of the annotation changed, or whenever a form field value got updated.

Saves annotations automatically, when the user finishes editing an annotation. For form fields, this behaves like PSPDFKit.AutoSaveMode.IMMEDIATE.

Never saves annotations or form field values automatically. Annotations and form field values can still be saved via PSPDFKit.Instance#saveAnnotations or PSPDFKit.Instance#saveFormFieldValues

In this mode, document signatures validation information will not be automatically updated if the document is modified, until changes are saved.

The certificate chain validates correctly.

The certificate chain contains a self-signed certificate.

The certificate chain contains a certificate that has been classified as "untrusted".

The certificate date is correct, but the identity is unknown because it has not been included in the list of trusted certificates and none of its parents are trusted certificates.

The certificate used to sign the document has expired now. Note that the certificate may be valid at the time the document was signed, which is not checked.

The certificate used to sign the document is not valid yet.

The certificate is not valid.

The certificate has been revoked.

Could not fetch the contents of the signature.

An unknown problem happened when the certificate trust chain was validated.

Between the possible reasons for this could be that the signature is malformed, the certificate chain is too long and other unknown conditions.

The part of the document covered by the signature has not been modified.

The part of the document covered by the signature has been modified.

The signature /Contents couldn't be parsed.

The signature /ByteRange couldn't be parsed.

The digest of the document couldn't be calculated.

The signing certificate from the signature contents couldn't be extracted.

The public key from the signature contents couldn't be extracted.

The encryption padding from the signature contents couldn't be extracted.

An unspecific error.

All of the signatures of the document are valid, that is, it should be shown with a green checkmark or similar in the UI.

All of the signatures of the document are valid with concerns, that is, it should be shown with a yellow warning or similar in the UI.

At least one signature of the document is invalid, that is, it should be shown with a red cross of similar in the UI.

The document does not contain digital signatures.

When this mode is activated, the creation of new highlight annotations will be enabled and the text will be highlighted as it's selected.

When this mode is activated, the creation of new ink annotations will be enabled. This transforms the page to a drawable canvas and an annotation is created while drawing on it. If properties (e.g. color) or the page index changes, a new annotation is created.

When this mode is activated, the creation of new ink signatures will be enabled. This this shows a dialog where it is possible to select an existing ink signature or create a new one and store it.

When this mode is activated, the stamp annotation templates picker modal UI will be shown. Once a template is selected, the new annotation is configured and created\ in the document.

When this mode is activated, the custom stamp annotation template editor modal UI will be shown. Once a the custom template is edited, the new custom stamp annotation will be created in the document.

When this mode is activated, the creation of new line annotations will be enabled. This transforms the page to a drawable canvas and an annotation is created while drawing on it.

When this mode is activated, the creation of new rectangle annotations will be enabled. This transforms the page to a drawable canvas and an annotation is created while drawing on it.

When this mode is activated, the creation of new ellipse annotations will be enabled. This transforms the page to a drawable canvas and an annotation is created while drawing on it. If properties (e.g. color) or the page index changes, a new annotation is created.

When this mode is activated, the creation of new polygon annotations will be enabled. This transforms the page to a drawable canvas and an annotation is created while drawing on it. If properties (e.g. color) or the page index changes, a new annotation is created.

When this mode is activated, the creation of new polyline annotations will be enabled. This transforms the page to a drawable canvas and an annotation is created while drawing on it. If properties (e.g. color) or the page index changes, a new annotation is created.

When this mode is activated, removing of current ink annotation points will be enabled. This transforms the page to a canvas where the cursor can remove ink annotation points by hand, as well as choose the cursor width.

When this mode is activated, the creation of new note annotations will be enabled. This transforms the page to a clickable area where the annotation will be created at the position of the click.

When this mode is activated, the creation of new comment marker annotations will be enabled. This transforms the page to a clickable area where the annotation will be created at the position of the click.

When this mode is activated, the creation of new text annotations will be enabled. This transforms the page to a clickable area where the annotation will be created at the position of the click.

This enables the pan tool to allow the user to navigate on a desktop browser using mouse dragging. This will disable text selection.

On a touch device, this will have no effect since panning is already the default technique for scrolling on websites.

Enables the search mode and focuses the search input field.

This shows the document editor modal.

This enables the Marquee Zoom tool. When enabled, you can draw a rectangle on the screen which is zoomed into and scrolled to, once the pointer is released.

When this mode is activated, the creation of new redaction annotations will be enabled by highlighting regions of text and the text will be marked for redaction as it's selected.

When this mode is activated, the creation of new redaction annotations will be enabled by drawing rectangles on the pages. This transforms the page to a drawable canvas and annotations are created while drawing on it.

Pages will always be displayed in the single page mode.

This is the default mode.

Pages will always be displayed in groups of two.

Automatically sets the layout mode to PSPDFKit.LayoutMode.SINGLE or PSPDFKit.LayoutMode.DOUBLE depending on the available space.

Specifically PSPDFKit.LayoutMode.DOUBLE is chosen when the PSPDFKit container is in landscape mode and its size is greater than 992px.

This mode is a perfect fit for tablets in particular since it will automatically update the layout mode then device orientation changes.

When the dimensions of the viewport change (i.e. the browser window is resized), the view will be restored to make the current page visible.

This method will render all pages of the PDF document in advance before it sends the results to the printer. This works in all major browsers and will not give your users access to the source PDF file. However, this method is CPU-bound and memory usage scales with PDF size.

Because of its reliability and cross browsers support this method is the default.

Some caveats when using this method:

• To achieve cross-browser support, we render the resulting images into the main window. We try to hide already existing HTML by applying display: none !important. If the printed page still contains other HTML elements, make sure to apply an appropriate print stylesheet to your web app.
• This method will produce incorrect results, when pages of the document have different sizes. Unfortunately, there's no way to work around this issue since it's a CSS limitation.

This method is built to be resource efficient and to avoid having to render all pages in advance, which might balloon memory usage to multi-GB on PDFs with 100+ pages.

It supports all common browsers, however some fall back to opening the PDF file in a new tab, which might give your users unwanted access to the source files.

Google Chrome and Microsoft Internet Explorer provide the APIs required to use the native renderer, as a fallback on other browser we generate and open a PDF in a new tab. This allows users to print the PDF in a native PDF reader which can, as opposed to browser-built implementations, talk directly to the connected printer.

When using this print mode, we can not call the PSPDFKit.RenderPageCallback when printing pages.

Note: If the PDF is password-protected, we always fall back to opening the PDF in a new tab.

Render all pages as a list and allow smooth scrolling.

This is the default mode.

Makes scrolling only possible within a spread. Whenever this mode is activated, or pages are changed when this mode is active, the zoom mode will be reset to PSPDFKit.ZoomMode.FIT_TO_VIEWPORT.

Makes scrolling only possible within a spread and doesn't allow changing pages. Whenever this mode is activated the zoom mode will be reset to PSPDFKit.ZoomMode.FIT_TO_VIEWPORT.

Catches credit card numbers with a number beginning with 1-6, and must be 13 to 19 digits long. Spaces and - are allowed anywhere in the number.

Matches date formats such as mm/dd/yyyy, mm/dd/yy, dd/mm/yyyy, and dd/mm/yy. It will reject any days/months greater than 31 and will match if a leading zero is or is not used for a single digit day or month. The delimiter can either be -, . or /.

Matches time formats such as 00:00:00, 00:00, 00:00 PM. 12 and 24 hour formats are allowed. Seconds and 12 hour AM/PM denotation are both optional.

Matches an email address with the format of xyz@xyz.xyz where xyz can be any alpha numeric character or a . For more information on the pattern please see http://emailregex.com/.

Matches International style phone numbers with a prefix of + or 00, containing between 7 - 15 digits with spaces or - occurring anywhere within the number.

Matches an IPV4 address limited to number ranges of 0-255 with an optional mask.

Matches full and compressed IPv6 addresses as defined in RFC 2373.

Matches a MAC address with delimiters of either - or :

Matches a NANP (https://en.wikipedia.org/wiki/North_American_Numbering_Plan) style phone number. In general this will match US, Canadian and various other Caribbean countries. The pattern will also match an optional international prefix of +1.

Matches a US social security number (SSN). The format of the number should be either XXX-XX-XXXX or XXXXXXXXX with X denoting [0-9]. We expect the number to have word boundaries on either side, or to be the start/end of the string.

Matches a URL with a prefix of http|https|www with an optional subdomain.

Matches a USA style Zip Code. The format expected is 00000 or 00000-0000, where the delimiter can either be - or /.

Matches US and ISO 3779 standard VINs. The format expects 17 characters with the last 5 characters being numeric. I,O,Q,_ characters are not allowed in upper or lower case.

This is the default search type. This is used when you want to search for strings/text.

The search type when you want to use the patterns provided by us. see PSPDFKit.SearchPattern for the list of all the patterns.

The search type when you want to search using regex. The regular expression flavor is based on ICU regular expression, which is a derivative of Perl regular expressions.

Show the digital signature validation UI if digital signatures are found on the current document.

Only show the digital signature validation UI if digital signatures with problems or invalid ones are found, and also if the document has been modified since the moment it's been signed.

Only show the digital signature validation UI if invalid signatures are found.

Never show the digital signature validation UI.

Annotations sidebar.

Bookmarks.

Document Outline (table of contents).

Thumbnails preview.

The sidebar is shown before the content in the reading direction. For any LTR languages this will be the left side, for RTL languages this will be the right side.

The sidebar is shown after the content in the reading direction. For any LTR languages this will be the right side, for RTL languages this will be the left side.

Always store new ink signatures.

Never store new ink signatures.

Store new ink signatures if the option is selected in the UI.

The overall status of the signature is valid, that is, it should be shown with a green checkmark or similar in the UI.

The overall status of the signature is valid with concerns, that is, it should be shown with a yellow warning or similar in the UI.

The overall status of the signature is that it is invalid, that is, it should be shown with a red cross of similar in the UI.

Light mode. This is the default theme.

Dark mode.

Uses PSPDFKit.Theme.LIGHT or PSPDFKit.Theme.DARK based on the user preferences and the prefers-color-scheme media query. Note this is not available in every browser.

The default value. The toolbar will be placed at the top of the viewport.

The toolbar will be placed at the bottom of the viewport.

Generates a zoomLevel that will automatically align the page for the best viewing experience.

Uses a zoomLevel that will fit the width of the broadest page into the viewport. The height might overflow.

Uses a zoomLevel that will fit the current page into the viewport completely.