var viewerControl = new PCCViewer.ViewerControl(...);

// use PCCViewer.ViewerControl#addMark(pageNumber, markType) to create
// and add a mark instead of new Mark()
viewerControl.addMark(1, "LineAnnotation");

The PCCViewer.Mark.FontStyles enumeration defines Font Styles known to the ViewerControl.

Note: This enumeration is for convenience for API developers. Instead of using this enumeration, you may pass string values of the FontStyles (enumeration values).

Example

// use the enumeration to make text Bold
mark.setFontStyle([PCCViewer.Mark.FontStyles.Bold]);

// or just use the string value. Note: The parameter should be an array of styles required.
mark.setFontStyle(["Bold"]);

The PCCViewer.Mark.HorizontalAlignment enumeration defines horizontal alignment known to the ViewerControl.

Note: This enumeration is for convenience for API developers. Instead of using this enumeration, you may pass string values of the HorizontalAlignment (enumeration values).

Example

// use the enumeration to make text centered
mark.setHorizontalAlignment(PCCViewer.Mark.HorizontalAlignment.Center);

// or just use the string value
mark.setHorizontalAlignment("Center");

The PCCViewer.Mark.InteractionMode enumeration defines possible interaction modes for a Mark. The interaction mode affects the behavior of the mark when the user interacts with the mark through mouse, touch, or API.

Note: This enumeration is for convenience for API developers. Instead of using this enumeration, you may pass string values of the InteractionMode (enumeration values).

Example

// use the enumeration to make the mark non-selectable
mark.setInteractionMode(PCCViewer.Mark.InteractionMode.SelectionDisabled);

// or just use the string value of the enumeration
mark.setInteractionMode("SelectionDisabled");

The PCCViewer.Mark.LineHeadType enumeration defines Mark LineHeadTypes known to the ViewerControl.

Note: This enumeration is for convenience for API developers. Instead of using this enumeration, you may pass string values of the LineHeadType (enumeration values).

Example

// use the enumeration to make a line an arrow
myLineAnnotation.setEndHeadType(PCCViewer.Mark.LineHeadType.FilledTriangle);

// or just use the string value
myLineAnnotation.setEndHeadType("FilledTriangle");

The PCCViewer.Mark.Type enumeration defines Mark Types known to the ViewerControl.

Note: This enumeration is for convenience for API developers. Instead of using this enumeration, you may pass string values of the Type (enumeration values).

Example

// use the enumeration to make a line annotation
myViewerControl.addMark(1, PCCViewer.Mark.Type.LineAnnotation);

// or just use the string value
myViewerControl.addMark(1, "LineAnnotation");

Gets or sets the border color of the Mark.

This property is defined on marks of type: RectangleAnnotation, EllipseAnnotation, TextAnnotation and RectangleRedaction.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('borderColor' in mark) {
    var oldValue = mark.borderColor;
    mark.borderColor = "#FF0000"; // set border color to red
}

Gets or sets the border thickness of the Mark.

This property is defined on marks of type: RectangleAnnotation, EllipseAnnotation, TextAnnotation and RectangleRedaction.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('borderThickness' in mark) {
    var oldValue = mark.borderThickness;
    mark.borderThickness = 3; // set the border thickness of the mark
}

Gets the bounding rectangle of the Mark.

This property is defined on all Mark objects.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

var boundingRectangle = mark.boundingRectangle;

Gets or sets the color of the Mark.

This property is defined on marks of type: LineAnnotation, StampAnnotation, FreehandAnnotation, FreehandSignature, TextSignature, PolylineAnnotation and StrikethroughAnnotation.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('color' in mark) {
    var oldValue = mark.color;
    mark.color = "#FF0000"; // set color to red
}

Gets the conversation associated with the Mark.

This property is defined on all Mark objects.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

var conversation = mark.conversation;

Gets or sets the end head type of the Mark.

The value of end head type determines if the line looks like an arrow or a plain line.

This property is defined on marks of type: LineAnnotation.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('endHeadType' in mark) {
    var oldValue = mark.endHeadType;

    // set the head to be a filled triangle, so the line looks like an arrow
    mark.endHeadType = "FilledTriangle";
}

Gets or sets the end point coordinates of the line Mark.

This property is defined on marks of type: LineAnnotation.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('endPoint' in mark) {
    var oldValue = mark.endPoint;
    mark.endPoint = {x: 100, y: 100}; // set the end point to (100, 100)
}

Gets or sets the fill color of the Mark.

This property is defined on marks of type: RectangleAnnotation, EllipseAnnotation, TextAnnotation, HighlightAnnotation, TextHyperlinkAnnotation and RectangleRedaction.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('fillColor' in mark) {
    var oldValue = mark.fillColor;
    mark.fillColor = "#FF0000"; // set color to red
}

Gets or sets the font color of the text in the Mark.

This property is defined on marks of type: TextAnnotation, TextRedaction, TextInputSignature, RectangleRedaction and TextAreaSignature.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('fontColor' in mark) {
    var oldValue = mark.fontColor;
    mark.fontColor = "#ffccbb";
}

Gets or sets the font name of the text in the Text Mark.

