Reference Guide
Reference Guides / JavaScript API / Annotations / AddRectangleHighlighterAnnotInteractive
In This Topic
    AddRectangleHighlighterAnnotInteractive
    In This Topic

    Here is a code example showing how the draw a green text annotation by showing the creation dialog with custom preloaded properties values.

    function addTimeStamp() {
        timeStampAppearance = {
            fill: false,
            stroke: false,
            fontStyle: 0,
            foreColor: "#1CA30D",
            opacity: 1,
            text: "Paid by cash",
            alignment: 0,
            lineAlignment: 0
        };
        DocuViewareAPI.AddTextAnnotInteractive("DocuVieware1", timeStampAppearance, true, ["fontName","fontStyle","foreColor","fontSize","text","opacity"]);
    }

    Each annotation having its own properties, please refer to the corresponding function documentation below to have a comprehensive list of it.

     AddRectangleHighlighterAnnotInteractive

    This function allows you to add a rectangle highlighter annotation (annotation type 2) onto a document into the DocuVieware™ viewer.

    AddRectangleHighlighterAnnotInteractive: function (docuViewareID[, annotationAppearance, showDialog, enabledProperties])

    Parameters

    docuViewareID
    The identifier for the DocuVieware™ instance you want to add the annotation on.
    annotationAppearance
    An optional JavaScript object that contains the appearance you want the annotation to have. Annotation properties are listed below.
    showDialog
    An optional boolean that let you decide if the annotation dialog should be shown or not (this requires the annotationAppearance to be sent).
    enabledProperties
    An optional string array that let you decide what properties are going to be shown in the annotation creation dialog.

    Return Value

    1 if error, 0 if success.

    Rectangle Highlighter Annotation Properties

    Name Type Default
    fillColor string "#FFFF00"
    rotation int 0
    squaredBox bool false