DsPdfJS API - v9.1.0
    Preparing search index...

    Type Alias StampAnnotationProperties

    StampAnnotationProperties: MarkupAnnotationProperties & {
        borderWidth?: number;
        font?: Font;
        icon?: string;
        showCreationDate?: boolean;
        showUserName?: boolean;
        type: "stamp";
    }

    Defines properties of a StampAnnotation.

    Type Declaration

    • OptionalborderWidth?: number

      The border width.

    • Optionalfont?: Font

      A font to draw the stamp. Note: This property is not persisted in the document and is used when the annotation's appearance is generated.

    • Optionalicon?: string

      A string specifying the name of an icon used to display the annotation. The PDF specification provides a predefined set of icons: "Approved", "AsIs", "Confidential", "Departmental", "Draft", "Experimental", "Expired", "Final", "ForComment", "ForPublicRelease", "NotApproved", "NotForPublicRelease", "Sold", "TopSecret".

      In practice though this entry often contains names of custom icons specific to the application that created the document.

    • OptionalshowCreationDate?: boolean

      A value indicating whether to show MarkupAnnotation#creationDate on the stamp. Note: This property is not persisted in the document and is used when the annotation's appearance is generated.

    • OptionalshowUserName?: boolean

      A value indicating whether to show MarkupAnnotation#userName on the stamp. Note: This property is not persisted in the document and is used when the annotation's appearance is generated.

    • type: "stamp"