Used by form submission and for theme urls.

var viewer = new GcPdfViewer("#root", { baseUrl: "http://localhost/mysite/" });

viewer.options.caret =
{/**
* milliseconds, caret blink period
* */
caretBlinkTime: 300,
/**
* milliseconds, stop caret blink time, 0 - don't stop
* */
caretStopBlinkTime: 5000,
/**
* Caret color
* */
color: "#000000",
/**
* Caret width
* */
width: 1,
/**
* Allow to move caret using keys even when pan tool activated.
* */
allowForPan: false };

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: 'blank', 'self', 'parent', 'top', 'none', default is 'none'. 

Set this option to true if you want to use fileData property even when the document cannot be parsed as a valid PDF document.

Specify the renderer type; canvas or svg. Default value is set to canvas. 

Sets the predefined password for a protected PDF document. This option is useful when you do not wish to enter password in the Viewer. 

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.

viewer.options.themes =  ["themes/viewer", "themes/light-blue", "themes/dark-yellow"];

viewer.options.zoomByMouseWheel =
{ always: false, ctrlKey: false, metaKey: true };

Sets keyboard shortcuts.
 
 

viewer.options.shortcuts =
{
107: {// + (numpad)
ctrl: true,
tool: "zoomin"      
},
"S": {
      tool: "selection"
 },

Modifies the default theme for Viewer.

List of supported themes: viewer, light-blue and dark-yellow.

Tracks view changes and restores the previous state on the next page load.

Available values: false true, { trackViewMode: boolean, trackMouseMode: boolean, trackScale: boolean, trackPageRotation: boolean, trackFullScreen: boolean, trackTheme: boolean }

// enable all
viewer.options .restoreViewStateOnLoad = true;
// disable view changes tracking
viewer.options .restoreViewStateOnLoad = false
// enable only scale tracking
viewer.options.restoreViewStateOnLoad =  {trackScale: true}
var viewer = new GcPdfViewer("#root", { restoreViewStateOnLoad: { trackScale: true } });
viewer.addDefaultPanels();

URL to document list service used by DocumentListPanel.

Default value is "/documents". For more information, see addDocumentListPanel method. The service should return json string with available documents array, e.g.:
["pdf1.pdf", "pdf2.pdf"] 

// Using GetDocumentsList service method to get array of the available PDF documents
var viewer = new GcPdfViewer(“#root”, { documentListUrl: "/GetDocumentsList" } );
viewer.addDocumentListPanel();

You can even replace «GetDocumentsList» API by json file
(see example from addDocumentListPanel method description)

Indicates if the viewer should look for a compressed version of the CMap file with the extension '.bin', default value is true.

The URI to a folder where the external font CMap tables are stored, default value is 'resources/bcmaps/'

Origin coordinates for the PDF page. The option is used for a properties panel of the Annotation and Form Editor.

// Change the coordinates origin to bottom/left point:
var viewer = new GcPdfViewer("#root", { coordinatesOrigin: "BottomLeft" } );

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'

// Hide all possible annotations.
let options = { hideAnnotationTypes: 'All' };

// Hide Push button and Redact annotations only.
let options = { hideAnnotationTypes: ['PushButton', 'Redact'] };

User interface language.

function loadPdfViewer(selector) {
  // You can load translations from any source (see en-pdf-viewer.json for an example):
  var myTranslations = {
        "toolbar": {
            "open-document": "Open MY document",
            "pan": "My Pan tool",
        }
   };
   // Initialize translations:
   GcPdfViewer.i18n.init({
     resources: { myLang: { translation: myTranslations } }
   }).then(function(t) {
     // New translations initialized and ready to go!
     // Now create PDF viewer:
     var viewer = new GcPdfViewer(selector, { language: 'myLang' });
     viewer.addDefaultPanels();
     //viewer.open("sample.pdf");
   });
}
loadPdfViewer('#root');

This function will be called when context menu is about to be hidden. Return false if you want to prevent close context menu action.

viewer.options.onBeforeCloseContextMenu = function(e) {
  console.log("The context menu will be closed soon.");
  return true;
};

viewer.options.onBeforeCloseContextMenu = function(e) {
  if(!confirm("Do you want to close context menu?")) {
      console.log("The context menu will not be closed.");
      return false;
  }
  console.log("The context menu will be closed.");
  return true;
};

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.

// This code shows how to modify the context menu and
 // add search using Google and Bing search engines:
 viewer.options.onBeforeOpenContextMenu = function (items, mousePosition, viewer) {
  var selectedText = viewer.getSelectedText();
  if (selectedText) {
    // Remove existent items:
    items.splice(0, items.length);
    // Add own menu items:
    items.push({
       type: 'button',
       text: 'Search using Google',
       onClick: function () {
             window.open('http://www.google.com/search?q=' + encodeURI(selectedText), '_blank');
       }
    });
    items.push({
       type: 'button',
       text: 'Search using Bing',
       onClick: function () {
           window.open('https://www.bing.com/search?q=' + encodeURI(selectedText), '_blank');
      }
    });
   }
   return true;
 };

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).

// Enable vertical snap margin:
var viewer = new GcPdfViewer("#root", { snapAlignment: { margin: { vertical: 10, horizontal: false} }, supportApi: 'api/pdf-viewer'});

URL to an external Web API service which will be used to enable PDF editing features.

var viewer = new GcPdfViewer("#host",

{ supportApi: 'api/pdf-viewer' }
);

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).

