ComPDFKit Web SDK
    Preparing search index...

    Interface AnnotationWriteOptions

    Options of annotation writes (add, update, delete).

    interface AnnotationWriteOptions {
        allowReadOnlyAdmin?: boolean;
        creation?: AnnotationCreation;
        force?: boolean;
        imported?: boolean;
        isUndoRedo?: boolean;
        transient?: boolean;
    }
    Index
    allowReadOnlyAdmin?: boolean

    Lets an admin user write as usual in read-only mode (not allowed by default, keeping read-only semantics).

    Tool completion supplies its selection default; omission is a programmatic write.

    force?: boolean

    Accepted for compatibility; currently has no effect.

    imported?: boolean

    The change comes from an import: it is allowed in read-only mode, is not recorded as a user change, and annotationChanged reports imported true.

    isUndoRedo?: boolean

    The change comes from undo / redo; reported as isUndoRedo in annotationChanged.

    transient?: boolean

    Shown and interactive only in the current viewer, never written to PDF / XFDF. false turns an object re-added after deletion into a persistent annotation.