Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FormObjectField

Package version

A form field with a key-value map (an "object") as a value.

Hierarchy

Index

Properties

Optional confidence

confidence: undefined | number

The sevice's confidence (expressed as a number between zero and one) in the correctness of the field value.

Optional labelData

labelData: FieldData

Contains the recognized field label's text, bounding box, and field elements.

Optional name

name: undefined | string

A user-defined label for the field.

Optional value

value: Record<string, FormField>

The recognized object structure of the field, represented as a JavaScript object with the nested fields' names as properties that store their values.

Optional valueData

valueData: FieldData

Contains the recognized field value's text, bounding box, and field elements.

valueType

valueType: "object"

The type of this field's value - "object"

Generated using TypeDoc