GcDocs PDF Viewer options class.
Used by form submission and for theme urls.
Indicates if the viewer should look for a compressed version of the CMap file with the extension '.bin'.
The URI to a folder where the external font CMap tables are stored.
Origin coordinates for the PDF page. The option is used for a properties panel of the Annotation and Form editor.
Annotation coordinates round precision. Used by the Annotation and Form editor.
Set this options to true if you wish to disable page labels.
URL to document list service used by DocumentListPanel (see addDocumentListPanel method). The service should return JSON string with available documents array, e.g.: ["pdf1.pdf", "pdf2.pdf"]
Render dynamic Xfa forms if any.
The externalLinkTarget option sets the value of the target attribute of a link annotation. The externalLinkTarget option specifies where to open the linked document. Possible values are: 'blank', 'self', 'parent', 'top', 'none'.
Specifies the PDF file name, URL, or binary data to be loaded in the Viewer.
Form filler settings.
Used when file name not available.
Specifies annotation types which will be hidden when 'hide-annotations' button is checked. Possible values are: ['Text', 'Link', 'FreeText', 'Line', 'Square', 'Circle', 'Polygon', 'Polyline', 'Ink', 'Popup', 'FileAttachment', 'Sound', 'ThreadBead', 'RadioButton', 'Checkbox', 'PushButton', 'Choice', 'TextWidget', 'Redact'] or 'All' or 'None'
Set this option to true if you want to use the fileData property even if the document cannot be parsed as a valid PDF document.
User interface language. Note, in order to use the language option, you must specify the language option value during the viewer initialization phase.
The logging level used for persistent connections using signalr client. Note that the ASP .NET version of the signalr client supports only 'Trace' log level.
The maximum supported canvas size in total pixels, i.e. width * height. When the canvas scaling exceeds the maxCanvasPixels option, the CSS scaling will be used instead of re-rendering page to the canvas.
This function will be called when context menu is about to be hidden. Return false if you want to prevent close context menu action.
This function will be called when context menu is about to be shown. You can use this function to customize context menu. Return false if you want to prevent open context menu action.
The onInitialized handler will be called immediately after the viewer is instantiated.
A predefined password for protected pdf documents.
Render interactive form elements.
PDF document renderer type - canvas or svg.
The Reply Tool settings.
Use the requireTheme option to apply built-in CSS theme, the option will inject theme styles directly into the page head. Note, only known built-in theme can be specified, otherwise the viewer will fail. Available built-in themes: "viewer", "dark", "dark-yellow", "gc-blue", "light", "light-blue". This option takes precedence over the "theme" option which can be used to specify custom theme.
Second toolbar options.
Document's sharing settings. The sharing is used only when the document is open in collaboration mode using the Share dialog box or from the Shared documents panel.
Signature tool settings.
The Snap Alignment feature customization settings. The tolerance setting is the distance between the edges of two objects within which the object that is being moved or resized snaps to the other object. Margin is the extra space before or after the edge of a field or page. The margin setting is the distance from the target object to which the edge of the object being moved or resized snaps. The center setting allows to snap objects to centers of other objects (in addition to edges).
Use the stamp option to configure Stamp button settings.
Optional. Default image resolution(DPI) for stamp images without DPI.
URL to an external Web API service which will be used to enable PDF editing features.
Use theme option to change default viewer theme. Set this option to false if you want to disable the loading of the built-in theme - this can be useful when you are already has theme css reference.
Available viewer themes.
By default, the viewer uses its own context menu. Set this option to true if you want to use the browser context menu. Please, note, if you set this option to true, some functions of the context menu will not be available (for example, actions of the Editor and Reply tool).
Arbitrary data associated with the viewer. This data is sent to the server when the document is saved.
Author's user name. This option is used by the Annotation Editor and Reply Tool as the default for the Author field.
URL to the Web Worker script. The Web Worker script runs in the background and is used to load and render PDF documents in a parallel background thread. Please, note, that rendering a PDF on the main thread (without a Web Worker script) can slow down the performance of the PDF viewer when loading large PDF files.
Use this option to enable annotation tools from the form editor or field tools from the annotation editor.
Text selection cursor settings.
Contains default values for a new annotations and fields.
Form fields appearance rendering settings. Use this option to customize a specific rendering type for the appearance of form fields. Available appearance rendering types:
for example you can specify background / border colors.
Track view changes and restore previous state on next page load. Note for trackFile - we are tracking opened file only when you open document using URI, not binary data.
Color settings for text selection and for active / inactive search result highlight.
Changes the default color used to highlight the currently selected search result from the search results list, in the document.
Changes the default color used to highlight all the search results in the document.
Changes the default color used to mark the selected text in the document.
Zoom by mouse wheel settings.