An ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

It checks whether the viewer is currently at the maximum zoom level.

An ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

It checks whether the viewer is currently at the minimum zoom level.

An ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Gets and sets the current mouse tool of the viewer by name.

An ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Gets a value indicating whether the comments panel is open.

An ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Gets or sets the mark handle mode.

An ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Gets the document page count.

An ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Gets and sets the current page of the viewer to the specified page number in the document. Setting the page number to a value other than the current page number will cause the viewer to navigate to the page number provided in the parameter.

An ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Gets or sets the redaction view mode. This defines whether the document content text underneath redaction rectangles needs to be visible in a "Draft" mode PCCViewer.RedactionViewMode enumerable values.

An ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Gets or sets the scale factor to use in the viewer, with 1 being 100% zoom.

An ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Gets the SearchRequest object from the last call to PCCViewer.ViewerControl#search.

An ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Gets and sets the selected conversation.

An ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Gets an array of selected marks.

An ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Gets and sets the selected SearchResult object. Returns null if no search results are selected. Note: Setting the search result through this property will always scroll to it.

An ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Gets or sets the view mode. This defines how the document pages will be scaled, based on the values of the PCCViewer.ViewMode enumerable values.

A plain object convention describing a text selection.

A plain object convention describing a text selection rectangle.

Creates a new mark of a specific type and adds to the specified page.

Example

viewerControl.addMark(1, "LineAnnotation");

Creates a new mark of a specific type and adds to the location where the specified search result is.

Example

 var requestObject = PCCViewer.search('Con');
 var marks = [];
 var newMark;
 requestObject.on(PCCViewer.EventType.SearchCompleted, function (event) {
     var searchResults = event.completedSearchResults;
     for (var i = 0; i < searchResults.length; i++) {
         newMark = viewer.addMarkFromSearchResult(searchResults[i], PCCViewer.Mark.Type.TextSelectionRedaction);
         marks.push(newMark);
     }
 });

Burns redactions and signatures in the document. Note: CAD files are not supported.

If the parameter options.removeFormFields is invalid, then the PCCViewer.Promise object that is returned will be rejected with the reason set to a PCCViewer.Error object with its code property set to InvalidArgument.

Example

function onSuccessfulBurn(burnturl) {
   alert("burntURL = " + burnturl);
   console.log(burnturl);
}
function onFailedBurn(error) {
   alert("burn Process failed, error:" + (error.message ? error.message : error));
}

// A BurnRequest object is created by and returned from the call to the burnMarkup method
var burnRequest = viewerControl.burnMarkup();
burnRequest.then(onSuccessfulBurn, onFailedBurn);

//register some events
burnRequest
  .on(PCCViewer.BurnRequest.EventType.BurnCompleted,
      function(ev) {
          alert("Document burn completed.");
      })
  .on(PCCViewer.BurnRequest.EventType.BurnProgress,
      function(event) {
          alert("Burn progress: " + event.percent + "%");
      })
  .on(PCCViewer.BurnRequest.EventType.BurnFailed,
      function(event) {
          alert("Document burn failed.");
      });

  // Also, methods on the burnRequest object can be used

  // get the options used to burn the document.
  var optionsUsed = burnRequest.getOptions();

  //if the process is still incomplete, cancel can be used to stop queries to the server.
  if (burnRequest.getProgress() >= 0 && burnRequest.getProgress() < 100) {
       burnRequest.cancel();
  }

Informs whether the current browser is capable of printing the annotations and redactions on a document. If true, the document can be printed with annotations and redactions. If false, the document will be printed without annotations, regardless of the print request made.

Example

var printWithMarks = true;
viewerControl.print({
 includeMarks: (printWithMarks && viewerControl.canPrintMarks())
});

Sets the current page of the viewer to the first page of the document.

Note: Does nothing if the current page is the first page of the document.

Example

viewerControl.changeToFirstPage();

Sets the current page of the viewer to the last known page of the document.

Note: Does nothing if the current page is the last known page of the document.

Example

viewerControl.changeToLastPage();

Sets the current page of the viewer to the next page of the document.

Note: Does nothing if the current page is the last known page of the document.

Example

viewerControl.changeToNextPage();

Sets the current page of the viewer to the previous page of the document.

Example

viewerControl.changeToPrevPage();

Changes the viewer to a different viewing session, allowing the viewer to work with a different document. If you intend to return to the current viewing session in the future, set isRestorable to true. Otherwise, the current viewer state and any annotation data in memory will be disposed.

Example

viewerControl.changeViewingSession(anotherViewingSessionId)
    .on(PCCViewer.EventType.ViewingSessionChanged, function(ev) {
        alert("Viewing session changed.");
    });

Deselects the text provided in a TextSelected event.

Example

var onTextSelected = function(ev){
    var mark = viewerControl.addMark(ev.textSelection.pageNumber, 'HighlightAnnotation');
    mark.setPosition(ev.textSelection);

    // clear the highlighted text
    ViewerControl.clearMouseSelectedText(ev.textSelection);
};

viewerControl.on('TextSelected', onTextSelected);

Clears the search hit highlights and removes the SearchRequest from the ViewerControl.

After calling this, PCCViewer.ViewerControl#getSearchRequest will not return the last SearchRequest.

Example

viewerControl.search("Foo");
// As search results become available, they are highlighted on the document.

// Clear search result highlights from the document.
viewerControl.clearSearch();

This methods clears the search result selection, or in other words, it deselects the search result. If there is not a selected search result when this method is called, then the method has no effect.

This method is offered as a convenience to API callers, who could also call PCCViewer.ViewerControl#setSelectedSearchResult(null).

Example

var searchRequest = viewerControl.search('Accusoft');

// add events to the search request
searchRequest.on("SearchCompleted", function(){
    // get the search results
    results = searchRequest.getResults();

    // set the result to the first
    viewerControl.setSelectedSearchResult(results[0], true);

    // clear the selected search result
    viewerControl.clearSelectedSearchResult();
});

Searches the text of the document for the given searchQuery. The search is performed client-side, which requires requesting from the server text for each page. This is efficient for smaller documents, but for large documents it is more efficient to use the PCCViewer.ViewerControl#serverSearch method instead.

This query can be a single search term or a hash specifying one or more terms and options. If only a single search term (string) is supplied, then default options are used.

Search completes asynchronously. The returned PCCViewer.SearchRequest object, provides events for search progress and members to access search results.

Example

// Search on a single term with default options
var searchRequest = viewerControl.clientSearch("Hello");

// Subscribe to the PartialSearchResultsAvailable event to get search results as they become available.
searchRequest.on('PartialSearchResultsAvailable', function(_event) {
    // Get the newly available search results.
    var newResults = _event.partialSearchResults;
});

Example

