Generic document field

Hierarchy

  • PartiallyConstructible
    • Field

Constructors

Properties

Constructors

  • Parameters

    • Optional source: {
          type?: {
              commonType?: null | CommonFieldType;
              fullName?: string;
              listIndex?: null | number;
              name?: string;
              normalizedName?: string;
          };
          validationStatus?: null | ValidationStatus;
          value?: null | {
              confidence?: number;
              text?: string;
          };
      }
      • Optional type?: {
            commonType?: null | CommonFieldType;
            fullName?: string;
            listIndex?: null | number;
            name?: string;
            normalizedName?: string;
        }

        The type of the field.

        • Optional commonType?: null | CommonFieldType

          Commonly occurring fields that have the same semantic meaning in different document types will often have a set common type.

        • Optional fullName?: string

          Unique global field type name prefixed with the document types of all containing documents

        • Optional listIndex?: null | number

          A document can contain multiple fields of the same name, the property serves for storing natural order of such fields, null if multiple entries aren't allowed for this field

        • Optional name?: string

          Local field type name scoped to the containing document type

        • Optional normalizedName?: string

          Normalized global field type name. Fields in document types derived from the same base document type in the schema will have the same normalized name.

      • Optional validationStatus?: null | ValidationStatus

        Field validation status. Applicable only to fields that support some kind of validation.

      • Optional value?: null | {
            confidence?: number;
            text?: string;
        }

        Value of the field. Applicable only to text fields.

    Returns Field

Properties

type: Field.Type

The type of the field.

validationStatus: null | ValidationStatus

Field validation status. Applicable only to fields that support some kind of validation.

value: null | OcrResult

Value of the field. Applicable only to text fields.