Class Field

Generic document field.

Example

Since the instance of the class contains objects backed by native resources (e.g. images) and implements AsyncDisposable it's highly recommended to use the await using syntax when an instance is created or is received from an API:

await using instance = await getFieldFromAnApi();

Alternatively, one can explicitly call release method to release the native resources or use autorelease convenience function. If neither is used, the resource will be released when the instance is garbage collected which is not recommended.

Implements

  • AsyncDisposable

Constructors

constructor

Properties

confidenceWeight image parsedData polygonInRoot type validationStatus value

Methods

[asyncDispose] release

Constructors

constructor

  • new Field(source?): Field

  • Parameters

    • source: DeepPartial<Field> = {}

    Returns Field

Properties

Readonly confidenceWeight

confidenceWeight: number = 1.0

Confidence weight.

Default is 1.0

Readonly image

image: null | ImageRef = null

Crop of the field.

Readonly parsedData

parsedData: FieldParsedData[] = []

Parsed data.

Readonly polygonInRoot

polygonInRoot: Point[]

Coordinates of the field in the root document coordinate system.

Readonly type

type: FieldType

The type of the field.

Readonly validationStatus

validationStatus: FieldValidationStatus = "NONE"

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

Default is NONE

Readonly value

value: null | OcrResult

Value of the field. Applicable only to text fields.

Methods

[asyncDispose]

  • [asyncDispose](): Promise<void>

  • Returns Promise<void>

release

  • release(): Promise<void>

  • Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorconfidenceWeightimageparsedDatapolygonInRoottypevalidationStatusvalue[asyncDispose]release