Class CustomV1Document

Document data for Custom builds.

Hierarchy

CustomV1Document

Implements

Prediction

Index

Constructors

Properties

classifications fields

Methods

columnsToLineItems setField toString

Constructors

constructor

new CustomV1Document(rawPrediction: StringDict, pageId?: number): CustomV1Document
Parameters
- rawPrediction: StringDict
- Optional pageId: number
Returns CustomV1Document
- Defined in src/product/custom/customV1Document.ts:14

Properties

classifications

classifications: Map<string, internal.parsing.custom.ClassificationField> = ...

Map of classification fields for a Custom build.

fields

fields: Map<string, ListField> = ...

Map of fields for a Custom build.

Methods

columnsToLineItems

columnsToLineItems(anchorNames: string[], fieldNames: string[], heightTolerance?: number): CustomLines
Order column fields into line items.
Parameters
- anchorNames: string[]
  
  list of possible anchor fields.
- fieldNames: string[]
  
  list of all column fields.
- heightTolerance: number = 0.01
  
  height tolerance to apply to lines.
Returns CustomLines
- Defined in src/product/custom/customV1Document.ts:59

`Protected` setField

setField(fieldName: string, fieldValue: any, pageId?: number): void
Sorts and sets fields between classification fields and regular fields. Note: Currently, two types of fields possible in a custom API response: fields having a list of values, and classification fields.
Parameters
- fieldName: string
  
  name of the field.
- fieldValue: any
  
  value of the field.
- Optional pageId: number
  
  page the field was found on.
Returns void
- Defined in src/product/custom/customV1Document.ts:30

toString

toString(): string
Default string representation.

Returns string
- Defined in src/product/custom/customV1Document.ts:71

Generated using TypeDoc