Text.Line
Stay organized with collections
Save and categorize content based on your preferences.
Represents a line of text.
Inherited Method Summary
From class java.lang.Object
|
Object
|
clone()
|
| boolean |
|
| void |
finalize()
|
|
final Class<?>
|
getClass()
|
| int |
hashCode()
|
| final void |
notify()
|
| final void |
notifyAll()
|
|
String
|
toString()
|
| final void |
wait(long arg0, int arg1)
|
| final void |
wait(long arg0)
|
| final void |
wait()
|
Public Methods
public float getAngle ()
Gets the angle(in degrees, clockwise is positive, range is [-180, 180]) of the
rotation of the recognized line.
public Rect getBoundingBox ()
Returns the axis-aligned bounding rectangle of the detected text. If nothing found,
it returns null.
public float getConfidence ()
Gets the confidence of the recognized line.
It is in range [0.0f, 1.0f].
Note that this information will be unavailable (i.e. returns 0) if you're using the
unbundled version of Text Recognition library with an older version of Google Play
services (lower than 22.30.XX).
public Point[]
getCornerPoints ()
Gets the four corner points in clockwise direction starting with top-left. Due to
the possible perspective distortions, this is not necessarily a rectangle. Parts of the
region could be outside of the image. If nothing found, it returns
null.
public synchronized List<Text.Element>
getElements ()
Gets a unmodifiable list of Text.Elements
that make up this text line.
Returns an empty list if nothing is found.
public String getRecognizedLanguage ()
Gets prevailing language in the text, if any. The format is in BCP47 (e.g. "en" or
"sr-Latn-BA") or "und" if the language could not be determined.
public String getText ()
Gets the recognized text in the Text.Line.
It concatenates text strings from underlying Text.Elements
separated by white spaces.
The recognized text is in reading order for the language. For Latin, it is
left-to-right within a Line.
Returns an empty string if nothing is found.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[null,null,["Last updated 2024-10-31 UTC."],[[["\u003cp\u003e\u003ccode\u003eText.Line\u003c/code\u003e represents a single line of recognized text within a larger text block.\u003c/p\u003e\n"],["\u003cp\u003eIt provides access to the text content, bounding box, corner points, recognized language, and confidence score.\u003c/p\u003e\n"],["\u003cp\u003eEach line is composed of individual elements (\u003ccode\u003eText.Element\u003c/code\u003e) that can be accessed.\u003c/p\u003e\n"],["\u003cp\u003eInformation about the line's angle and the confidence score might be unavailable in certain cases like using an older version of Google Play services.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use this class to extract and manipulate individual lines of text from recognized text blocks.\u003c/p\u003e\n"]]],["`Text.Line` provides methods to analyze a recognized line of text. Key actions include: retrieving the line's `angle`, `bounding box`, and `confidence`. It allows access to the `corner points` and a list of `Text.Element`s composing the line. Other functions provide the `recognized language` and the combined `text` of the line. The methods will return `null`, empty, or a default value if nothing is found.\n"],null,["# Text.Line\n\npublic static class **Text.Line** extends [Object](//developer.android.com/reference/java/lang/Object.html) \nRepresents a line of text. \n\n### Public Method Summary\n\n|------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| float | [getAngle](/android/reference/com/google/mlkit/vision/text/Text.Line#getAngle())() Gets the angle(in degrees, clockwise is positive, range is \\[-180, 180\\]) of the rotation of the recognized line. |\n| [Rect](//developer.android.com/reference/android/graphics/Rect.html) | [getBoundingBox](/android/reference/com/google/mlkit/vision/text/Text.Line#getBoundingBox())() Returns the axis-aligned bounding rectangle of the detected text. |\n| float | [getConfidence](/android/reference/com/google/mlkit/vision/text/Text.Line#getConfidence())() Gets the confidence of the recognized line. |\n| [Point\\[\\]](//developer.android.com/reference/android/graphics/Point.html) | [getCornerPoints](/android/reference/com/google/mlkit/vision/text/Text.Line#getCornerPoints())() Gets the four corner points in clockwise direction starting with top-left. |\n| synchronized [List](//developer.android.com/reference/java/util/List.html)\\\u003c[Text.Element](/android/reference/com/google/mlkit/vision/text/Text.Element)\\\u003e | [getElements](/android/reference/com/google/mlkit/vision/text/Text.Line#getElements())() Gets a unmodifiable list of [Text.Element](/android/reference/com/google/mlkit/vision/text/Text.Element)s that make up this text line. |\n| [String](//developer.android.com/reference/java/lang/String.html) | [getRecognizedLanguage](/android/reference/com/google/mlkit/vision/text/Text.Line#getRecognizedLanguage())() Gets prevailing language in the text, if any. |\n| [String](//developer.android.com/reference/java/lang/String.html) | [getText](/android/reference/com/google/mlkit/vision/text/Text.Line#getText())() Gets the recognized text in the [Text.Line](/android/reference/com/google/mlkit/vision/text/Text.Line). |\n\n### Inherited Method Summary\n\nFrom class java.lang.Object \n\n|----------------------------------------------------------------------------|--------------------------------------------------------------------------------|\n| [Object](//developer.android.com/reference/java/lang/Object.html) | clone() |\n| boolean | equals([Object](//developer.android.com/reference/java/lang/Object.html) arg0) |\n| void | finalize() |\n| final [Class](//developer.android.com/reference/java/lang/Class.html)\\\u003c?\\\u003e | getClass() |\n| int | hashCode() |\n| final void | notify() |\n| final void | notifyAll() |\n| [String](//developer.android.com/reference/java/lang/String.html) | toString() |\n| final void | wait(long arg0, int arg1) |\n| final void | wait(long arg0) |\n| final void | wait() |\n\nPublic Methods\n--------------\n\n#### public float **getAngle** ()\n\nGets the angle(in degrees, clockwise is positive, range is \\[-180, 180\\]) of the\nrotation of the recognized line. \n\n#### public [Rect](//developer.android.com/reference/android/graphics/Rect.html) **getBoundingBox** ()\n\nReturns the axis-aligned bounding rectangle of the detected text. If nothing found,\nit returns `null`. \n\n#### public float **getConfidence** ()\n\nGets the confidence of the recognized line.\n\nIt is in range \\[0.0f, 1.0f\\].\n\nNote that this information will be unavailable (i.e. returns 0) if you're using the\nunbundled version of Text Recognition library with an older version of Google Play\nservices (lower than 22.30.XX). \n\n#### public [Point\\[\\]](//developer.android.com/reference/android/graphics/Point.html)\n**getCornerPoints** ()\n\nGets the four corner points in clockwise direction starting with top-left. Due to\nthe possible perspective distortions, this is not necessarily a rectangle. Parts of the\nregion could be outside of the image. If nothing found, it returns\n`null`. \n\n#### public synchronized [List](//developer.android.com/reference/java/util/List.html)\\\u003c[Text.Element](/android/reference/com/google/mlkit/vision/text/Text.Element)\\\u003e\n**getElements** ()\n\nGets a unmodifiable list of [Text.Element](/android/reference/com/google/mlkit/vision/text/Text.Element)s\nthat make up this text line.\n\nReturns an empty list if nothing is found. \n\n#### public [String](//developer.android.com/reference/java/lang/String.html) **getRecognizedLanguage** ()\n\nGets prevailing language in the text, if any. The format is in BCP47 (e.g. \"en\" or\n\"sr-Latn-BA\") or \"und\" if the language could not be determined. \n\n#### public [String](//developer.android.com/reference/java/lang/String.html) **getText** ()\n\nGets the recognized text in the [Text.Line](/android/reference/com/google/mlkit/vision/text/Text.Line).\nIt concatenates text strings from underlying [Text.Element](/android/reference/com/google/mlkit/vision/text/Text.Element)s\nseparated by white spaces.\n\nThe recognized text is in reading order for the language. For Latin, it is\nleft-to-right within a Line.\n\nReturns an empty string if nothing is found."]]
