Class StringField

A field containing a text value.

Hierarchy

Constructors

constructor

Properties

boundingBox confidence pageId? polygon rawValue? reconstructed value?

Methods

compare toString arrayConfidence arraySum compareArrays

Constructors

constructor

Properties

boundingBox

boundingBox: BoundingBox

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

confidence

confidence: number

The confidence score of the prediction.

Optional pageId

pageId?: number

Page ID for multi-page document.

polygon

polygon: Polygon = []

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

Optional rawValue

rawValue?: string

Value as it appears on the document.

reconstructed

reconstructed: boolean

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

Optional value

value?: string

The value.

Methods

compare

toString

Static arrayConfidence

Static arraySum

Static compareArrays

  • Returns

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

    Parameters

    • array1: Field[]

      first Array of Fields

    • array2: Field[]

      second Array of Fields

    • attr: string = "value"

      Attribute to compare

    Returns boolean

Settings

Member Visibility

Theme

Generated using TypeDoc