Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FormCountryRegionField

Package version

A form field with a value representing an administrative region or country in the world.

Hierarchy

Index

Properties

Properties

Optional confidence

confidence: undefined | number

The sevice's confidence (expressed as a number between zero and one) in the correctness of the field value.

Optional labelData

labelData: FieldData

Contains the recognized field label's text, bounding box, and field elements.

Optional name

name: undefined | string

A user-defined label for the field.

Optional value

value: undefined | string

The recognized country or region, represented by a three-letter (ISO 3166-1 alpha-3) code.

Optional valueData

valueData: FieldData

Contains the recognized field value's text, bounding box, and field elements.

valueType

valueType: "countryRegion"

The type of this field's value - "countryRegion"

Generated using TypeDoc