In This Topic
Reference Guides / JavaScript API / Annotations / SetAnnotPropertiesValues

SetAnnotPropertiesValues

In This Topic
 SetAnnotPropertiesValues

This function allows you to set the annotation properties to custom values for a given annotation type.

SetAnnotPropertiesValues: function (docuViewareID, annotType, annotAppearance)

Parameters

docuViewareID
The identifier for the DocuVieware™ instance you want to reset the annotation properties from.
annotType
An integer representing the annotation type you want to set the annotation properties for.
The value has to be a member of the GdPictureAnnotationType enumeration.
annotAppearance
A JavaScript object that contains the appearance you want the annotation properties to be set to.

Return Value

1 if error, 0 if success.

Example of usage

Here is how to call this method to define custom values for the sticky note annotation type:

var STICKY_NOTE_APPEARANCE = {
    alignment: 0,
    autoSize: false,
    borderWidth: 0.01,
    dashCap: 0,
    dashStyle: 0,
    fill: true,
    fillColor: "#6DE8AF",
    fontName: "Arial",
    fontSize: 28,
    fontStyle: 1,
    foreColor: "#0022FF",
    lineAlignment: 0,
    opacity: 1,
    radiusFactor: 0,
    rotation: 350,
    stroke: true,
    strokeColor: "#000000",
    text: "My own text"
};
DocuViewareAPI.SetAnnotPropertiesValues("DocuVieware1", 9, STICKY_NOTE_APPEARANCE);