RTRDataField class

A recognized data field. Provides field contents, location and included data fields, if applicable.

The field can be compound, which means that it consists of several parts.

Note that a field may have several components — for example, it can contain two or more words. Component details are available from the components array. Each element of this array is an RTRDataField object with its own text property (for example, a word), textLines property (details about recognized text) and quadrangle property (the bounding quadrangle of this component). The field's text property contains its entire text, and the field's quadrangle property represents the whole area of a field: this quadrangle encloses the quadrangles of all components.

The components array always contains at least one element. When a field contains only one component, the text and quadrangle properties of the field and this component are identical.

Properties

Name Type Description
id NSString*, read-only The internal field identifier. Can be one of the predefined fields or the custom field identifier that you specified when adding the field in RTRDataSchemeBuilder.  May be nil in case the component is a part of a compound component.
name NSString*, read-only The name of the field as seen in the document or specified in the custom data capture profile.
quadrangle NSArray<NSValue*>*, read-only

The four vertex points of the bounding quadrangle. The vertices are indexed clockwise starting from the bottom left.

Get the NSValue.CGPointValue property to obtain point coordinates as a CGPoint.

text NSString*, read-only The recognized field contents.
textLines NSArray<RTRTextLine*>* An array of recognized text lines; the location and additional information are also available.
components NSArray<RTRDataField*>*, read-only Field components represented by RTRDataField objects. If the field has only one component, this array is empty.

02.03.2022 12:59:15

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.