After open event arguments.
AfterRemoveAnnotation event arguments.
AfterUpdateAnnotation event arguments.
Marked states.
Review states.
Annotation state model.
Annotation type name.
Base annotation cancelable event arguments.
Base type annotation event arguments.
Sign tool component properties.
BeforeAddAnnotation event arguments.
Before open event arguments.
BeforeRemoveAnnotation event arguments.
BeforeUpdateAnnotation event arguments.
Internal EventBus event name.
Base type for cancelable event arguments.
Client transport message.
Color editor localization properties.
Label for B input
Text for color picker label.
Label for G input
Label for Hex input
Label for Hue slider
Label for Lightness slider
Opacity text.
Text for Palettes label.
Label for R input
Label for Saturation slider
Text for Standard Colors label.
Web color names.
Text for WebColors palette label.
PDF metadata provides additional information about a PDF document, including file name, title, date of creation, author, title, etc.
Author name.
Creation date
Application that was used to create the file.
File name.
File size in bytes.
Indicates whether the document contains an Acro Form.
Indicates whether the document is linearized.
Determines whether the AcroForm contains XFA data.
Document keywords.
Modification date.
PDF version.
Page size (inches).
PAges count.
Producer name.
Document subject.
Document title.
Error event arguments.
Base type for event arguments.
Event name.
Event source.
Event name.
Form field appearance rendering type. "Custom" - use custom appearance. The custom appearance has some improvements over the web appearance, for example you can specify background / border colors. "Web" - use standard field appearance using platform-native styling. See https://developer.mozilla.org/en-US/docs/Web/CSS/appearance for details. "Predefined" - use predefined appearance stream from PDF when available, if appearance stream is not available, custom appearance will be used.
Field validation result.
Defines options to perform search.
Specifies whether to search for at the beginning of Text.
Highlight all search results.
Specifies whether the search is case sensitive.
Proximity searching is a way to search for two or more words that occur within a certain number of words from each other.
Specifies whether to perform the search in the backward order.
Specifies whether to search for at the beginning of the word.
The text to search for.
Specifies whether to search for the specified whole word only.
Specifies whether a search query is wildcards. Note, wildcards search cannot be combined with options like 'EndsWith', 'StartsWith', 'WholeWord'.
Appearance, behavior and validation settings for the input field inside the Form Filler dialog.
Form filler dialog settings.
The type of action to execute if form validation fails after clicking Apply button.
The beforeApplyChanges event handler will be called when the Apply button is clicked after success fields validation. Return false if you want to cancel apply changes.
The beforeFieldChange event handler will be called right before the field value changed. Return false if you want to cancel the field value change.
Form Filler dialog layout type.
Form fields mappings, key - field name, value - @see FormFieldMapping.
The onInitialize event handler is called after the list of fields is loaded and initialized but not yet rendered.
Dialog title.
The validator function which will be called for each field before saving changes or on user input when field's mapping settings contains validateOnInput flag. You can return a string value with message about validation error, this message will be shown in UI. Return true or null for success result.
GcPdfSearcher options.
Indicates caseSensitive search.
Indicates endsWith search.
Indicates entireWord search.
Search direction.
Indicates highlightAll search.
Indicates phrase search.
Indicates proximity search.
Search query.
Indicates startsWith search.
Indicates wildcards search.
Additional appearance and behavior properties for the input field.
The autocomplete attribute lets web developers specify what if any permission the user agent has to provide automated assistance in filling out form field values, as well as guidance to the browser as to the type of information expected in the field. Note, the behavior of this property depends on the browser implementation.
Indicates whether a field should automatically get focus when the Form filler dialog is activated or when the page loads.
The default value.
Indicates whether a field is disabled, or not.
Use the displayname property to specify the text that will appear as a field label in the Form Filler dialog box. Applicable only for the Form Filler dialog box.
If your recommended (or required) password syntax rules would benefit from an alternate text entry interface than the standard keyboard, you can use the inputmode property to request a specific one. The most obvious use case for this is if the password is required to be numeric (such as a PIN). Mobile devices with virtual keyboards, for example, may opt to switch to a numeric keypad layout instead of a full keyboard, to make entering the password easier.
The maximum value to accept for the input. Applicable for date or number input.
The maximum number of characters the input should accept.
The minimum value to accept for the input. Applicable for date or number input.
The minimum number of characters long the input can be and still be considered valid.
Set this property to true if you want to use multiline text input element.
A boolean property which, if present, indicates that the user can enter a list of multiple e-mail addresses, separated by commas and, optionally, whitespace characters.
The pattern property specifies a regular expression that the field value is checked against.
Represents the placeholder text in an input or textarea element when value is empty.
Indicates whether the field is read-only, or not.
When present, it specifies that an input field must be filled.
The spellcheck property is an enumerated attribute defines whether the element may be checked for spelling errors Note that the spellcheck property may have limited support by some browser vendors.
Use the title property to specify text that most browsers will display as a tooltip.
State of the input type attribute.
True indicates whether validation should be performed immediately during user input, otherwise input validation will be performed on blur event.
Representing a localized message that describes the validation constraints that the control does not satisfy (if any).
Right sidebar state.
Right sidebar tool.
Image tool component state model.
Cancelable JS event arguments.
Indicates whether the event should be canceled.
JS code which is executed.
JS event arguments.
JS code which is executed.
JavaScript execution configuration.
Handler function which will be called after JS action execution finished.
Handler function which will be called before JS action execution started. You can modify the args.jsCode property inside this handler function. Set the args.cancel property to true if you wish to prevent further JS action execution;
Set this setting to true if you want to permanently disable the JS action executor.
Keyboard shortcut definition.
Specifies whether the Alt key should be pressed.
Specifies whether the Ctrl key should be pressed.
Optional key code.
Specifies whether the Shift key should be pressed.
Shortcut action.
Built-in keyboard shortcut action tool name.
Line end style.
Link destination type.
Link annotation type.
Log levels available to the SignalR client.
Base transport message.
Auto-generated correlation Id.
ClientMessageType.Modification connection message arguments.
Shared document modifications.
Named action. Used by link annotation. See PDF reference, table 8.45 - Named action.
Initial open action.
Array with destination information. dest[0] // internal pdf page reference. dest[1] // contains destination view fit type name: { name: 'XYZ' } - Destination specified as top-left corner point and a zoom factor (the lower-left corner of the page is the origin of the coordinate system (0, 0)). { name: 'Fit' } - Fits the page into the window { name: 'FitH' } - Fits the widths of the page into the window { name: 'FitV' } - Fits the height of the page into a window. { name: 'FitR' } - Fits the rectangle specified by its top-left and bottom-right corner points into the window. { name: 'FitB' } - Fits the rectangle containing all visible elements on the page into the window. { name: 'FitBH' } - Fits the width of the bounding box into the window. { name: 'FitBV' } - Fits the height of the bounding box into the window. dest[2] // x position offset dest[3] // y position offset (note, the lower-left corner of the page is the origin of the coordinate system (0, 0)) dest[4] // can be null, contains bounding box width when view name is FitR, contains scale when view name is XYZ, dest[5] // can be null, contains bounding box height when view name is FitR
Open parameters.
Authentication headers.
For decrypting password-protected PDFs.
Indicates whether or not
cross-site Access-Control requests should be made using credentials such
as cookies or authorization headers. The default is false
.
withCredentials makes the browser include cookies and authentication headers in the XHR request.
If your service depends on any cookie (including session cookies), it will only work with this option set.
Optional content config.
Get group using id.
Get all groups.
Get groups order.
Check group visibility.
Set group visibility.
Optional content group.
A dictionary used by the creating application to store application-specific data associated with this optional content group.
Export state.
Group id.
A single name or an array of names that represent the intended use of the graphics in the group. The values View and Design, or any second class name may be used. A PDF processor may choose to use only groups that have a specific intent and ignore others. Default value: View. If an Optional Content Group Dictionary Intent entry contains Design then a CreatorInfo entry should be included.
Group name.
Print state.
Group type.
View state.
Visibility flag.
A dictionary specifying a range of magnifications at which the content in this optional content group is best viewed. It shall contain one or both of the following entries: min - The minimum recommended magnification factor at which the group shall be ON. Default value: 0. max - The magnification factor below which the group shall be ON. Default value: infinity.
Initial page layout preference.
Initial page mode preference.
Page modification.
Page structure change.
PDF page viewport created based on scale, rotation and offset.
height
scale
Viewport transform.
viewBox
width
Clone viewport.
Converts viewport coordinates to the PDF location. Useful for converting canvas pixel location(top/left) into PDF location (bottom/left).
The x-coordinate.
The y-coordinate.
Converts PDF point to the viewport coordinates. Useful for converting PDF location (bottom/left) into canvas pixel coordinates(top/left).
The x-coordinate.
The y-coordinate.
Converts PDF rectangle to the viewport coordinates.
The xMin, yMin, xMax and yMax coordinates.
PDF Organizer dialog settings.
PDF Organizer dialog layout type.
Dialog title.
Defines the layout of the toolbar for different viewer modes: viewer, annotationEditor, formEditor.
The toolbar layout for the Annotation editor mode.
The toolbar layout for the Form editor mode.
Array with button keys that will use sticky behavior - the button remains checked after editing is complete. Applicable only to annotation / form editor toolbar keys.
The toolbar layout for viewer mode.
replyTool option settings.
Allow add note.
Allow add reply.
Allow to add replies to other user notes.
Allow change other user notes.
Allow change user name.
Allow delete notes/replies.
Allow delete other user notes.
Allow to set status.
Allow to set status for other user notes.
Read-only mode.
Information about initial rectangle before rotation.
Rotation rectangle in degrees.
Left content offset after rotation. Width difference between initRect and rotatedRect divided by 2.
Top content offset after rotation. Height difference between initRect and rotatedRect divided by 2.
Initial annotation rectangle before rotation. Cannot be null or empty. [x1, y1, x2, y2], equals the content rectangle without rotation. Rotation origin is center of the rectangle.
Result annotation rectangle after rotation, [x1, y1, x2, y2] - orientation not changed.
Transformed content rectangle after rotation, [x1, y1, x2, y2].
Ruler line settings.
Line color.
The vertical position of the ruler as a percentage, starting from the bottom. The valid value must be in the range 0-100.
The ruler line width.
Line type.
Additional save settings.
Destination document format. PDF - the document will be saved in PDF format. PNG - the document will be saved to images.
You can specify the index of the page(s) or pages range to save. For a range of pages, use a hyphen. Separate page or pages range with a comma, e.g. "0, 1, 4-5, 8". You can also change the page order: "1, 0, 2-8", clone required pages: "0, 0, 3, 3, 3", specify external pdf file as source: "0-3, [file:fileid_1]0-3, [file:fileid_1]5-7, [file:fileid_2]0-3" (see examples for details), or rotate page(s): await viewer.save("test_part10.pdf", { reload: true, pages: "[angle:90]2-3" });
Custom progress message to be displayed during save.
viewer.save("sample.pdf", { pages: "[angle:90]0,1-5", progressMessage: "Rotating first page..." }, reload: true);
Custom progress title to be displayed during save.
viewer.save("sample.pdf", { pages: "[angle:90]0,1-5", progressTitle: "Rotating" }, reload: true);
Load the updated PDF document into the viewer without downloading it to the local system.
Defines the mode of saving a PDF.
Signature settings used to save document with signature. If specified, the document will be saved with signature.
Zoom factor to be used for rendering images when the target format is "PNG".
viewer.save("sample.pdf", { format: "PNG", zoomFactor: 1.5 });
Server transport message.
ClientMessageType.ShareDocument connection message arguments.
Information about shared document.
Sign tool component state model.
Appearance settings for the Signature Tool dialog.
The afterAdd event handler will be called when the result annotation is added and signature dialog is closed.
The afterShow event handler will be called after the dialog is shown.
Automatically adjust the canvas size so that it shrinks to fit the window when the window size is small.
The beforeAdd event handler will be called when the Add button is clicked. Return false if you want to cancel default add action.
The beforeHide event handler will be called before the dialog is closed. Return false if you want to to prevent the dialog from closing.
The beforeShow event handler will be called before the dialog is shown. Return false if you want to prevent the dialog from showing.
Bold text style for the "Type" tab.
The size of the canvas in pixels.
Convert the result stamp to content.
The target value for the canvas scale. The result annotation bounds will be scaled using this value. For example, if destinationScale is 0.5 and canvasSize is 400/200, the size of the result annotation will be 200/100.
Dialog location within window rectangle. Origin is top/left.
The default font name that will be used for the "Type" tab.
Array of the available font names.
The default font size that will be used for the "Type" tab.
If true, the signature tool will try to load an image from local storage for the Image tab.
Specifies whether to hide dialog footer.
Specifies whether to hide dialog title.
Specifies whether to hide the "Save signature" button.
Specifies whether to hide tab buttons.
Specifies whether to hide the toolbar which can be used to customize typing and drawing styles.
Italic text style for the "Type" tab.
The result location of the annotation on the page. Note, when you specify the exact location (using {x, y} values), the origin is at the bottom left corner.
Destination page index.
Pen color.
Pen width.
Canvas ruler lines customization.
Indicates whether the signature data must be saved into browser's local storage for later use. The saved data is owned by the active user, which can be set using the currentUserName property.
Initially selected tab.
Result annotation subject.
Array of the available tabs. The order of the tabs is preserved. Possible values are: 'Type', 'Draw', 'Image'.
The default text that will be used for the "Type" tab.
Text color.
Dialog title.
Signature tool type.
Information about the document signature that will be used to sign the document.
The information provided by the signer to enable a recipient to contact the signer to verify the signature (for example, a phone number).
The CPU host name or physical location of the signing.
The reason for the signing, such as "I agree...".
The signature field name used to store a digital signature.
The name of the person or authority signing the document. NOTE: This value is used only if it is not possible to extract the name from the signature, for example from the certificate of the signer.
Information about signature used in document.
An array with all available signature fields in the document. The signatureFields represents all signature fields in a file, whether it is signed or not.
The flag indicates whether the document is signed. Note, a document is considered signed if it contains at least one signature field with the signatureValue property filled in.
An array with signature field(s) which was used to sign the document. The signedByFields only represents signed signature fields.
Image stamp category data model.
Optional. Images resolution.
Category identifier.
Indicates whether the category contains dynamic stamps. Dynamic stamp images are updated for each new stamp instance.
Category display name.
Optional. Full URIs for image stamps. If specified, the stampImageUrls settings will be used instead of the stampImages array.
Stamp image names.
ClientMessageType.Start connection message arguments.
ClientMessageType.Stop connection message arguments.
Structure tree content.
Actual content text.
Structure tree node. The root node will have a role "Root".
Document structure changes.
SupportApi settings.
URL to the Support API service that will be used to enable PDF editing features.
Set this setting to true if you are using the Web Forms (WEB API 2) version of the SupportApi service. Note, in most cases, you do not need to set this setting, the server type is determined by the viewer automatically.
Automatically reconnect to the server at the specified interval in milliseconds. Used by persistent connections.
The internal Support API client uses the fetch API to make requests to the server. Use the requestInit setting to configure fetch options (like authorization headers, etc), see https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch for details.
Suppress Support API error messages (e.g. messages about the Support API availability / version mismatch).
Suppress Support API informational messages (e.g. Support API reconnect messages).
Authentication or antiforgery token. In each subsequent SupportApi request, the token is passed in the request for server-side validation. You can use ASP.NET Core Antiforgery to generate and verify security token, see Prevent Cross-Site Request Forgery (XSRF/CSRF) attacks in ASP.NET Core for details.
Optional. SignalR socket URL for persistent connections. Persistent connections are required for collaboration mode. Set this setting to false to disable persistent connections.
SVG icon key.
Text markup context menu settings
Available colors
Theme changed event arguments.
Toolbar button key.
Type tool component state model.
Undo change name.
ClientMessageType.UnshareDocument connection message arguments.
User access mode.
Validation caller name.
The name of the GcPdfViewer's feature. Used by the disableFeatures option. Available feature names: 'JavaScript', 'AllAttachments', 'FileAttachments', 'SoundAttachments', 'DragAndDrop', 'SubmitForm', 'Print'.
A viewer preferences specifying the way the document shall be displayed on the screen.
A flag specifying whether to position the document’s window in the centre of the screen.
A flag specifying whether the window’s title bar should display the document title taken from the dc:title element of the XMP metadata stream (see 14.3.2, "Metadata streams"). If false, the title bar should instead display the name of the PDF file containing the document.
A flag specifying whether to resize the document’s window to fit the size of the first displayed page.
A flag specifying whether to hide the interactive PDF processor’s menu bar when the document is active. Default value: false.
A flag specifying whether to hide the interactive PDF processor’s tool bars when the document is active. Default value: false.
A flag specifying whether to hide user interface elements in the document’s window (such as scroll bars and navigation controls), leaving only the document’s contents displayed.
The document’s page mode, specifying how to display the document on exiting full-screen mode
(PDF 1.1) A value specifying a destination that shall be displayed or an action that shall be performed when the document is opened. The value shall be either an array defining a destination (see 12.3.2, "Destinations") or an action dictionary representing an action (12.6.2, "Action dictionaries"). If this entry is absent, the document shall be opened to the top of the first page at the default magnification factor.
A name object specifying the page layout shall be used when the document is opened.
A name object specifying how the document shall be displayed when opened:
Field widget type. Tx - text field Btn - button field Ch - choice widget field
Apply inverse matrix transformation.
x, y point
transform matrix
Apply matrix transform.
x, y point
transform matrix
Build sound file using audio data provided by parameter audioData and audioOptions used to generate RIFF header.
Build a header for the WAVE audio format.
Decimal round up
Change bounds origin.
Cross-browser element.classList.contains
HTML DOM element
Class name without dot.
Converts viewport coordinates to the PDF location. For examples, useful for converting canvas pixel location into PDF one.
The x-coordinate.
The y-coordinate.
Array containing x
and y
properties of the
point in the PDF coordinate space.
Converts PDF point to the viewport coordinates. For examples, useful for converting PDF location into canvas pixel coordinates.
The x-coordinate.
The y-coordinate.
Array containing x
and y
properties of the
point in the viewport coordinate space.
Creates a Blob object which represents a file-like object of immutable, raw data.
ArrayBuffer, ArrayBufferView, Blob or DOMString object
The content type to assign to the new Blob; this will be the value of its type property. The default value is an empty string.
Creates ObjectURL closure. Used when Blob/createObjectURL is not available, falling back to data schema.
Decimal rounding correction.
Correction type
The number.
Exponent (decimal logarithm of the base of the adjustment).
Adjusted value.
Convert degrees to radians.
Returns testElement overlap percentage.
Download binary data.
Download file using specified URL.
Ensure ResizableDialogBehavior is attached.
dialog element to be dragged and resized.
class name for drag handle(s)
allow resize dialog
minimum dialog height
minimum dialog width
Get element's numerical index in its parent element.
HTML DOM element
Finds intersection point between two lines AB and CD.
point A: [x, y]
point B: [x, y]
point C: [x, y]
point D: [x, y]
Search parent element by class name.
HTML DOM element
Class name without dot.
Search parent element by attribute name.
HTML DOM element
Calculates the counter clockwise angle between two vectors.
First vector point, [x1, y1].
Second vector point, [x2, y2].
Returns angle in degrees.
Decimal round down
Gets angle (radians) at point x2,y2.
Applies the transform to the rectangle and finds the minimum axially aligned bounding box.
This function is based on the word-break detection implemented in: https://hg.mozilla.org/mozilla-central/file/tip/intl/lwbrk/WordBreaker.cpp
Get display device pixel ratio.
Optional. canvas context
Find correct event target.
Checks if element is nested within parent element on any level.
Make absolute url from relative one.
Relative url.
Optional, base url for result url concatenation
Merge everything from sourceObj to destinationObj, returns destinationObj. Note, by default, non-empty primitive values are NOT preserved in the destination object.
Destination object
Source object
Set to true if you don't want to replace non-empty primitive values.
Normalize rectangle rect=[x1, y1, x2, y2] so that (x1,y1) < (x2,y2) For coordinate systems whose origin lies in the bottom-left, this means normalization to (BL,TR) ordering. For systems with origin in the top-left, this means (TL,BR) ordering.
Convert a PDF date string to a JavaScript Date
object.
The PDF date string format is described in section 7.9.4 of the official PDF 32000-1:2008 specification. However, in the PDF 1.7 reference (sixth edition) Adobe describes the same format including a trailing apostrophe. This syntax in incorrect, but Adobe Acrobat creates PDF files that contain them. We ignore all apostrophes as they are not necessary for date parsing.
Moreover, Adobe Acrobat doesn't handle changing the date to universal time and doesn't use the user's time zone (effectively ignoring the HH' and mm' parts of the date string).
Convert radians to degrees.
Releases image resources.
Rotate point (x,y) coordinates around point (cx, cy). Note, this function assumes a Cartesian coordinate system - values on the Y axis become higher as you go up.
center point x
center point y
point to rotate, x
point to rotate, y
rotation angle
specifies if rotation angle is in degrees.
Rotate the rectangle.
rectangle coordinates [x1, y1, x2, y2].
center point [x, y].
rotation angle (default - in degrees)
specifies if rotation angle is in degrees. Default is true.
Decimal round to nearest
Scrolls specified element into view of its parent. Note, by default scrolling is done according offsetParent, so, check parent position style if needed.
The element to be visible.
An object with optional top and left properties, specifying the offset from the top left edge.
Ignore elements that have
the CSS rule overflow: hidden;
set. The default is false.
Set the checked state of an input element, toggles the visibility of the canvas's appearance if needed.
Simulate mouse event.
Method is called when the annotation bounds position is changed.
moved distance for x axis
moved distance for y axis
AfterAddAnnotation event arguments.