Class TaxField

Represent a single tax line.

Hierarchy (view full)

Constructors

constructor

Properties

base? boundingBox code? confidence pageId polygon rate? reconstructed value?

Methods

compare toString toTableLine arrayConfidence arraySum compareArrays

Constructors

constructor

Properties

Optionalbase

base?: number = undefined

The tax base

boundingBox

boundingBox: BoundingBox

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

Optionalcode

code?: string = undefined

The tax code (HST, GST... for Canadian; City Tax, State tax for US, etc..).

confidence

confidence: number

The confidence score of the prediction.

pageId

pageId: number

The document page on which the information was found.

polygon

polygon: Polygon = []

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

Optionalrate

rate?: number = undefined

The tax rate.

reconstructed

reconstructed: boolean

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

Optionalvalue

value?: number = undefined

The tax amount.

Methods

compare

toString

toTableLine

StaticarrayConfidence

StaticarraySum

StaticcompareArrays

  • compareArrays(array1, array2, attr?): boolean

  • 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

Settings

Member Visibility

On This Page

Constructors
Properties
Methods