Reference DigitalSignaturesSignaturePreparationData

Interface SignaturePreparationData

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:

Interface

Example

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!");
  });

Hierarchy

SignaturePreparationData

Subinterfaces

SignatureCreationData

Properties

appearance

Optional

SignatureAppearance

Appearance options for the digital signature.

Whether the document should be flattened before digitally signing it. The default is false. Flattening is applied before the signature hash is generated and may remove annotations, signature form fields, and previous digital signatures.

formFieldName

Optional

string

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

placeholderSize

Optional

number

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

position

Optional

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

Page index and bounding box of the signature.

Property	Description
boundingBox	Coordinates and dimensions of the digital signature.
pageIndex	Index of the page for the digital signature.