@qrcommunication/gigapdf-lib — SDK API reference - v0.110.3
    Preparing search index...

    Interface FieldInfo

    interface FieldInfo {
        name: string;
        type: string;
        kind: FieldKind;
        flags: number;
        readOnly: boolean;
        required: boolean;
        multiline: boolean;
        fillable: boolean;
        comb: boolean;
        quadding: number;
        daFont?: string;
        daSize: number;
        maxLen?: number;
        page?: number;
        bounds?: [number, number, number, number];
        value: string;
        options: string[];
    }
    Index

    Properties

    name: string
    type: string
    kind: FieldKind
    flags: number
    readOnly: boolean
    required: boolean
    multiline: boolean
    fillable: boolean
    comb: boolean

    Whether this is a comb text field (/Ff bit 25): the value is laid out one character per equally-spaced cell across maxLen cells (SSN, dates and reference numbers on official forms). A host reproducing the field's original spacing must honour this — the cells can't be inferred from the value alone.

    quadding: number

    Text alignment from /Q (AcroForm default applied): 0 = left, 1 = centre, 2 = right.

    daFont?: string

    Font resource name from the field's /DA default appearance (e.g. "Helv", "ZaDb"), resolved against the AcroForm; absent when no Tf is present.

    daSize: number

    Font size in points from the /DA (0 = auto-size), AcroForm default applied.

    maxLen?: number

    /MaxLen for text fields; for a comb field this is the number of equally-spaced cells the value is drawn into.

    page?: number

    1-based page the widget sits on (from its /P); absent if it has no widget.

    bounds?: [number, number, number, number]

    Widget rectangle [x, y, width, height] in points, top-left origin (already Y-flipped from the PDF's bottom-left /Rect for direct host use). Absent when the field carries no /Rect.

    value: string
    options: string[]