// Enable native browser context menu:
var viewer = new GcPdfViewer("#root", { useNativeContextMenu: true } );

Arbitrary data associated with the viewer. This data is sent to the server when the document is saved.

var viewer = new GcPdfViewer('#root', { supportApi: 'api/pdf-viewer' } );
viewer.options.userData = { secretNumber: 5, innerData: { innerContent: 'content' } };
viewer.applyOptions();
viewer.open('sample.pdf');

Author's user name. The option is used by Annotation Editor as default value for 'author' field.

var viewer = new GcPdfViewer('#root', { userName: 'John', supportApi: 'api/pdf-viewer' });

Adds document list panel to the Viewer with available document array specified in documentslist.json file (URL specified by documentListUrl option), located in the root directory of your application.

Example content for the documentslist.json file:
[“file1.pdf”, “file2.pdf”].

Another way is to specify service at the end point for documentListUrl option. The service should return json string with available documents array, e.g.: ["pdf1.pdf", "pdf2.pdf"]

viewer.open("Documents/HelloWorld.pdf");

Set a theme of your choice.

List of supported themes: viewer, light-blue, dark-yellow. 

buttons: string[] | "all" | 'none' = 'all', Available values are:
['open', '$navigation', '$split', 'text-selection', 'pan', '$zoom', '$fullscreen', 'rotate', 'view-mode', 'theme-change', 'print', 'save', 'doc-title'] 'all' 'none'

Enable the Text Annotation Reply Tool.

Note, in order to enable ability to edit/remove or add existing replies you need to configure SupportApi, otherwise the Reply Tool will be in read-only mode.

Add sticky note to the document.

none

Execute Copy action (Ctrl + C shortcut).

buffer: CopyBufferData Optional, data to cut.

"// Find annotation with id '2R':
viewer.findAnnotation(""2R"").then(function(dataArray) {
  if(dataArray[0])
    alert(`Annotation ${dataArray[0].annotation.id} found on page with index ${dataArray[0].pageNumber - 1}.`);
  else
    alert('Annotation not found.');
});

// find all fields with name field1:
viewer.findAnnotation(""field1"", {findField: 'fieldName', findAll: true}).then(function(dataArray) {

});"

Navigate next page.

pageNumber: number

Creates and opens a new blank document.

params: undefined | { height?: undefined | number; pageIndex?: undefined | number; width?: undefined | number } Optional, parameters object: width - page width in points, height - page height in points, pageIndex - page index.

Upload local changes to server.

pageIndex: number
annotation: AnnotationBase

// Scroll to page 10.
viewer.scrollPageIntoView( { pageNumber: 10 } )

// Scroll the annotation bounds rectangle into view:
var rectangle = annotation.rect;
var pagePosX = rectangle[0];
var pagePosY = rectangle[1] + Math.abs(rectangle[3] - rectangle[1]);
viewer.scrollPageIntoView({ pageNumber: pageIndex + 1, destArray: [null, { name: "XYZ" }, pagePosX, pagePosY, viewer.zoomValue / 100.0] });

Select annotation for editing.

// Select an annotation with id 2R:
viewer.selectAnnotation("2R");

// Select an annotation with id 9R located on the last page:
viewer.selectAnnotation(viewer.pageCount - 1, "9R");

submitUrl: string

Reset annotation selection.

pageIndex: number
annotation: AnnotationBase

Update radio buttons group given by parameter fieldName with new field value.

Gets the file name that was used to open the document.
 The file name is determined as follows:

If a local file was opened using the ""Open File"" dialog, returns the local file name;
else, if a new file was created using the ""newDocument"" method, returns the argument passed to that method;
else, if options.friendlyFileName is not empty, returns its value;
 else, returns the name generated from the URL passed to the ""open"" method.

var viewer = new GcPdfViewer('#root');
viewer.addDefaultPanels();
viewer.onError.register(handleError);
viewer.open('Test.pdf');

function handleError(eventArgs) {
    var message = eventArgs.message;
    if (message.indexOf("Invalid PDF structure") !== -1) {
        alert('Unable to load pdf document, pdf document is broken.');
    } else {
        alert('Unexpected error: ' + message);
    }
}

function loadPdfViewer()
{
var viewer = new GcPdfViewer('#root');
viewer.addDefaultPanels();
viewer.onError.register(handleError);
viewer.open('Test.pdf');
function handleError(eventArgs)
{
var message = eventArgs.message;
if (message.indexOf("Invalid PDF structure") !== -1)

alert('Unable to load pdf document, pdf document is broken.');
}
else {
alert('Unexpected error: ' + message);
}
}