This property is defined on marks of type: TextAnnotation, TextRedaction, TextSignature, TextAreaSignature.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('fontName' in mark) {
    var oldValue = mark.fontName;
    mark.fontName = "Aerial";
}

Gets or sets the font size (in points) for the text in the Text Mark.

This property is defined on marks of type: TextAnnotation, TextRedaction.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('fontSize' in mark) {
    var oldValue = mark.fontSize;
    mark.fontSize = 12;
}

Gets or sets the font Style of the text in the mark.

This property is defined on marks of type: TextRedaction, TextAreaSignature, TextAnnotation.

This is an ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in older browsers like IE8. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('fontStyle' in mark) {
    var oldValue = mark.fontStyle;
    mark.fontStyle = ["Bold",Underline,Italic];
}

Gets or sets the text horizontal alignment of the text in the Text Mark.

This property is defined on marks of type: TextAnnotation, TextRedaction, FreehandSignature, TextSignature, TextInputSignature and TextAreaSignature.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('horizontalAlignment' in mark) {
    var oldValue = mark.horizontalAlignment;
    mark.horizontalAlignment = "left";
}

Gets or sets the link target for hyperlink annotations.

All strings and numbers are valid values. It is the responsibility of the API consumer to handle clicks of hyperlink annotations. When handling the click, the API consumer should interpret the href value and take the appropriate navigation action.

This property is defined on marks of type: TextHyperlinkAnnotation.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('href' in mark) {
    var oldValue = mark.href;
    mark.href = "http://www.accusoft.com/";
}

Gets the ID of the Mark.

This property is defined on all Mark objects.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

var id = mark.id;

Gets the image that is displayed for the Mark.

This property is defined on marks of type: ImageStampAnnotation and ImageStampRedaction

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('image' in mark) {
    // get old image data
    var oldImageData = mark.image;

    // set new image
    mark.image = {
        dataUrl: "data:image/png;base64,base64 string",
        id: "myUniqueImageIDABC123"
    };
}

Gets or sets a value that indicates the allowed interactions with the mark. Possible values are defined in the enumeration PCCViewer.Mark.InteractionMode.

This property is defined on all Mark objects.

This is an ECMA 5 property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

// get
var interactionMode = mark.interactionMode;

// set
mark.interactionMode = PCCViewer.Mark.InteractionMode.SelectionDisabled;

Gets or sets the text in the Stamp Mark.

This property is defined on marks of type: StampAnnotation, StampRedaction.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('label' in mark) {
    var oldValue = mark.label;
    mark.label = "Approved";
}

Gets or sets the mask for text input signatures.

This property is defined on marks of type: TextInputSignature.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('mask' in mark) {
    var oldValue = mark.mask;

    mark.mask = {
        value: '(###) ###-####',
        translations: {
            '#': /\d/
        }
    };
}

Gets or sets a value that determines the maximum font size for a mark.

This method is defined on marks of type: TextAreaSignature and TextInputSignature.

This is an ECMA 5 property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

// get
var maxFontSize = mark.maxFontSize;

// set
mark.maxFontSize = 13;

Gets or sets a value that determines the max length of text for a mark

This method is defined on marks of type: TextAnnotation, TextRedaction, TextAreaSignature and TextInputSignature.

This is an ECMA 5 property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

// get
var maxLength = mark.maxLength;

// set
mark.maxLength = 13;

Gets or sets the opacity of the Mark. This value is a number between 0 and 255.

This property is defined on marks of type: LineAnnotation, RectangleAnnotation, EllipseAnnotation, TextAnnotation,PolylineAnnotation.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('opacity' in mark) {
    var oldValue = mark.opacity;
    mark.opacity = 127; // set the opacity so that the mark is transparent
}

Gets the page number of the page that the Mark is on.

This property is defined on all Mark objects.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

var pageNumber = mark.pageNumber;

Gets or sets the path data of FreehandSignature and FreehandAnnotation.

This property is defined on marks of type: FreehandSignature, FreehandAnnotation.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('path' in mark) {
    var oldValue = mark.path;
    mark.path = "M0,0L1,1L1,0";
}

Gets or sets the array of points that make up coordinates of the vertices of the PolylineAnnotation Mark.

This property is defined on marks of type: PolylineAnnotation.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('points' in mark) {
    var points = mark.points;
}

Gets or sets the position of the Mark.

Important - The setter only works if the ViewerControl instance has page text for all pages that the text-based mark will span. See PCCViewer.Mark#setPosition for complete information on safely setting the mark's position.

This property is defined on marks of type: HighlightAnnotation, TextSelectionRedaction, TextHyperlinkAnnotation, and StrikethroughAnnotation

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

// Basic usage.
if ('position' in mark) {
    var oldValue = mark.position;

    // Requesting page text ensures that the ViewerControl has page text for the page (which
    // is a pre-requisite) and it also gives us the page text so that we have context when
    // setting the position.
    viewerControl.requestPageText(1).then(function(pageText) {
        // It is unsafe to set the mark position without first
        mark.position = {startIndex: 0, length: pageText.length};
    });
}

Gets or sets the reason in the Mark.

