Document Scanner SDKPxTextAttribute Class
@interface PxTextAttribute : NSObject
One node in a recognised-text result: a page, block, paragraph, line, word, or symbol, together with the properties available at that level.
Overview
level says which node this is; the level-specific properties below are only meaningful for an attribute of the matching PxAttrLevel.
Instance Properties
| Name | Summary |
|---|---|
| boundingRect | The attribute’s bounding box, oriented to match the displayed image. |
| endPos | The attribute’s end position in the recognised text. |
| id | This attribute’s ID, unique throughout the scan result. |
| level | The level of this attribute in the page hierarchy. See PxAttrLevel. |
| lineConstTerm | The constant term of the line’s baseline equation (line level). |
| lineSlope | The slope (multiplier) of the line’s baseline equation (line level). |
| lineTextAngle | The line’s incline angle, in degrees (line level). |
| nativeBoundingRect | The attribute’s bounding box in the image’s native coordinates. |
| ownerId | The ID of this attribute’s owner (for example, the line that owns a word), or -1 if none. |
| pageNumRecognizedSymbols | The number of recognised symbols on the page (page level). |
| pageNumUncertainSymbols | The number of uncertainly recognised symbols on the page (page level). |
| pageNumber | The page number (page level). |
| paragraphIsLtr | Whether the paragraph reads left-to-right (paragraph level). |
| startPos | The attribute’s start position in the recognised text. |
| symbolConfidence | The symbol’s recognition confidence, as a percentage (0–100) (symbol level). |
| symbolNumVariants | The number of alternative readings for this symbol (symbol level). See symbolVariant:confidence:. |
| wordConfidence | The word’s recognition confidence, as a percentage (0–100) (word level). |
| wordDirection | The word’s reading direction (word level). |
| wordFontIsBold | Whether the word’s font is bold (word level). |
| wordFontIsItalic | Whether the word’s font is italic (word level). |
| wordFontName | The word’s font name (word level). |
| wordFontSize | The word’s font size (word level). |
| wordLanguage | The word’s detected language (word level). |
| wordLocale | The word’s detected locale (word level). |
Instance Methods
| Name | Summary |
|---|---|
| symbolVariant: | Returns the text of the symbol variant at the given index. |
| symbolVariant:confidence: | Returns the text of the symbol variant at the given index, and its confidence. |
Relationships
Inherits From
- NSObject