// Search on multiple terms and specify options
var searchQuery = {
    searchTerms: [{
        searchTerm: "sub",
        contextPadding: 25,
        highlightColor: '#B22222',
        matchingOptions: {
            beginsWith: true,
        }
    },
    {
        searchTerm: "Accusoft"
    }]
};

var requestObject = viewerControl.clientSearch(searchQuery);

//subscribe to the search request
requestObject.on('PartialSearchResultsAvailable', function(_event) {
    var newResults = [];
    //Retrieve results
    newResults = _event.partialSearchResults;
});

Closes the comments panel.

Example

viewerControl.closeCommentsPanel();

Deprecated since v11.0 (use the PCCViewer.ViewerControl#requestDocumentConversion method instead).

Converts page-based coordinates to the current window coordinates. This allows passing in a coordinate point or an array of points as used in the ViewerControl API, in order to get the position of that point or points relative to the window.

Deprecated since v13.16 (use the PCCViewer.ViewerControl#addMarkFromSearchResult method instead).

Deprecated since v13.16 (use the PCCViewer.ViewerControl#addMarkFromSearchResult method instead).

Makes a copy of the specified marks.

Note: This method requires that attributes of each page referenced by the marks have been obtained by the viewer prior to calling. Use PCCViewer.ViewerControl#requestPageAttributes to obtain the necessary page attributes before calling this method.

Example

// Make a copy of the selected marks.
var copiedMarks = viewerControl.copyMarks(viewerControl.getSelectedMarks());

Deletes all marks in all the pages of the document.

Example

viewerControl.deleteAllMarks();

Deletes the specified marks.

Example

// delete all selected marks
viewerControl.deleteMarks(viewer.getSelectedMarks());

Deselects all previously selected marks.

Example

viewerControl.deselectAllMarks();

Deselects the marks provided in the parameter array object.

Example

// deselect all marks with an odd-number ID
viewerControl.getSelectedMarks().forEach(function(mark){
    var arr = [];
    if (+mark.getId() % 2) arr.push(mark);
    viewerControl.deselectMarks(arr);
});

Deserializes JSON or a JSON-like object to PCCViewer.Mark objects, and adds them to the ViewerControl. This will display all deserialized marks.

Example

var markData = {
    "type": "RectangleAnnotation",
    "rectangle": {
        "x": 0,
        "y": 10,
        "width": 200,
        "height": 200
    },
    "fillColor": "#FB0404",
    "lineWidth": 4,
    "pageNumber": 1,
    "uid": "dW9qaV8yMDE5LTA4LTAxVDA2OjUzOjA1LjgxOVpfazhhbDFi",
    "data": {},
    "conversation": {
        "data": {}
    }
};

// Deserialize mark from object value
viewerControl.deserializeMarks(markData);

// Deserialize mark from JSON string
var markJson = JSON.stringify(markData);
viewerControl.deserializeMarks(markJson);

// Deserialize marks from array of objects
var markData2 = { ... };
viewerControl.deserializeMarks([markData, markData2]);

Closes the ViewerControl and cleans up its resources. After this action, a new viewer can be created in its place.

Note: If the viewer was created using the jQuery plugin (PCCViewer.Viewer), use the PCCViewer.Viewer.destroy method instead.

Example

var element = document.querySelector('#mydiv');
var viewerControl = new PCCViewer.ViewerControl(element, options);

viewerControl.destroy().then(() => {
  console.log('the viewer has been destroyed');
});

Disposes text for the specified page.

The text for any page requested programmatically by using the PCCViewer.ViewerControl#requestPageText method is not automatically disposed, even when the ViewerControl discardOutOfViewText parameter is set to true. You must use the disposePageText method to dispose of the text when you no longer need it.

If the specified page is currently displayed when calling this method, the page text will not be disposed immediately, but will be disposed when the page is scrolled out of view and no longer displayed.

Client search depends on the page text, so page text is not disposed after performing client search.

Example

viewerControl.disposePageText(10);

Indicates whether or not any pages in the document have text. This method returns a promise, which can resolve at an indefinite time. This promise will resolve at the first instance of finding text in the document, but will not actively search for text if none is yet found. Unless this promise has resolved, the user should assume that the document does not contain text.

For example, in a 100 page document, where only page 80 has text, this promise will not resolve until the user views page 80. If the document were to have no text at all, the promise will not resolve until all 100 pages were viewed by the user.

The successful callback be passed only a boolean indicating whether the document has any text or not.

Example

var promise = viewerControl.documentHasText().then(
    function success(containsTextBool){
        alert('Document has text: ' + (containsTextBool ? 'Yes' : 'No'));
    },
    function fail(error){
        alert('Document has text: unknown due to error "' + error.message + '"');
    }
);

Puts a displayed PCCViewer.Mark object of type TextInputSignature, TextAreaSignature, TextRedaction, or TextAnnotation into editing mode. In editing mode, a text input or text box will be drawn for the mark and the input will have focus. When in editing mode, the end user type to modify the text of the mark.

All marks other than the specified mark will be taken out of text mark editing mode.

Note that if the mark is not on a page that is currently displayed, then this method may have no perceived effect. The act of changing pages to bring the off screen page into view would take the focus off of the mark that is in editing mode.

Example

// Add a mark
var myMark = viewerControl.addMark(4, PCCViewer.Mark.Type.TextAnnotation)
    .setRectangle({
        x: 0,
        y: 600,
        width: 500,
        height: 100
    });

// Put the mark in editing mode and scroll to the mark.
viewerControl.enterTextMarkEditingMode(myMark);

Changes the scaling (zoom) of the document to fit the content in the viewer. How the content is fit in the viewer is based on the specified by the values in the PCCViewer.FitType enumerable.

Example

// Explicitly specify the fit type
viewerControl.fitContent("FullWidth");

// or use the enumeration
viewerControl.fitContent(PCCViewer.FitType.FullWidth);

Gets the viewer control's active markup layer.

Example

var activeMarkupLayer = viewerControl.getActiveMarkupLayer();

Gets all marks.

Example

var allMarks = viewer.getAllMarks();

Gets a value that indicates whether the viewer is currently at the maximum scale factor. As long as this value is true, the ViewerControl do nothing if asked to zoom in any further.

This method determines the value each time, and will be affected by the following:

1. The viewer scale changes due to zoomIn, zoomOut, or fitContent.
2. The window resizes.
3. The div that holds the viewer control is resized.

Example

// Check for change after the viewer scale changes
viewerControl.on(PCCViewer.EventType.ScaleChanged, function(ev){
    var atMax = viewer.getAtMaxScale();
}

Example

// Check for change when the window resizes (using jQuery)
$(window).resize(function() {
    var atMax = viewer.getAtMaxScale();
});

Gets a value that indicates whether the viewer is currently at the minimum scale factor. As long as this value is true, the ViewerControl do nothing if asked to zoom out any further.

This method determines the value each time, and will be affected by the following:

1. The viewer scale changes due to zoomIn, zoomOut, or fitContent.
2. The window resizes.
3. The div that holds the viewer control is resized.

Example

// Check for change after the viewer scale changes
viewerControl.on(PCCViewer.EventType.ScaleChanged, function(ev){
    var atMax = viewer.getAtMinScale();
}

Example

// Check for change when the window resizes (using jQuery)
$(window).resize(function() {
    var atMax = viewer.getAtMinScale();
});

Returns the index of the character at the location of the specified object. If there is no character at the location, the index of the character before the location (based on the closest line of text) is returned.

Example

// get the first selected Mark object
var theFirstMark = viewerControl.getSelectedMarks()[0];

// get the sort index
if (theFirstMark) var firstMarkSortIndex = viewerControl.getCharacterIndex(theFirstMark);

Gets the status of client-side functionality restrictions.

Example

var restrictions = await viewerControl.getClientRestrictions();

// restrictions now contains:
// {
//     sharpening: "enabled",
//     gamma: "enabled",
//     svgLineWidthMuliplier: "enabled",
//     print: "enabled"
// }

Gets the conversation DOM factory function. The default factory function is returned if a factory function has not been set using the PCCViewer.ViewerControl#setConversationDOMFactory method.

Gets the current mouse tool of the viewer.

Example

// get the current mouse tool name
var mouseToolName = viewerControl.getCurrentMouseTool();

// get the actual MouseTool object
var mouseToolObject = PCCViewer.MouseTools.getMouseTool(mouseToolName);

Gets the URL to download the original document.

Example

// get the URL
var documentURL = viewerControl.downloadDocument();

// download the document
window.location.href = documentURL;

Gets the gamma factor for the document.

Example

var gamma = viewerControl.getGamma();

Returns a value (true or false) indicating if the comments panel is open.

Example

var isCommentsPanelOpen = viewerControl.getIsCommentsPanelOpen();  // true if comments panel is open

Gets the specified mark.

Example

var mark = viewer.getMarkById(1);

Gets the mark handle mode.

Get marks by type.

Example

var marksByType = viewer.getMarksByType(markType);

Gets the viewer control's markup layer collection.

Example

var markupLayerCollection = viewerControl.getMarkupLayerCollection();

Gets the maximum scale limit.

Example

var maxScaleFactor = viewerControl.getMaxScaleFactor();
viewerControl.setScaleFactor(maxScaleFactor); // Zoom in to the maximum scale limit.

Gets the minimum scale limit.

Example

var minScaleFactor = viewerControl.getMinScaleFactor();
viewerControl.setScaleFactor(minScaleFactor); // Zoom out to the minimum scale limit.

Gets the known page count of the current document.

This value is updated when the viewer gets the page count or estimated page count from the server. Subscribe to the PCCViewer.EventType.PageCountReady and PCCViewer.EventType.EstimatedPageCountReady events to be notified when the viewer gets the page count from the server.

The initial value is 1, before any page count event.

Example

// First, create the pccViewer.
var viewerControl = $("#viewer").pccViewer(viewerOptions).viewerControl;

function pageCountReadyHandler(event) {
    // The page count has now been determined.
    var pageCount = viewer.getPageCount();
    alert("Number of pages = " + pageCount);

    // Now, unsubscribe from the event.
    viewerControl.off("PageCountReady", pageCountReadyHandler);
}

// Subscribe to the PageCountReady event exposed by the API
viewerControl.on("PageCountReady", pageCountReadyHandler);

Gets the page layout. This defines how the document pages will be arranged, based on the values of the PCCViewer.PageLayout enumeration.

Example

var pageLayout = viewerControl.getPageLayout();

Gets the current page number of the viewer. This is a 1-based value, so the first page of a document is 1.

Example

var currentPageNumber = viewerControl.getPageNumber();

Gets the page rotation value for the specified page number.

Example

// first create the pccViewer : Note: if the viewer object has already been created, do not re-create it.
var viewerControl = $("#viewer").pccViewer(viewerOptions).viewerControl;

var pageNumber = 2;
var rotationAngle = viewerControl.getPageRotation(pageNumber);

Gets the redaction view mode. This defines whether the redaction rectangles would show the underlying document content text PCCViewer.RedactionViewMode enumerable values.

Example

var viewMode = viewerControl.getRedactionViewMode();

Gets a list of all saved markups from the server for the current document.

If unable to retrieve markup list from server, then the returned PCCViewer.Promise object is rejected with the reason set to a PCCViewer.Error object with its code property set to MarkupListFail.

If AJAX is not supported, then the returned PCCViewer.Promise object is rejected with the reason set to a PCCViewer.Error object with its code property set to AjaxUnsupported.

If a server error is encountered, then the returned PCCViewer.Promise object is rejected with the reason set to a PCCViewer.Error object with its code property set to Error.

The PCCViewer.Promise~onFulfilled function gets passed an Array of Objects. Each object will have a name property, which is a string representation of the name used to save the markup.

Example

viewerControl.getSavedMarkupNames().then(
    function onSuccess(markupNameObjects) {
        var namesArray = [];
        for (var i = 0; i < markupNames.length; i++) {
            namesArray.push(markupNames[i].name);
        }
        alert(namesArray.join(', ');
    },
    function onFailure(error) {
        alert((error.message ? error.message : error));
    }
);

Gets the scale factor of the viewer.

Example

var scaleFactor = viewerControl.getScaleFactor();

Gets the SearchRequest object from the last call to PCCViewer.ViewerControl#search.

Example

var searchRequestA = viewerControl.search("Foo");
var searchRequestB = viewerControl.getSearchRequest();
searchRequestA === searchRequestB;   // true

Gets the selected conversation.

Example

var selectedConversation = viewerControl.getSelectedConversation();

Obtains all the selected marks in the currently loaded document. If none of the marks are selected or if the document does not contain any marks then the returned array will be empty.

Example

var selectedMarks = viewerControl.getSelectedMarks();

if (selectedMarks.length) alert(selectedMarks.length + " marks are currently selected");
else alert("No marks are currently selected");

Gets the selected PCCViewer.SearchResult object.

gets the sharpening factor for the document.

Example

var sharpening = viewerControl.getSharpening();

Gets the current multiplier used to adjust SVG line widths in the document.

Example

var svgLineWidthMultiplier = viewerControl.getSvgLineWidthMultiplier();

Gets the view mode. This defines how the document pages will be scaled, based on the values of the PCCViewer.ViewMode enumerable values.

Example

var viewMode = viewerControl.getViewMode();

Hides the specified marks.

Example

// hides all selected marks
viewerControl.hideMarks(viewer.getSelectedMarks());

Returns a value indicating if the ViewerControl has loaded text for a page from the server.

Several of the ViewerControl's methods require that the ViewerControl has loaded the text for the page. These methods will not work if the text for the target page(s) is not loaded. This set of methods includes:

• PCCViewer.ViewerControl#getCharacterIndex
• PCCViewer.Mark#setPosition

The ViewerControl may delay loading of text for a page, so it is not safe to assume that the ViewerControl has text for a page when ViewerReady is triggered. However, if you have gotten page text through the viewer, then it is safe to assume the viewer has text for the page. For example, if you get text through a SearchResult generated by PCCViewer.ViewerControl#search or by calling PCCViewer.ViewerControl#requestPageText, then the viewer will have loaded page text from the server.

Example

if (!viewerControl.isPageTextReady(1)) {
    viewerControl.requestPageText(1).then(
        function(pageText) {
            highlightSomeText({
                startIndex: 0,
                length: pageText.length
            });
        }
    );
} else {
    // Note that it's pretty silly to blindly highlight text, you would almost always want to know
    // the text that you are trying to highlight before calling the API to set the position. But, this is just
    // an example to demonstrate when you don't *have* to request the page text.
    highlightSomeText({startIndex: 0, length: 5});
}

// Note: An alternative to the if-else above, would be to always call requestPageText, which will immediately resolve
// if the viewer already has page text. Using this approach, you don't need to call `isPageTextReady`.
// viewerControl.requestPageText(1).then(
//     function(pageText) {
//          highlightSomeText({
//              startIndex: 0,
//              length: pageText.length
//          });
//      }
// );

function highlightSomeText(position) {
    viewerControl.addMark(1, "HighlightAnnotation")
        .setPosition(position);
}

Gets a list of all attachments of the document currently loaded on the viewer.

If unable to retrieve the attachment list from server, then the returned PCCViewer.Promise object is rejected with the reason set to a PCCViewer.Error object with its code property set to AttachmentListFail.

If AJAX is not supported, then the returned PCCViewer.Promise object is rejected with the reason set to a PCCViewer.Error object with its code property set to AjaxUnsupported.

If a server error is encountered, then the returned PCCViewer.Promise object is rejected with the reason set to a PCCViewer.Error object with its code property set to Error.

The PCCViewer.Promise~onFulfilled function gets passed an array of attachment objects.

Example

viewerControl.loadAttachments().then(
    function onSuccess(attachments) {
        var fileNames = [];
        for (var i = 0; i < attachments.length; i++) {
            fileNames.push(attachments[i].name);
        }
        alert(fileNames.join(', ');
    },
    function onFailure(error) {
        alert((error.message ? error.message : error));
    }
);

Loads the markup with the specified name from the server. This returns a PCCViewer.Promise object.

If the parameter recordName is invalid, then the PCCViewer.Promise object that is returned will be rejected with the reason set to a PCCViewer.Error object with its code property set to InvalidAnnotationRecord.

If the optional parameters retainExistingMarks or markupLayer are specified but invalid, then the PCCViewer.Promise object that is returned will be rejected with the reason set to a `PCCViewer.Error' object.

If a server error is encountered, then the returned PCCViewer.Promise object is rejected with the reason set to a PCCViewer.Error object with its code property set to Error.

If AJAX is not supported, then the returned PCCViewer.Promise object is rejected with the reason set to a PCCViewer.Error object with its code property set to AjaxUnsupported.

Note: Any existing marks in the document are removed before marks are loaded.

Note: This method triggers the following events: PCCViewer.EventType.MarkCreated, PCCViewer.EventType.MarkChanged and PCCViewer.EventType.MarkChanged.

Example

viewerControl.loadMarkup("mymarkup").then(
function onResolved() {
    // update the UI, or whatever... because the markup loaded successfully
},
function onRejected(error) {
    alert("loading failed! " + (error.message ? error.message : error));
});

Load markup layer records from the server. This method loads one or more layers from the server asynchronously, and returns a Promise to resolve the request.

The onFulfilled callback will receive an object containing PCCViewer.MarkupLayer objects representing the loaded layers.

The onRejected callback will receive a PCCViewer.Error object defining why the load function failed.

Example

// load a layer

viewerControl.loadMarkupLayers('abc123').then(
    function onSuccess(layers){
        console.log('layer loaded successfully', layers[0].getId());
    },
    function onFailure(reason){
        console.log('layer failed to load:', reason.code, reason.message);
    }
);

Moves the specified mark one slot backward from its position in the internal z-order. When the marks overlap, marks that are higher in this internal z-order are drawn over the marks that are lower.

Example

// get the first selected Mark object
var theFirstMark = viewerControl.getSelectedMarks()[0];

// move it backward
if (theFirstMark) viewerControl.moveMarkBackward(theFirstMark);

Moves the specified mark one slot toward the top of the internal z-order. When the marks overlap, marks that are higher in this internal z-order are drawn over the marks that are lower.

Example

// get the first selected Mark object
var theFirstMark = viewerControl.getSelectedMarks()[0];

// move it forward
if (theFirstMark) viewerControl.moveMarkForward(theFirstMark);

Moves the specified mark to the back. When the marks overlap, the marks that are higher in the internal z-order on a page are drawn over the ones that are lower.

Example

// get the first selected Mark object
var theFirstMark = viewerControl.getSelectedMarks()[0];

// move to back
if (theFirstMark) viewerControl.moveMarkToBack(theFirstMark);

Moves the specified mark to the front or to the top of internal z-order on a page. When the marks overlap, the marks with higher internal z-order are drawn over the ones that are lower.

Example

// get the first selected Mark object
var theFirstMark = viewerControl.getSelectedMarks()[0];

// move to front
if (theFirstMark) viewerControl.moveMarkToFront(theFirstMark);

Unsubscribe an event handler from a specified event type.

Typically, an event is unsubscribed when you no longer want further notification of the event.

Example

// Our event handler declaration
function handler(event) {
    alert("An event was fired: " + event.getType());
}

// Subscribe
viewerControl
    .on("PageChanged", handler)
    .on("PageCountReady", handler);

// Un-subscribe
viewerControl
    .off("PageChanged", handler)                        // Use string literals or the enum.
    .off(PCCViewer.EventType.PageCountReady, handler);  // Chain unsubscription.

Subscribe an event handler to an event of a specified type.

Example

// Create the viewer and get the ViewerControl object.
var viewerControl = $("#viewer").pccViewer(viewerOptions}).viewerControl;

// Our event handler declaration
function handler(event) {
    alert("An event was fired: " + event.getType());
}

viewerControl
    .on(PCCViewer.EventType.PageChanged, handler)    // Use the PCCViewer.EventType enum.
    .on(PCCViewer.EventType.PageDisplayed, handler)  // Chain event subscription.
    .on("PageLoadFailed", handler);                  // Use string literals instead of the EventType enum.

Opens the comments panel.

Example

viewerControl.openCommentsPanel();

Print the document associated with the PCCViewer.ViewerControl object. Note, the "print" method will only work if the correct "printTemplate" value is passed to "ViewerControlOptions" while initializing the "ViewerControl" instance. It is recommended that this value be set to the content of the "printTemplate.html" file. If this value is set to an empty string (default), then printing will be unavailable.

Example

// Prints pages 1 and 3 of the document.
// Any annotations on those pages will also be printed if supported by the browser.
viewerControl.print({
    range : "1, 3",
    includeMarks : true
});

Forces a DOM refresh of a specified conversation or set of conversations, or all conversations known to the ViewerControl.

Converts the document and provides an array of URLs to download each converted document. Note that this method currently only supports converting to a single PDF file, so the output array will only contain a single URL.

Example

function onSuccessfulConversion(convertedurl) {
   alert("convertedURL = " + convertedurl);
   console.log(convertedurl);
}
function onFailedConversion(error) {
   alert("conversion process failed, error:" + (error.message ? error.message : error));
}

// A ConversionRequest object is created by and returned from the call to the convertDocument method
var conversionRequest = viewerControl.convertDocument();
conversionRequest.then(onSuccessfulConversion, onFailedConversion);

// Register some events
conversionRequest
  .on(PCCViewer.ConversionRequest.EventType.ConversionCompleted,
      function(ev) {
          alert("Document conversion completed.");
      })
  .on(PCCViewer.ConversionRequest.EventType.ConversionProgress,
      function(event) {
          alert("Conversion progress: " + event.percent + "%");
      })
  .on(PCCViewer.ConversionRequest.EventType.ConversionFailed,
      function(event) {
          alert("Document conversion failed.");
      });

  // Also, methods on the conversionRequest object can be used

  // Get the options used to convert the document.
  var optionsUsed = conversionRequest.getOptions();

  // If the process is still incomplete, cancel can be used to stop queries to the server.
  if(conversionRequest.getProgress() >= 0 && conversionRequest.getProgress() < 100) {
       conversionRequest.cancel();
  }

Requests the DocumentHyperlinks of the specified page.

The DocumentHyperlinks will be made available via the returned PCCViewer.Promise object. The PCCViewer.Promise~onFulfilled function will be called with an array of DocumentHyperlinks that are contained on the page. If there are no DocumentHyperlinks on the page, then the returned array will be empty.

If the pageNumber parameter is invalid at the time the method is called, then the returned PCCViewer.Promise object is rejected with either the reason set to a PCCViewer.Error object with its code property set to InvalidArgument, or a RangeError object if the page number was less than 1 or greater than the value returned by PCCViewer.ViewerControl#getPageCount.

Example

// use PCCViewer.ViewerControl#requestDocumentHyperlinks(pageNumber)
var promise = viewerControl.requestDocumentHyperlinks(10);

promise.then(
    function (documentHyperlinks) {
        // Do something with the array of DocumentHyperlink objects.
        // In this example we iterate over.
        documentHyperlinks.forEach(function(dh) {
            // Alert the href of each hyperlink.
            // Note: don't actually do that because it could be really annoying!
            alert("Found another DocumentHyperlink " + dh.getHref());
        });
    },
    function (error) {
        alert("Something went wrong " + (error.message ? error.message : error));
    }
);

Gets a list of all saved markups layer records from the server for the current document. This method utilizes an asynchronous server request to fetch the data, and returns a Promise to resolve the request.

The onFulfilled callback will receive an object representing the annotationLayerRecords persisted on the server.

The onRejected callback will receive a PCCViewer.Error object defining why the save function failed.

The PCCViewer.Promise~onFulfilled function gets passed an Array of Objects. Each object will have 1) a name property, which is a string representation of the name used to save the markup layer record and 2) a layerRecordId property which is the string representation the uniquely identifies the record on the server.

Example

viewerControl.requestMarkupLayerNames().then(
    function onSuccess(annotationLayerRecords) {
        var annotationLayerRecordsArray = [];
        for (var i = 0; i < annotationLayerRecords.length; i++) {
            annotationLayerRecordsArray.push(annotationLayerRecords[i].name);
        }
        alert(annotationLayerRecordsArray.join(', '));
    },
    function onFailure(error) {
        alert(error.message ? error.message : error);
    }
);

Requests attributes for the specified page.

If the pageNumber parameter is invalid at the time the method is called, then the returned PCCViewer.Promise object is rejected with either the reason set to a PCCViewer.Error object with its code property set to InvalidArgument, or a RangeError object if the page number was less than 1 or greater than the value returned by PCCViewer.ViewerControl#getPageCount.

If a server error is encountered, then the returned PCCViewer.Promise object is rejected with the reason set to a PCCViewer.Error object with its code property set to Error.

The PCCViewer.Promise~onFulfilled function will receive and Object with properties width and height, representing the reported width and height of each page.

Example

var promise = viewerControl.requestPageAttributes(10).then(
    function(pageAttributes) {
        alert('Page 10 attributes: width: ' + pageAttributes.width + ', height: ' + pageAttributes.height);
    },
    function(error) {
        alert('Page attributes retrieval for page 10 failed: ' + (error.message ? error.message : error));
    }
);

Requests the specified text page.

If the pageNumber parameter is invalid at the time the method is called, then the returned PCCViewer.Promise object is rejected with either the reason set to a PCCViewer.Error object with its code property set to InvalidArgument, or a RangeError object if the page number was less than 1 or greater than the value returned by PCCViewer.ViewerControl#getPageCount.

If a server error is encountered, then the returned PCCViewer.Promise object is rejected with the reason set to a PCCViewer.Error object with its code property set to Error.

The PCCViewer.Promise~onFulfilled function will receive and string value, representing the text found on that page. If the page has no text, this will be an empty string.

Example

var promise = viewerControl.requestPageText(10).then(
    function(pageText) {
        alert('Text from page 10: ' + pageText);
    },
    function(error) {
        alert('Text retrieval for page 10 failed: ' + (error.message ? error.message : error));
    }
);

Requests the revisions for a given document comparison.

Revisions request completes asynchronously. The returned PCCViewer.RevisionsRequest object provides events for revisions retrieval progress and members to access retrieved revisions.

Example

// Request revisions with default options:
var revisionsRequest = viewerControl.requestRevisions();

// Subscribe to the PartialRevisionsAvailable event to get revisions as they become available.
revisionsRequest.on('PartialRevisionsAvailable', function(_event) {
    // Get the newly available revisions:
    var newRevisions = _event.partialRevisions;
});

Rotates all pages in the document by the specified degrees clockwise, relative to each page's current orientation. Note: Using rotateDocument only affects how the document is displayed and does not affect the original document data.

Example

viewerControl.rotateDocument(90);    // Rotates 90 degrees clockwise
viewerControl.rotateDocument(-90);   // Rotates 90 degrees counter-clockwise
viewerControl.rotateDocument(180);   // Rotates 180 degrees
viewerControl.rotateDocument(540);   // Also, rotates 180 degrees
viewerControl.rotateDocument(100);   // Throws!

Rotates the current page by the specified degrees clockwise, relative to the page's current orientation. Note: Using rotatePage only affects how the document is displayed and does not affect the original document data.

Example

viewerControl.rotatePage(90);    // Rotates 90 degrees clockwise
viewerControl.rotatePage(-90);   // Rotates 90 degrees counter-clockwise
viewerControl.rotatePage(180);   // Rotates 180 degrees
viewerControl.rotatePage(540);   // Also, rotates 180 degrees
viewerControl.rotatePage(100);   // Throws!

Saves all markups in the document to the server as a record with a specified name.

If the parameter recordName is not a string, then the PCCViewer.Promise object that is returned will be rejected with the reason set to a PCCViewer.Error object with its code property set to InvalidArgument.

If the parameter recordName contains invalid characters in the name, then the PCCViewer.Promise object that is returned will be rejected with the reason set to a PCCViewer.Error object with its code property set to InvalidCharactersFilename.

If a server error is encountered, then the returned PCCViewer.Promise object is rejected with the reason set to a PCCViewer.Error object with its code property set to Error.

If AJAX is not supported, then the returned PCCViewer.Promise object is rejected with the reason set to a PCCViewer.Error object with its code property set to AjaxUnsupported.

The PCCViewer.Promise~onFulfilled function will receive the recordName string as its only argument.

Note: This method will overwrite any previous markup stored with the same name. To prevent duplicates, check to see if the name already exists by using PCCViewer.ViewerControl#getSavedMarkupNames.

Example

// The following example will save all annotations and redaction mark types. It will not save signature mark types.
viewerControl.saveMarkup('cool name').then(
    function success(name) {
        alert('Markup was saved as "' + name + '"');
    },
    function fail(error) {
        alert('Markup was not saved. ' + (error.message ? error.message : error));
    }
);

// The following will save signature mark types only.
viewerControl.saveMarkup('cool name', {
    includeAnnotations: false,
    includeRedactions: false,
    includeSignatures: true
}).then(
    function success(name) {
        alert('Markup was saved as "' + name + '"');
    },
    function fail(error) {
        alert('Markup was not saved. ' + (error.message ? error.message : error));
    }
);

Save a markup layer record to the server. This method saves a single layer to the server asynchronously, and returns a Promise to resolve the request.

The onFulfilled callback will receive an object containing the layerRecordId of the saved layer.

The onRejected callback will receive a PCCViewer.Error object defining why the save function failed.

Example

// save the current active layer
var layer = viewerControl.getActiveMarkupLayer();

viewerControl.saveMarkupLayer(layer.getId()).then(
    function onSuccess(layerInfo){
        console.log('layer saved successfully', layerInfo.layerRecordId);
    },
    function onFailure(reason){
        console.log('layer failed to save:', reason.code, reason.message);
    }
);

Scrolls by specified offset.

Example

// scroll by specified offset
viewerControl.scrollBy(100, 100);

Scrolls to the specified object.

Example

// get the first selected Mark object
var theFirstMark = viewerControl.getSelectedMarks()[0];

// scroll to the mark
viewerControl.scrollTo(theFirstMark);

Scrolls to the specified object.

The returned PCCViewer.Promise object will resolve if the page list has completed all scrolling and the page containing the target is displayed.

The returned PCCViewer.Promise object is rejected with the reason set to a PCCViewer.Error object if:

• The specified target is not a valid PCCViewer.Mark, PCCViewer.Conversation, or PCCViewer.SearchResult, or if it is not an Object with valid pageNumber, x, and y values. When specifying a pageNumber greater than 1, this method requires that the PageCountReady event has been triggered, otherwise the promise is rejected.
• The specified target is a PCCViewer.Mark, PCCViewer.Conversation, or PCCViewer.SearchResult unknown to the viewer control.
• The PCCViewer.ViewerControl#scrollTo or PCCViewer.ViewerControl#scrollToAsync method is called before the promise is resolved.

Example

// get the first selected Mark object
var theFirstMark = viewerControl.getSelectedMarks()[0];

// scroll to the mark
var promise = viewerControl.scrollToAsync(theFirstMark).then(
    function() {
        // after the mark has been scrolled to, select the mark
        viewerControl.selectMarks([theFirstMark]);
    },
    function(error) {
        alert('Scrolling failed: ' + (error.message ? error.message : error));
    }
);

Searches the text of the document for the given searchQuery.

This query can be a single search term or a hash specifying one or more terms and options. If only a single search term (string) is supplied, then default options are used.

Search completes asynchronously. The returned PCCViewer.SearchRequest object, provides events for search progress and members to access search results.

Example

// Search on a single term with default options
var searchRequest = viewerControl.search("Hello");

// Subscribe to the PartialSearchResultsAvailable event to get search results as they become available.
searchRequest.on('PartialSearchResultsAvailable', function(_event) {
    // Get the newly available search results.
    var newResults = _event.partialSearchResults;
});

Example

// Search on multiple terms and specify options
var searchQuery = {
    searchTerms: [{
        searchTerm: "sub",
        contextPadding: 25,
        highlightColor: '#B22222',
        matchingOptions: {
            beginsWith: true,
        }
    },
    {
        searchTerm: "Accusoft"
    }]
};

var requestObject = viewerControl.search(searchQuery);

//subscribe to the search request
requestObject.on('PartialSearchResultsAvailable', function(_event) {
    var newResults = [];
    //Retrieve results
    newResults = _event.partialSearchResults;
});

Selects the editable text in a mark's text editor

Example

var viewerControl = viewerControl.enterTextMarkEditingMode(textAnnotation).selectEditorText();

Selects the marks provided in the Array parameter.

Note: This method ignores any Mark objects with the interaction mode set to PCCViewer.Mark.InteractionMode.SelectionDisabled.

Example

// get all of the marks
var allMarks = viewerControl.getAllMarks();

// select all of them
viewerControl.selectMarks(allMarks);

Serializes any amount of Marks passed into the method.

This serialization needs to happen asynchronously, so the method will return a Promise, which wil resolve once all marks have been serialized, or get rejected if any error occurs in the process.

A successfully resolved Promise will receive an Array as its only argument, which will contain a plain Object representation of each mark that was passed into the method. These objects can be used with PCCViewer.ViewerControl#deserializeMarks in order to recreate the same marks at a later time.

Example

// get all selected marks, so we can serialize then
var marksToUse = viewerControl.getSelectedMarks();

viewerControl.serializeMarks(marksToUse).then(
    function success(markObjects) {
        // markObjects is an array of plain objects
        // they can be converted to a JSON string
        var markStr = JSON.stringify(markObjects);
    },
    function fail(reason) {
        alert('could not serialize marks: ' + reason);
    }
);

Searches the text of the document for the given searchQuery. The search is performed server-side. This is efficient for larger documents, but for smaller documents it is more efficient to use the PCCViewer.ViewerControl#clientSearch method instead.

This query can be a single search term or a hash specifying one or more terms and options. If only a single search term (string) is supplied, then default options are used.

Search completes asynchronously. The returned PCCViewer.SearchRequest object, provides events for search progress and members to access search results.

Example

// Search on a single term with default options
var searchRequest = viewerControl.serverSearch("Hello");

// Subscribe to the PartialSearchResultsAvailable event to get search results as they become available.
searchRequest.on('PartialSearchResultsAvailable', function(_event) {
    // Get the newly available search results.
    var newResults = _event.partialSearchResults;
});

Example

// Search on multiple terms and specify options
var searchQuery = {
    searchTerms: [{
        searchTerm: "sub",
        contextPadding: 25,
        highlightColor: '#B22222',
        matchingOptions: {
            beginsWith: true,
        }
    },
    {
        searchTerm: "Accusoft"
    }]
};

var requestObject = viewerControl.serverSearch(searchQuery);

//subscribe to the search request
requestObject.on('PartialSearchResultsAvailable', function(_event) {
    var newResults = [];
    //Retrieve results
    newResults = _event.partialSearchResults;
});

Sets the viewer control's active markup layer.

Example

viewerControl.loadMarkupLayers('abc123').then(
    function onSuccess(layers){
        var activeMarkupLayer = viewerControl.setActiveMarkupLayer(layers[0]);
    },
    function onFailure(reason){
        console.log('layer failed to load:', reason.code, reason.message);
    }
);

Sets the conversation DOM factory function.

Example

var conversationFactoryFunction = function(conversation, state, existingDOM) {
    var conversationDiv = document.createElement('div'); // Create a conversation DOM element.

    // Set the style of the conversation DOM element.
    conversationDiv.style.position = 'absolute';
    if (state.isSelected) { // Set a different background if the conversation is selected.
        conversationDiv.style.backgroundColor = 'white';
    } else {
        conversationDiv.style.backgroundColor = 'lightgray';
    }
    conversationDiv.style.left = '10px';
    conversationDiv.style.right = '0';
    conversationDiv.style.textAlign = 'left';

    // For each comment in the conversation, create a comment DOM element.
    var comments = conversation.getComments();
    for (var i = 0; i < comments.length; i++) {
        var commentDiv = document.createElement('div');

        // Set the style of the comment DOM element.
        commentDiv.style.position = 'relative';
        commentDiv.style.padding = '5px';
        commentDiv.style.border = '1px solid gray';
        if (i > 0) {
            commentDiv.style.borderTop = 'none';
        }

        commentDiv.appendChild(document.createTextNode(comments[i].getText())); // Add the comment text to the comment DOM element.
        conversationDiv.appendChild(commentDiv); // Add the comment DOM element to the conversation DOM element.
    }

    return conversationDiv; // Return the conversation DOM element.
 };

viewerControl.setConversationDOMFactory(conversationFactoryFunction);

Sets the current mouse tool of the viewer by name.

See the help section titled "Custom Mouse Tools" for a list of the existing default mouse tools in the viewer.

Sets the gamma factor for the document. Values from 1 to 10 will darken the document. Values from 0 to 1 will effectively lighten it. Note: This setting only affects viewing and is not persisted when printing or burning.

Example

viewerControl.setGamma(5); // Darkens content by a factor of 5
viewerControl.setGamma(0.5) // Lightens content by a factor of 0.5

Sets the mark handle mode.

Example

viewerControl.setMarkHandleMode(PCCViewer.MarkHandleMode.HideCornerHandlesWhenClose);

Sets the layout of the pages.

This property defines the placement or arrangement of the pages in the viewer. The default page layout is "Vertical", in which the pages are displayed as a single vertical column and a vertical scroll bar is displayed to bring into view the pages that are not in view. The "Horizontal" option displays the pages as a single horizontal row and has a horizontal scroll bar to bring into view the pages that are not in the view.

Comments are only supported when using vertical page layout. If the comments panel is open, setting the page layout to horizontal will close the comments panel.

Example

viewerControl.setPageLayout(PCCViewer.PageLayout.Horizontal);

Sets the current page of the viewer to the specified page number.

Example

// first create the pccViewer : Note: if the viewer object has already been created, do not re-create it.
var viewerControl = $("#viewer").pccViewer(viewerOptions).viewerControl;

var pageNumberSet = 2;
function pageChangedHandler(event) {
    var pageNumber = viewer.getPageNumber();
    if(pageNumber === pageNumberSet) {
        //now unsubscribe the event Note: do not unsubscribe if future notifications are required.
        viewerControl.off("PageChanged", pageChangedHandler);
        alert("Viewer was navigated to the desired page successfully");
    }
}
// Subscribe to PageChanged event exposed by the API
viewerControl.on("PageChanged", pageChangedHandler);
viewerControl.setPageNumber(pageNumberSet);

Sets the redaction view mode.

When set to "Draft" mode, this property will make visible the document content text underneath for the rectangle redaction and the text selection marks. In this mode, the redaction reasons will not be visible.

Setting the view mode to "Normal" will make the redaction rectangle marks and the text selection redactions opaque. In this mode, if the marks contain the redaction reasons then they will be visible.

Example

// show all the redaction rectangles and redaction text selection marks showing underlying document text content.
viewerControl.setRedactionViewMode(PCCViewer.RedactionViewMode.Draft);

Sets the scale factor of the viewer.

Note: The viewer has minimum and maximum scale limits. The limits depend on the size of the pages. check PCCViewer.ViewerControl#getMinScaleFactor and PCCViewer.ViewerControl#getMaxScaleFactor to determine the minimum and maximum scale.

Example

viewerControl.setScaleFactor(.5); // Zoom the document to 50% of its actual size.

Sets the selected conversation.

Example

// get the first selected Mark object
var theFirstMark = viewerControl.getSelectedMarks()[0];

// select the conversation of the Mark
viewerControl.setSelectedConversation(theFirstMark.getConversation());

Selects the specified search result and optionally navigates to the page of the search result.

If a value of null is passed in for the searchResult parameter, then any currently selected result will be cleared/deselected.

Example

var searchRequest = viewerControl.search('Accusoft');

// add events to the search request
searchRequest.on("SearchCompleted", function(){
    // get the search results
    results = searchRequest.getResults();

    // set the result to the first
    viewerControl.setSelectedSearchResult(results[0], true);
});

Sets the sharpening factor for the document. Note: This setting only affects viewing and is not persisted when printing or burning.

Example

viewerControl.setSharpening(60);

Numeric value which all SVG line width values should be multipled by. Must be greater than 0 and must not be greater than 100. To make lines twice as thick as they originally were, use a value of 2. To make lines half as thick as they originally were, use a value of 0.5, etc. To reset lines to their original thickness, use a value of 1. Note: This setting only affects viewing and is not persisted when printing or burning.

Example

viewerControl.setSvgLineWidthMultiplier(50);

Sets the view mode.

When set to "Document" or "EqualFitPages", this property only has an effect on documents with different sized pages. Setting the view mode to "Document" maintains the relative size of each page when displaying a document. For example, if page 2 is smaller than page 1, it will appear smaller. Setting the view mode to "EqualFitPages" scales each page so that their width is the same. For example, if page 2 is smaller than page 1, it will be scaled larger so that its width is equal to the width of page 1.

Setting the view mode to "SinglePage" structures the viewer so that only a single page is shown at a time. Each page is scaled to fit within a view box, which is the initial size of the viewer and increases in size when zooming in (and decreases in size when zooming out). After the viewer initializes, the view mode may not be changed to or from SinglePage view mode (or an exception will occur).

Example

viewerControl.setViewMode(PCCViewer.ViewMode.EqualFitPages);   // Scale each page so that their width is the same.

Shows the specified marks.

Example

// shows all selected marks
viewerControl.showMarks(viewer.getSelectedMarks());

Determines whether the range string is a valid page range to be used in PCCViewer.ViewerControl#print.

Example

viewerControl.validatePrintRange("1, 3-5"); // Returns true if there are at least 5 pages in the document.

Validates each of the search terms in the searchQuery object. The validation process checks for valid custom regular expressions. This method is used by the default UI to filter out 'bad' pre-defined search terms.

Example

var searchQuery = {
    searchTerms: [
        {
            searchTerm: '(?<=(category=))[a-z-]+', // invalid regex
            contextPadding: 25,
            highlightColor: '#B22222',
            matchingOptions: {
                beginsWith: false,
                endsWith: false,
                exactPhrase: false,
                matchCase: true,
                matchWholeWord: false,
                wildcard: false
            }
        }
    ]
}

viewerControl.validateSearch(searchQuery)

// returns
{
    errorsExist: true,
    searchTerms: [
        {
            isValid: false,
            message: "Search term must be a string containing either plain text or a valid regular expression."
        }
    ]
}

Zoom in on the document by the specified zoomFactor.

Note: The viewer has minimum and maximum scale limits. zoomIn will only change the viewer's scale up to, but not past, the maximum scale limit. zoomIn does not give an indication if the actual scale change was less than the requested zoom factor because the limit was reached. Instead, check PCCViewer.ViewerControl#atMaxScale to determine if the viewer is at max scale.

Example

viewerControl.zoomIn(1.5);   // Zoom in by 1.5x, or to the maximum scale.
viewerControl.zoomIn(5);     // Zoom in by 5x, or to the maximum scale.

viewerControl.zoomIn(100);   // Throws!
viewerControl.zoomIn(1);     // Throws!

Zoom out on the document by the specified zoomFactor.

Note: The viewer has minimum and maximum scale limits. zoomOut will only change the viewer's scale down to, but not past, the minimum scale limit. zoomOut does not give an indication if the actual scale change was less than the requested zoom factor because the limit was reached. Instead, check PCCViewer.ViewerControl#atMinScale to determine if the viewer is at minimum scale.

Example

viewerControl.zoomOut(1.5);   // Zoom out by 1.5x, or to the minimum scale.
viewerControl.zoomOut(5);     // Zoom out by 5x, or to the minimum scale.

viewerControl.zoomOut(100);   // Throws!
viewerControl.zoomOut(1);     // Throws!

This class will hold all the necessary details to perform a proximity search. It will be used in the PCCViewer.ViewerControl~SearchQuery object that is passed to the PCCViewer.ViewerControl#search method.

Example

 // An example proximity search term object. Notice how you can specify any number of search terms with their own individual options.
 var proximitySearchTerm = {
     type: "proximity",
     distance: 3,
     highlightColor: "#f73131",
     contextPadding: 30,
     terms: [{
         searchTerm: "influenza"
     },{
         searchTerm: "infection",
         matchingOptions: {
             matchWholeWord: true
         }
     },{
         searchTerm: "group",
         matchingOptions: {
             matchCase: false
         }
     }]
};
// The proximity search term is used in a search query object.
searchRequest.on('SearchCompleted', function(){
     console.log();
});
// The proximity search term is used in a search query object.
// There can be many search term objects and proximity search term objects in a search query object.
var searchQuery = {
     searchTerms: [proximitySearchTerm]
};
// Execute the search
var searchRequest = viewerControl.search(searchQuery);

The PCCViewer.saveMarkup API method takes a second optional parameter. This parameter is in the form of an object and provides options for saving marks to the server.

This object is used to specify search options. It will be used in a PCCViewer.ViewerControl~SearchTerm object.

Example

// A simple matching options object
var myMatchingOptions = {
    beginsWith: true,
};

// The matching options object is used in a search term object
var searchTerm = {
    searchTerm: "sub",
    contextPadding: 25,
    highlightColor: '#B22222',
    matchingOptions: myMatchingOptions
};

// The search term object is used in the search query object
var searchQuery = {
    searchTerms: [searchTerm]
};

This object is used to specify one or more search terms and options for the PCCViewer.ViewerControl#search method.

Example

// An example search query object with one search term
var searchQuery = {
    searchTerms: [{
        searchTerm: "sub",
        contextPadding: 25,
        highlightColor: '#B22222',
        matchingOptions: {
            beginsWith: true,
        }
    }]
};

This object is used to specify one search term and its options. It will be used in the PCCViewer.ViewerControl~SearchQuery object that is passed to the PCCViewer.ViewerControl#search method.

Example

// An example search term object
var searchTerm = {
    searchTerm: "sub",
    contextPadding: 25,
    highlightColor: '#B22222',
    matchingOptions: {
        beginsWith: true,
    }
};

// The search term is used in a search query object.
// There can be many search term objects in a search query object.
var searchQuery = {
    searchTerms: [searchTerm]
};

These options are available and processed directly by the ViewerControl. When using the jQuery Plugin, external:jQuery.fn#pccViewer, these options can be passed in along with external:jQuery.fn~Options, and they will be passed into ViewerControl.