This property is defined on marks of type: RectangleRedaction, TextSelectionRedaction.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Note: Throws an error if the ViewerControlOptions.enableMultipleRedactionReasons property was set to true when initializing ViewerControl. In such case you should use the PCCViewer.Mark#reasons instead.

Example

if ('reason' in mark) {
    var oldValue = mark.reason;
    mark.reason = "Information for top security clearance only.";
}

Gets or sets the reasons in the Mark.

This property is defined on marks of type: RectangleRedaction, TextSelectionRedaction.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Note: Throws an error if the ViewerControlOptions.enableMultipleRedactionReasons property was set to false when initializing ViewerControl. In such case you should use the PCCViewer.Mark#reason instead.

Example

if ('reasons' in mark) {
    var oldValue = mark.reasons;
    mark.reasons = ["1.a", "2.b", "Private Information"];
}

Gets or sets the bounding rectangle of the Mark.

This property is defined on marks of type: RectangleAnnotation, EllipseAnnotation, TextAnnotation, StampAnnotation, RectangleRedaction, TransparentRectangleRedaction, TextRedaction, StampRedaction, FreehandAnnotation, FreehandSignature, TextSignature, ImageStampAnnotation, ImageStampRedaction, TextInputSignature and TextAreaSignature.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('rectangle' in mark) {
    var oldValue = mark.rectangle;
    mark.rectangle = {x: 0, y: 0, width: 100, height: 100};
}

Note: This property is defined on the template mark of the PlaceSignature mouse tool, and is not available on any mark.

Gets or sets the template signature.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Gets or sets the start point coordinates of the line Mark.

This property is defined on marks of type: LineAnnotation.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('startPoint' in mark) {
    var oldValue = mark.startPoint;
    mark.startPoint = {x: 1, y: 1}; // set the start point to (1, 1)
}

Gets or sets the text in the Mark.

This property is defined on marks of type: TextAnnotation, TextRedaction, TextSignature, TextAreaSignature HighlightAnnotation, TextSelectionRedaction, TextHyperlinkAnnotation and StrikethroughAnnotation.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('text' in mark) {
    var oldValue = mark.text;
    mark.text = "This is a Test";
}

Gets or sets the thickness of the Mark.

This property is defined on marks of type: LineAnnotation, FreehandAnnotation, FreehandSignature, PolylineAnnotation.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('thickness' in mark) {
    var oldValue = mark.thickness;
    mark.thickness = 3; // set the thickness of the mark
}

Gets the type of the Mark.

This property is defined on all Mark objects.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

switch (mark.type) {
    case Mark.Type.LineAnnotation:
        ...
        break;
    default:
        ...
}

Gets or sets the Mark visible.

This property is defined on all mark types.

This is 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. For the greatest browser compatibility, use the corresponding getter and setter methods.

Example

if ('visible' in mark) {
    var oldValue = mark.visible;
    mark.visible = true; // set mark to visible
}

Clears any text highlights within the mark object. The text highlights would have been created with PCCViewer.Mark#highlightText.

It is invalid to call this method on the template mark of a PCCViewer.MouseTool object.

This method is defined on marks of type: TextAnnotation, TextRedaction, HighlightAnnotation, TextSelectionRedaction, TextHyperlinkAnnotation, and StrikethroughAnnotation.

Example

if (mark.clearHighlights) {
    mark.clearHighlights();
}

Gets the border color of the Mark.

This method is defined on marks of type: RectangleAnnotation, EllipseAnnotation, TextAnnotation and RectangleRedaction.

Example

if (mark.getBorderColor) {
    var borderColor = mark.getBorderColor();
}

Gets the border thickness of the mark.

This method is defined on marks of type: RectangleAnnotation, EllipseAnnotation, TextAnnotation and RectangleRedaction.

Example

if (mark.getBorderThickness) {
    var borderThickness = mark.getBorderThickness();
}

Gets the bounding rectangle for the Mark.

This method is defined on all Mark objects.

Example

var boundingRectangle = mark.getBoundingRectangle();

Gets the color of the Mark.

This method is defined on marks of type: LineAnnotation, StampAnnotation, FreehandAnnotation, FreehandSignature, TextSignature, PolylineAnnotation and StrikethroughAnnotation.

Example

if (mark.getColor) {
    var color = mark.getColor();
}

Gets the conversation associated with the Mark.

This method is defined on all Mark objects.

Gets the data value for the given key, or gets a hash containing all key values, if a key was not provided.

This method is defined on all Mark objects.

Example

var mark = viewerControl.addMark(1, "RectangleRedaction");

// The key "Author" is set the value "Mark".
mark.setData("Author", "Mark");

// The key "Note" is set the value "This is really important!".
mark.setData("Note", "This is really important!");

mark.getData("Author"); // returns "Mark"
mark.getData();         // returns {"Author":"Mark", "Note":"This is really important!"}
mark.getData("FooBar"); // returns undefined

Gets an array of data keys known to this Mark.

This method is defined on all Mark objects.

Example

var mark = viewerControl.addMark(1, "RectangleRedaction");

// Returns an empty array before key-value pairs are stored.
mark.getDataKeys(); // returns []

// Returns a list of all keys.
mark.setData("Author", "Mark");
mark.setData("Note", "This is really important!");
mark.getDataKeys(); // returns ["Author", "Note"]

