Flags

Syntax

interface Flags {
    print?: boolean;
    noMove?: boolean;
    noView?: boolean;
    noResize?: boolean;
    noRotate?: boolean;
    readOnly?: boolean;
}

Attributes

print

Indicates whether the annotation is printable. Default value: true. Only printable annotations will be included when the page is printed.

noMove

Prevents users from moving annotations.

Default value: false

Note:

For the following annotations, it is not effective and the default value is true.

• Highlight
• Strikeout
• Underline

noView

Not to display the annotation or allow a user to interact with the annotation.

Default value: false

noResize

Prevents users from resizing annotations.

Default value: false.

Note:

For TextTypeWriter, it is not effective and the default value is true.

noRotate

Prevents users from rotating annotations.

Default value: false

Note:

For the following annotations, it is not effective and the default value is true.

• TextTypeWriter
• Polyline
• Polygon
• Line
• Highlight
• Strikeout
• Underline

readOnly

Not to allow a user to interact with the annotation, default value: false.

Related

• RectAnnotationOptions
• EllipseAnnotationOptions
• PolygonAnnotationOptions
• PolylineAnnotationOptions
• LineAnnotationOptions
• InkAnnotationOptions
• TextBoxAnnotationOptions
• TextTypewriterAnnotationOptions
• StampAnnotationOptions
• HighlightAnnotationOptions
• UnderlineAnnotationOptions
• StrikeoutAnnotationOptions