Method removeField

src/api/pdf-form.ts:1010–1038

* Remove a form field from the document. * * This removes the field from the AcroForm and all its widget annotations * from their respective pages. * * @param fieldOrName - The field instance or field name to remove * @returns true if the field was found and removed, false otherwis

(fieldOrName: FormField | string)

   * ```
   */
  removeField(fieldOrName: FormField | string): boolean {
    // Resolve field from name if needed
    const field =
      typeof fieldOrName === "string" ? this.fieldsByName.get(fieldOrName) : fieldOrName;

    if (!field) {
      return false;
    }

    const fieldRef = field.getRef();

    if (!fieldRef) {
      return false;
    }

    // Remove widgets from their pages
    this.removeWidgetsFromPages(field);

    // Remove field from AcroForm's /Fields array
    const removed = this._acroForm.removeField(fieldRef);

    if (removed) {
      // Update internal caches
      this.allFields = this.allFields.filter(f => f !== field);
      this.fieldsByName.delete(field.name);
    }

    return removed;
  }

  /**
   * Remove all widgets of a field from their respective pages.