Gets the line Mark end head type.

This method is defined on marks of type: LineAnnotation.

Example

if (mark.getEndHeadType) {
    var endHeadType = mark.getEndHeadType();
}

Gets the end point coordinates of the line Mark.

This method is defined on marks of type: LineAnnotation.

Example

if (mark.getEndPoint) {
    var endPoint = mark.getEndPoint();
}

Gets the fill color of the Mark.

This method is defined on marks of type: RectangleAnnotation, EllipseAnnotation, TextAnnotation, HighlightAnnotation, TextHyperlinkAnnotation and RectangleRedaction.

Example

if (mark.getFillColor) {
    var fillColor = mark.getFillColor();
}

Gets the font color of the text contained in the Text Mark.

This method is defined on marks of type: TextAnnotation, TextRedaction, TextInputSignature, RectangleRedaction and TextAreaSignature.

Example

if (mark.getFontColor) {
    var text = mark.getFontColor();
}

Gets the font color of the text contained in the Mark.

This method is defined on marks of type: TextAnnotation, TextRedaction, TextSignature, TextInputSignature and TextAreaSignature.

Example

if (mark.getFontName) {
    var text = mark.getFontName();
}

Gets the font size (in points) of the text in the Mark.

This method is defined on marks of type: TextAnnotation, TextRedaction.

Example

if (mark.getFontSize) {
    var fontSize = mark.getFontSize();
}

Gets an array of font styles of the text contained in the mark.

This method is defined on marks of type: TextAnnotation, TextAreaSignature, TextRedaction.

Example

if (mark.getFontStyle) {
    var fontStyleArray = mark.getFontStyle();
}

Gets the horizontalAlignment of the text contained in the Text Mark.

This method is defined on marks of type: TextAnnotation, TextRedaction, FreehandSignature, TextSignature, TextInputSignature and TextAreaSignature.

Example

if (mark.getHorizontalAlignment) {
    var horizontalAlignment = mark.getHorizontalAlignment();
}

Gets the link target for hyperlink annotations.

This method is defined on marks of type: TextHyperlinkAnnotation.

Example

if (mark.getHref) {
    var href = mark.getHref();

     switch (typeof href) {
         case "number":
             // navigate to the page
             viewerControl.setPageNumber(href);
             break;
         case "string":
             // Interpret the URL and execute the navigation.
             window.location.href = href;
             break;
         case "undefined":
         case "object":
         default:
             // do nothing, or define some special rules
             break;
     }
}

Gets the ID of the Mark.

This method is defined on all Mark objects.

Example

var markId = mark.getId();

Gets the image that is displayed for the Mark.

This method is defined on marks of type: ImageStampAnnotation and ImageStampRedaction.

Example

if (mark.getImage) {
    var imageData = mark.getImage();
}

Gets a value that indicates the allowed interactions with this mark.

This method is defined on all Mark objects.

Example

var interactionMode = mark.getInteractionMode();

Gets the text string contained in the Stamp Mark.

This method is defined on marks of type: StampAnnotation, StampRedaction.

Example

if (mark.getLabel) {
    var label = mark.getLabel();
}

Gets the applied mask for the text input signature mark.

This method is defined on marks of type: TextInputSignature.

Example

if (mark.getMask) {
    var mask = mark.getMask();
}

Gets the maximum font size (in points) for text in the mark.

This method is defined on marks of type: TextAreaSignature and TextInputSignature.

Example

if (mark.getMaxFontSize) {
    var mask = mark.getMaxFontSize();
}

Gets the applied max length for the mark.

This method is defined on marks of type: TextAnnotation, TextRedaction, TextAreaSignature and TextInputSignature.

Example

if (mark.getMaxLength) {
    var mask = mark.getMaxLength();
}

Gets the opacity of the Mark. This value is a number between 0 and 255.

This method is defined on marks of type: LineAnnotation, RectangleAnnotation, EllipseAnnotation, TextAnnotation.

Example

if (mark.getOpacity) {
    var opacity = mark.getOpacity();
}

Gets the page number where the Mark object is located.

This method is defined on all Mark objects.

Example

var pageNumber = mark.getPageNumber();

Gets the path data for FreehandSignature and FreehandAnnotation.

This method is defined on marks of type: FreehandSignature, FreehandAnnotation.

Example

if (mark.getPath) {
    var path = mark.getPath();
}

Gets the array of points that make up coordinates of the vertices of the PolylineAnnotation Mark.

This method is defined on marks of type: PolylineAnnotation.

Example

if (mark.getPoints) {
    var points = mark.getPoints();
}

Gets the position of the text-based Mark.

This method is defined on marks of type: HighlightAnnotation, TextSelectionRedaction, TextHyperlinkAnnotation, and StrikethroughAnnotation.

Example

if (mark.getPosition) {
    var position = mark.getPosition();
}

Gets the reason contained in the Redaction Mark.

This method is defined on marks of type: RectangleRedaction, TextSelectionRedaction.

Example

if (mark.getReason) {
    var reason = mark.getReason();
}

Gets the reasons contained in the Redaction Mark.

This method is defined on marks of type: RectangleRedaction, TextSelectionRedaction.

