Method createSignatureField

src/api/pdf-form.ts:472–505

* Create a new signature field. * * Creates an empty (unsigned) signature field that can later be signed. * The field is created with an empty /Kids array. Widget properties * (page, rect, etc.) are set by PDFSignature during signing. * * @param name - Field name (must be unique)

(name: string, options: SignatureFieldOptions = {})

   * ```
   */
  createSignatureField(name: string, options: SignatureFieldOptions = {}): SignatureField {
    this.validateUniqueName(name);

    // Create field dictionary with /Kids array (like other field types)
    // Widget properties are added by PDFSignature during signing
    const fieldDict = PdfDict.of({
      FT: PdfName.of("Sig"),
      T: PdfString.fromString(name),
      Kids: new PdfArray([]),
    });

    // Store styling metadata (even though sig fields are usually invisible)
    this.storeFieldStyling(fieldDict, options);

    // Register the field and add to AcroForm
    const fieldRef = this._ctx.registry.register(fieldDict);
    this._acroForm.addField(fieldRef);

    // Create the SignatureField instance
    // oxlint-disable-next-line typescript/no-unsafe-type-assertion
    const field = createFormField(
      fieldDict,
      fieldRef,
      this._ctx.registry,
      this._acroForm,
      name,
    ) as SignatureField;

    // Add to cache
    this.allFields.push(field);
    this.fieldsByName.set(name, field);

    return field;
  }

  /**
   * Create a new text field.