Nutrient Web SDK
    Preparing search index...

    Interface SignatureCreationData

    Contains information to be used for preparing a document to be signed digitally.

    This object can be passed optionally to instance.signDocument() with specific parameters for the preparation of the digital signature.

    formFieldName and position cannot be set at the same time, or an error will be thrown.

    This is the property that can be included in the object:

    Setting the digital signature container reserved size when signing (Server)

    instance.signDocument({
      placeholderSize: 65536 // Specify a container with a 64 KB size
    })
      .then(function () {
        console.log("The document has been signed!");
      });
    interface SignatureCreationData {
        appearance?: SignatureAppearance;
        flatten?: boolean;
        formFieldName?: string;
        placeholderSize?: number;
        position?: { boundingBox: NutrientViewer.Geometry.Rect; pageIndex: number };
        signatureMetadata?: SignatureMetadata;
        signingData?: SigningData;
    }

    Hierarchy

    Index

    Properties

    appearance? flatten? formFieldName? placeholderSize? position? signatureMetadata? signingData?

    Properties

    appearance?: SignatureAppearance

    Appearance options for the digital signature.

    flatten?: boolean

    Whether the document should be flatten before digitally signing it. The default is false. Note that flattening a document may remove previous digital signatures.

    formFieldName?: string

    Name of the existing signature form field to apply the signature to.

    placeholderSize?: number

    Size (bytes) to be reserved for the digital signature container. The default is 32 KB (32768 bytes).

    position?: { boundingBox: NutrientViewer.Geometry.Rect; pageIndex: number }

    Page index and bounding box of the signature.

    Type Declaration

    • boundingBox: NutrientViewer.Geometry.Rect

      Coordinates and dimensions of the digital signature.

    • pageIndex: number

      Index of the page for the digital signature.

    signatureMetadata?: SignatureMetadata
    signingData?: SigningData

    Settings

    Member Visibility

    On This Page

    Properties