Example

if (mark.getReasons) {
    var reasons = mark.getReasons();
}

Gets the bounding rectangle for the Mark.

This method is defined on marks of type: RectangleAnnotation, EllipseAnnotation, TextAnnotation, StampAnnotation, RectangleRedaction, TransparentRectangleRedaction, TextRedaction, StampRedaction, FreehandAnnotation, FreehandSignature, TextSignature, ImageStampAnnotation, ImageStampRedaction, TextInputSignature and TextAreaSignature.

Example

if (mark.getRectangle) {
    var boundingRectangle = mark.getRectangle();
}

Gets the session data value for the given key, or gets a hash containing all key values, if a key was not provided. Unlike PCCViewer.Mark#getData, this data is not saved with the annotation, it only lasts for the session.

This method is defined on all Mark objects.

Example

var mark = viewerControl.addMark(1, "RectangleRedaction");

// The key "Visibility" is set the value "Shown".
mark.setSessionData("Visibility", "Shown");

// The key "Note" is set the value "This is not going to be saved!".
mark.setSessionData("Note", "This is not going to be saved!");

mark.getSessionData("Visibility"); // returns "Shown"
mark.getSessionData();             // returns {"Visibility":"Shown", "Note":"This is not going to be saved!"}
mark.getSessionData("FooBar");     // returns undefined

Gets an array of data keys known to this Mark. Unlike PCCViewer.Mark#getDataKeys, this data is not saved with the annotation, it only lasts for the session.

This method is defined on all Mark objects.

Example

var mark = viewerControl.addMark(1, "RectangleRedaction");

// Returns an empty array before key-value pairs are stored.
mark.getSessionDataKeys(); // returns []

// Returns a list of all keys.
mark.setSessionData("Visibility", "Shown");
mark.setSessionData("Note", "This is not going to be saved!");
mark.getSessionDataKeys(); // returns ["Visibility", "Note"]

Note: This property is defined on the template mark of the PlaceSignature mouse tool, and is not available on any mark.

Gets the last signature object that was associated with the particular template mark.

Example

// get the mouse tool
var accusoftPlaceSignature = PCCViewer.MouseTools.getMouseTool('AccusoftPlaceSignature');
// get the template mark
var signatureTemplateMark = accusoftPlaceSignature.getTemplateMark();
// get the signature associated with the template
var signature = signatureTemplateMark.getSignature();

Gets the start point coordinates of the line Mark.

This method is defined on marks of type: LineAnnotation.

Example

if (mark.getStartPoint) {
    var startPoint = mark.getStartPoint();
}

Gets the text contained in marks with text or text-selection based marks.

This method is defined on marks of type: TextAnnotation, TextRedaction, TextSignature, HighlightAnnotation, TextSelectionRedaction, TextHyperlinkAnnotation, TextInputSignature, StrikethroughAnnotation and TextAreaSignature.

Example

if (mark.getText) {
    var text = mark.getText();
}

Gets the thickness of the line.

This method is defined on marks of type: LineAnnotation, FreehandAnnotation, FreehandSignature,PolylineAnnotation, StrikethroughAnnotation.

Example

if (mark.getThickness) {
    var thickness = mark.getThickness();
}

Gets the type of the Mark type.

This method is defined on all Mark objects.

Example

switch (mark.getType()) {
    case Mark.Type.LineAnnotation:
        ...
        break;
    default:
        ...
}

Gets the visibility of the Mark.

This method is defined on all mark types.

Example

if (mark.getVisible) {
    var visible = mark.getVisible();
}

Highlights text within the mark. The highlights are not persisted when mark is saved using saveMarkup.

Existing highlights that were created with a previous call to this method, are cleared when this method is called.

It is invalid to call this method on the template mark of a PCCViewer.MouseTool object.

This method is defined on marks of type: TextAnnotation, TextRedaction, HighlightAnnotation, TextSelectionRedaction, TextHyperlinkAnnotation and StrikethroughAnnotation.

Example

if (mark.highlightText) {
    mark.highlightText([
        {startIndex: 0, length: 5, color: "#FF0000"},
        {startIndex: 10, length: 5, color: "#FF0000", opacity: 200}
    ]);
}

Sets the border color of the Mark.

This method is defined on marks of type: RectangleAnnotation, EllipseAnnotation, TextAnnotation and RectangleRedaction.

Example

if (mark.setBorderColor) {
    mark.setBorderColor("#FF0000"); // set the border color to red
}

Sets the border thickness of the mark.

This method is defined on marks of type: RectangleAnnotation, EllipseAnnotation, TextAnnotation and RectangleRedaction.

Example

if (mark.setBorderThickness) {
    mark.setBorderThickness(3);
}

Sets the color of the Mark.

This method is defined on marks of type: LineAnnotation, StampAnnotation, FreehandAnnotation, FreehandSignature, TextSignature,PolylineAnnotation and StrikethroughAnnotation.

Example

if (mark.setColor) {
    mark.setColor("#FF0000"); // set the mark's color to red
}

Sets the data value for the given key.

This method is defined on all Mark objects.

Notes:

