DSRawTextLine
The DSRawTextLine
class represents a text line in an image. It can be in one of the following states:
TLS_LOCALIZED
: Localized but recognition not performed.TLS_RECOGNITION_FAILED
: Recognition failed.TLS_RECOGNIZED_SUCCESSFULLY
: Successfully recognized.
Definition
Assembly: DynamsoftLabelRecognizer.xcframework
- Objective-C
- Swift
@interface DSRawTextLine: NSObject
class RawTextLine: NSObject
Methods
Methods | Description |
---|---|
getText |
Returns the recognized text. |
setText |
Sets the recognized text. |
getConfidence |
Returns the confidence level of the recognized text. |
getCharacterResults |
Returns all the characters contained by the textline. |
getRowNumber |
Returns the row number of the text line within the image. |
setRowNumber |
Sets the row number of the text line within the image. |
getSpecificationName |
Get the name of the TextLineSpecification object that generated this TextLineResultItem . |
setSpecificationName |
Sets the name of the TextLineSpecification object that generated this TextLineResultItem . |
getLocation |
Returns the location of the text line. |
setLocation |
Sets the location of the text line. |
getText
Returns the recognized text.
- Objective-C
- Swift
-(NSString*)getText;
func getText() -> String
Return value
Returns the text of the text line.
setText
Returns the recognized text.
- Objective-C
- Swift
-(NSInteger)setText:(NSString *)text;
func setText(_ text: String) -> Int
Parameter
text
: The text.
Return value
Returns the ErrorCode
if failed. Otherwise, returns 0.
getConfidence
Returns the confidence level of the recognized text.
- Objective-C
- Swift
-(NSInteger)getConfidence;
func getConfidence() -> Int
Return value
Returns the confidence level of the text line.
getCharacterResults
Returns all the characters contained by the textline in an array of DSCharacterResult
.
- Objective-C
- Swift
-(nullable NSArray<DSCharacterResult *>*)getCharacterResults;
func getCharacterResults() -> [CharacterResult]
Return value
Returns all the characters contained by the textline in an array of DSCharacterResult
.
getRowNumber
Returns the row number of the text line within the image.
- Objective-C
- Swift
-(NSInteger)getRowNumber;
func getRowNumber() -> Int
Return value
Returns the row number of the text line within the image.
setRowNumber
Sets the row number of the text line within the image.
- Objective-C
- Swift
-(NSInteger)setRowNumber:(NSInteger)rowNumber;
func setRowNumber(_ rowNumber: Int) -> Int
Parameter
rowNumber
: The row number of the text line within the image.
Return value
Returns 0 if success, otherwise an error code.
getSpecificationName
Returns the name of the TextLineSpecification
object that generated this TextLineResultItem
.
- Objective-C
- Swift
-(NSString *)getSpecificationName;
func getSpecificationName() -> String
Return value
The name of the TextLineSpecification
object that generated this TextLineResultItem
.
setSpecificationName
Sets the name of the TextLineSpecification
object that generated this TextLineResultItem
.
- Objective-C
- Swift
-(NSInteger)setSpecificationName:(NSString *)specificationName;
func setSpecificationName(_ specificationName: String) -> Int
Parameter
specificationName
: The name of the TextLineSpecification
object that generated this TextLineResultItem
.
Return value
Returns 0 if success, otherwise an error code.
getLocation
Returns a Quadrilateral
object which represents the location of the text line.
- Objective-C
- Swift
-(DSQuadrilateral *)getLocation;
func getLocation() -> Quadrilateral
Return value
A Quadrilateral
object which represents the location of the text line.
setLocation
Set the location of the text line.
- Objective-C
- Swift
-(NSInteger)setLocation:(DSQuadrilateral *)location;
func setLocation(_ location: Quadrilateral) -> Int
Parameter
location
: The location of the text line.
Return value
Returns 0 if success, otherwise an error code.
getStatus
Returns the status of the text line.
- Objective-C
- Swift
-(DSRawTextLineStatus)getStatus;
func getStatus() -> RawTextLineStatus
Return value
The status of the text line.