Type Alias ExtractedField

type ExtractedField = {
    box: FormFieldBox;
    isReadOnly?: boolean;
    isRequired?: boolean;
    label: string;
    labelConfidence: number;
    labelSource: LabelSource;
    maxLength?: number;
    name: string;
    options?: string[];
    type: AcroFormFieldType;
}

Index

Properties

box isReadOnly? isRequired? label labelConfidence labelSource maxLength? name options? type

Properties

box

box: FormFieldBox

Stored v2 contract: PDF points, top-left origin, 1-based page.

`Optional`isReadOnly

isReadOnly?: boolean

`Optional`isRequired

isRequired?: boolean

label

label: string

labelConfidence

labelConfidence: number

labelSource

labelSource: LabelSource

`Optional`maxLength

maxLength?: number

name

name: string

Fully-qualified AcroForm field name — unique within the document.

`Optional`options

options?: string[]

Choice values for radio/dropdown/optionList fields; absent otherwise.

type

type: AcroFormFieldType