• Overwrites any data value already associated with the given key.
• There is no artificial limit imposed on the number of key-value pairs that are stored.
• If limits on the number of key-value pairs are required, they should be enforced by calling code.
• Setting the value as undefined results in no information for the key being persisted to the server.
• The returned data is not mutated or sanitized, which could lead to a security vulnerability if not sanitized properly before use.

Example

var mark = viewerControl.addMark(1, "RectangleRedaction");

// Get data returns undefined before the key is set.
mark.getData("Author"); // returns undefined

// The key "Author" is set the value "Mark".
mark.setData("Author", "Mark");
mark.getData("Author"); // returns "Mark"

// The key "Author" is overwritten with the value "Clark".
mark.setData("Author", "Clark");
mark.getData("Author"); // returns "Clark"

// The key "Author" is unset, by setting the value to undefined.
mark.setData("Author", undefined);
mark.getData("Author"); // returns undefined

// The value can only be set to a string or undefined.
// All other data types throw.
mark.setData("FooBar", null); // throws
mark.setData("FooBar", 1);    // throws
mark.setData("FooBar", true); // throws
mark.setData("FooBar", {});   // throws
mark.setData("FooBar", []);   // throws

Sets the line head type.

This method is defined on marks of type: LineAnnotation.

Example

if (mark.setEndHeadType) {
    // Put a triangle head on the end of the line to make it an arrow
    mark.setEndHeadType("FilledTriangle");
    // or use the enumeration to accomplish the same thing
    mark.setEndHeadType(PCCViewer.Mark.LineHeadType.FilledTriangle);
}

Sets the end point coordinate of the line Mark.

This method is defined on marks of type: LineAnnotation.

Example

if (mark.setEndPoint) {
    mark.setEndPoint({x:100, y:100});
}

Sets the fill color of the Mark.

This method is defined on marks of type: RectangleAnnotation, EllipseAnnotation, TextAnnotation, HighlightAnnotation, TextHyperlinkAnnotation and RectangleRedaction.

Example

if (mark.setFillColor) {
    mark.setFillColor("#FF0000"); // set the fill color to red
}

Sets the font color of the text in the Text Mark.

This method is defined on marks of type: TextAnnotation, TextRedaction, TextInputSignature, RectangleRedaction and TextAreaSignature.

Example

if (mark.setFontColor) {
    mark.setFontColor("#000000");
}

Sets the font name of the text in the Text Mark.

This method is defined on marks of type: TextAnnotation, TextRedaction, TextSignature, TextInputSignature and TextAreaSignature.

Example

if (mark.setFontName) {
    mark.setFontName("Aerial");
}

Sets the font size (in points) for the text to use in the Mark.

Note: The API uses the resolution of the image to determine the size of a point so, for example, a line of 12 point text on a 300 DPI raster image will be 12 points / 72 point-per-inch * 300 pixels-per-inch = 50 pixels tall. The default value is 12 points.

This method is defined on marks of type: TextAnnotation, TextRedaction.

Example

if (mark.setFontSize) {
    mark.setFontSize(12);
}

Sets the font styles provided in the parameter array of the text in the mark.

This method is defined on marks of type: TextAnnotation, TextAreaSignature, TextRedaction.

Example

if (mark.setFontStyle) {
    var fontStylesArray = ["Bold","Italic","Underline"];
    mark.setFontStyle(fontStylesArray);
}

Sets the horizontal alignment of the text in the Text Mark.

This method is defined on marks of type: TextAnnotation, TextRedaction, FreehandSignature, TextSignature, TextInputSignature and TextAreaSignature.

Example

if (mark.setHorizontalAlignment) {
    mark.setHorizontalAlignment("center");
}

Sets the link target for hyperlink annotations.

All strings and numbers are valid values. It is the responsibility of the API consumer to handle clicks of hyperlink annotations. When handling the click, the API consumer should interpret the href value and take the appropriate navigation action.

This method is defined on marks of type: TextHyperlinkAnnotation.

Example

if (mark.setHref) {
    // set to fully qualified URL
    mark.setHref("http://www.accusoft.com/");

    // or a URL fragment
    mark.setHref("#named-annotation");

    // or a numeric value
    mark.setHref(4);
}

Sets the image that is displayed for the Mark.

This method is defined on marks of type: ImageStampAnnotation and ImageStampRedaction.

Example

var param = {
    dataUrl: "data:image/png;base64,base64 string",
    id: "imageId"
};
if (mark.setImage) {
    mark.setImage(param);
}

Sets a value that indicates the allowed interactions with this mark.

This method is defined on all Mark objects.

Example

mark.setInteractionMode(PCCViewer.Mark.InteractionMode.Full);

Sets the text string in the Stamp Mark.

This method is defined on marks of type: StampAnnotation, StampRedaction.

Example

if (mark.setLabel) {
    mark.setLabel("Approved");
}

Sets the mask for the text input signature mark. Once this mark enters edit mode, the user input will be masked according to the properties set using this method.

This method is defined on marks of type: TextInputSignature.

Example

if (mark.setMask) {
    // only allow a US phone number as input
    mark.setMask({
        value: '(###) ###-####'
        translations: {
            '#': /\d/
        }
    });

    // only allow an Arizona driver's license number
    mark.setMask({
        value: 'A######-AA#####-#########-A########',
        translations: {
            'A': /[a-zA-Z]/,
            '#': /\d/
        }
    });
}

