scanbotsdk
    Preparing search index...

    Class Field

    Generic document field.

    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
    Index

    Constructors

    constructor

    Properties

    confidenceWeight image parsedData polygonInRoot type validationStatus value

    Methods

    [asyncDispose] release

    Constructors

    • Parameters

      • source: DeepPartial<Field> = {}

      Returns Field

    Properties

    confidenceWeight: number = 1.0

    Confidence weight.

    Default is 1.0.

    image: ImageRef | null = null

    Crop of the field.

    parsedData: FieldParsedData[] = []

    Parsed data.

    polygonInRoot: Point[]

    Coordinates of the field in the root document coordinate system.

    type: FieldType

    The type of the field.

    validationStatus: FieldValidationStatus = "NONE"

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

    Default is NONE.

    value: OcrResult | null

    Value of the field. Applicable only to text fields.

    Methods

    • Returns Promise<void>

    • Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods