SignatureSettings Class

Description

Configures the signature workflow of a loaded document.

Syntax

SignatureSettings

Examples

The following example demonstrates SignatureSettings in a practical Document Viewer workflow. This object encapsulates settings for the signatures.

const signatureSettings = {
    showSignatureBar: true,
    ownerName: "Contoso Legal",
    signerName: "Alex Reviewer",
    signerInitials: "AR",
    uniqueId: "contract-2026-0042",
    defaultSignatureFont: { family: "Pacifico" },
    signatureBoxes: [
        { name: "CustomerSignature", signingRequired: true, style: 0 }
    ]
};
console.log("Signature settings:", signatureSettings);

Members

Properties

Property	Description
customSignatureData	Optional. Application-defined data passed to the signing workflow.
customSigning	Optional. Whether the application's custom signing workflow is active.
defaultSignatureFont	Optional. Default font for text-based signatures.
ownerName	Optional. Document owner name used by the signing workflow.
redirectUrlAfterSignature	Optional. URL to open after a server-side signing operation completes.
showSignatureBar	Optional. Whether the signature bar is visible.
signatureBoxes	Optional. Signature-box names or specifications used to identify and configure signature boxes.
signatureBoxName	Optional. Name of the signature box to process when more than one is available.
signDateFormat	Optional. Format used for signature dates sent to the signing workflow.
signerInitials	Optional. Initial signer initials shown in the signing dialog.
signerName	Optional. Initial signer name shown in the signing dialog.
uniqueId	Optional. Application-defined identifier sent with the signing request.