Sets the maximum font size (in points) for text in the mark. Setting a value of 0 indicates no max font size (in this case, the text will enlarge to fit to the mark bounds no matter how large the mark is).

This method is defined on marks of type: TextAreaSignature and TextInputSignature.

Example

if (mark.setMaxFontSize) {
    // only allow the font to enlarge to 72px
    mark.setMaxFontSize(72);
}

Sets the maximum number of characters that may be entered into an input

This method is defined on marks of type: TextAnnotation, TextRedaction, TextAreaSignature, and TextInputSignature.

Example

if (mark.setMaxLength) {
    // only allow 5 characters to be entered
    mark.setMaxLength(5);
}

Sets the opacity of the Mark. This value is a number between 0 and 255.

This method is defined on marks of type: LineAnnotation, RectangleAnnotation, EllipseAnnotation, TextAnnotation, FreehandAnnotation, PolylineAnnotation.

Example

if (mark.setOpacity) {
    mark.setOpacity(255); // fully opaque
    mark.setOpacity(127); // semi-transparent
    mark.setOpacity(0);   // transparent
}

Sets the path data of FreehandSignature and FreehandAnnotation.

This method is defined on marks of type: FreehandSignature, FreehandAnnotation.

Example

if (mark.setPath) {
    mark.setPath("M0,0L1,1L1,0");
}

Sets the points vertices coordinate array of the PolylineAnnotation Mark.

This method is defined on marks of type: PolylineAnnotation.

Example

