A field containing a detailed address value broken down into components (street number, city, postal code, …) while still exposing the full address string through StringField.value.

Hierarchy (view full)

Constructors

Properties

addressComplement?: string

Additional address complement.

boundingBox: BoundingBox

Contains exactly 4 relative vertices coordinates (points) of a right rectangle containing the field in the document.

city?: string

City or locality.

confidence: number

The confidence score of the prediction.

country?: string

Country.

pageId?: number

Page ID for multi-page document.

poBox?: string

PO-box number.

polygon: Polygon = []

Contains the relative vertices coordinates (points) of a polygon containing the field in the document.

postalCode?: string

Postal / ZIP code.

rawValue?: string

Value as it appears on the document.

reconstructed: boolean

true when the field was reconstructed or computed using other fields.

state?: string

State, province or region.

streetName?: string

Street name.

streetNumber?: string

Street number.

value?: string

The value.

Methods

  • Parameters

    • array1: Field[]

      first Array of Fields

    • array2: Field[]

      second Array of Fields

    • attr: string = "value"

      Attribute to compare

    Returns boolean

    true if all elements in array1 exist in array2 and vice-versa, false otherwise