if (mark.setPoints) {
    mark.setPoints([{x:100, y:100}, {x:200, y: 250}..., {x:1000, y: 1000});
}

Sets the position of text-based Marks.

Important - This method only works if the ViewerControl instance has page text for all pages that the text-based mark will span. In common use cases the ViewerControl will have text for these pages, however the ViewerControl API provides methods to check if it has text for a page and also to force it to get text for a page.

There are certain methods that force the ViewerControl to get text for a page or all pages.

• Calling PCCViewer.ViewerControl#requestPageText will force the ViewerControl to get text for a specified page if it does not already have the text for the page. This method also has the benefit of providing you with the page text, so that you are not blindly setting the position of the mark on the page.
• Calling PCCViewer.ViewerControl#search will force the viewer to get text for all pages by the time the search completes.

There are means to determine if the ViewerControl has text for a page.

• Calling PCCViewer.ViewerControl#isPageTextReady will synchronously indicate if the viewer has text for a page.
• The ViewerControl will trigger the PCCViewer.EventType.PageTextReady event when it gets text for a page.

This method is defined on marks of type: HighlightAnnotation, TextSelectionRedaction, TextHyperlinkAnnotation, and StrikethroughAnnotation.

Example

// Example 1
// ------------------------
// Basic (unsafe) usage, call setPosition and pass in an object with a startIndex and length.
if (mark.setPosition) {
    mark.setPosition({startIndex:0, length:5});
}

// Example 2
// ------------------------
// Safe usage, request the page text and then highlight something within that page.
// This code highlights the half of the characters on the page.
viewerControl.requestPageText(1).then(
    function(pageText) {
        // Now that we have the page text for page 1,
        // Add a HighlightAnnotation to page 1 and set the position of the highlight.
        viewerControl.addMark(1, PCCViewer.Mark.Type.HighlightAnnotation)
            .setPosition({startIndex: pageText.length / 4, length: pageText.length / 2});
    });

// Example 3
// ------------------------
// Safe highlighting of arbitrary spans of text.
// We highlight 3000 characters starting at index 100 on page 2.
var markPage = 2,
    markPosition = {startIndex: 100, length: 3000};

// Since the highlight will be 3000 characters, it may span multiple pages.
// We use a helper method to ensure that the ViewerControl has text for all pages that it will span.
ensureViewerControlHasPageText(viewerControl, markPage, markPosition)
    .then(addHighlightAnnotation,
        function(error) {
            alert("Something went wrong when trying to get page text. " + (error.message ? error.message : error));
        });

// This function uses the ViewerControl API to add a HighlightAnnotation.
// It will be called when ensureViewerControlHasPageText completes.
function addHighlightAnnotation() {
    // Add the HighlightAnnotation using ViewerControl#addMark and then
    // set the position and color of the highlight.
    viewerControl.addMark(markPage, PCCViewer.Mark.Type.HighlightAnnotation)
        .setPosition(markPosition)
        .setFillColor("#FF0000");

    // Scroll to the page containing the mark.
    viewerControl.setPageNumber(markPage);
}

// A helper method to ensure that a ViewerControl instance has page text
// for all pages that a HighlightAnnotation or TextSelectionRedaction spans.
function ensureViewerControlHasPageText(viewerControl, markPageNumber, markPosition) {

    // Calling ViewerControl#requestPageText will cause the ViewerControl to get text
    // from the server if it does not already have it. This method also gives us the page
    // text so we can check if the mark will extend to the next page.
    return viewerControl.requestPageText(markPageNumber).then(

        // If requestPageText promise is fulfilled, we compare the markPosition to the
        // page text, and if necessary, recursively ensure text for the next page.
        function(pageText) {
            // Check for an invalid markPosition. The method setPosition will now allow the caller
            // to crate a mark that starts after the last character on the page.
            if (markPosition.startIndex >= pageText.length) {
                throw new Error("Mark cannot start after last character on the page.");
            }

            // Determine if the highlight extends into the next page.
            var remainingCharsOnPage = pageText.length - markPosition.startIndex;
            var remainingCharsInHighlight = markPosition.length - remainingCharsOnPage;
            var extendsToNextPage = remainingCharsInHighlight > 0;

            // If the highlight extends to the next page, and we are not on the last page,
            // then ensure the viewer has the text for the next page.
            if (extendsToNextPage) {
                if (markPageNumber < viewerControl.getPageCount()) {
                    return ensureViewerControlHasPageText(viewerControl, markPageNumber + 1,
                               {startIndex: 0, length: remainingCharsInHighlight});
                }
                // Mark#setPosition does not allow the mark to extend off of the document.
                else {
                    throw new Error("Mark cannot extend off the document.")
                }
            }
        }
    )
}

Sets the reason in the Redaction Mark.

This method is defined on marks of type: RectangleRedaction, TextSelectionRedaction.

Example

if (mark.setReason) {
    mark.setReason("Information for top security clearance only.");
}

Sets the reasons in the Redaction Mark.

This method is defined on marks of type: RectangleRedaction, TextSelectionRedaction.

Example

if (mark.setReasons) {
    mark.setReasons(["1.a", "2.b", "Private Information"]);
}

Sets the bounding rectangle of the Mark.

This method is defined on marks of type: RectangleAnnotation, EllipseAnnotation, TextAnnotation, StampAnnotation, RectangleRedaction, TransparentRectangleRedaction, TextRedaction, StampRedaction, FreehandAnnotation, FreehandSignature, TextSignature, ImageStampAnnotation, ImageStampRedaction, TextInputSignature and TextAreaSignature.

Example

if (mark.setRectangle) {
    mark.setRectangle({x:0, y:0, width:100, height:100});
}

Sets the session data value for the given key. Unlike PCCViewer.Mark#setData, this data is not saved with the annotation, it only lasts for the session.

This method is defined on all Mark objects.

Example

var mark = viewerControl.addMark(1, "RectangleRedaction");

// Get data returns undefined before the key is set.
mark.getSessionData("Visibility"); // returns undefined

// The key "Visibility" is set the value "Shown".
mark.setSessionData("Visibility", "Shown");
mark.getSessionData("Visibility"); // returns "Shown"

// The key "Visibility" is overwritten with the value "Hidden".
mark.setSessionData("Visibility", "Hidden");
mark.getSessionData("Visibility"); // returns "Hidden"

// The key "Visibility" is unset, by setting the value to undefined.
mark.setSessionData("Visibility", undefined);
mark.getSessionData("Visibility"); // returns undefined

// The value can only be set to a string or undefined.
// All other data types throw.
mark.setSessionData("FooBar", null); // throws
mark.setSessionData("FooBar", 1);    // throws
mark.setSessionData("FooBar", true); // throws
mark.setSessionData("FooBar", {});   // throws
mark.setSessionData("FooBar", []);   // throws

Note: This property is defined on the template mark of the PlaceSignature mouse tool, and is not available on any mark.

Sets the signature data to use by the PlaceSignature mouse tool.

Example

// get the mouse tool
var accusoftPlaceSignature = PCCViewer.MouseTools.getMouseTool('AccusoftPlaceSignature');

// get the template mark
var signatureTemplateMark = accusoftPlaceSignature.getTemplateMark();

// set signature path for freehand signature
signatureTemplateMark.setSignature({path: "M0,0L100,0L100,100L0,100L0,0"});

// the same template can be reused for text signature
signatureTemplateMark.setSignature({ text: "Joe Smith", fontName: "Arial" });

Sets the start point coordinate of the line Mark.

This method is defined on marks of type: LineAnnotation.

Example

if (mark.setStartPoint) {
    mark.setStartPoint({x:1, y:1});
}

Sets the text in the Text Mark.

This method is defined on marks of type: TextAnnotation, TextRedaction, TextSignature, TextInputSignature and TextAreaSignature.

Note: This method is NOT available for marks of type:HighlightAnnotation, TextSelectionRedaction, TextHyperlinkAnnotation and StrikethroughAnnotation

Example

if (mark.setText) {
    mark.setText("This is test Text");
}

Sets the thickness of line.

This method is defined on marks of type: LineAnnotation, FreehandAnnotation, FreehandSignature, PolylineAnnotation, StrikethroughAnnotation.

Example

if (mark.setThickness) {
    mark.setThickness(3);
}

Sets the Mark to either visible or invisible depending on the boolean parameter.

This method is defined on all mark types.

Example

if (mark.setVisible) {
    mark.setVisible(true); // sets the mark visible
}

This type is used to specify the image data and a unique identifier for the image data. Objects of this type are used by the PCCViewer.Mark#getImage, PCCViewer.Mark#setImage, and PCCViewer.Mark#image members.