-
Notifications
You must be signed in to change notification settings - Fork 224
/
com.azure.ai.formrecognizer.models.FormLine.yml
106 lines (106 loc) · 7.66 KB
/
com.azure.ai.formrecognizer.models.FormLine.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
### YamlMime:JavaType
uid: "com.azure.ai.formrecognizer.models.FormLine"
fullName: "com.azure.ai.formrecognizer.models.FormLine"
name: "FormLine"
nameWithType: "FormLine"
summary: "Represents a line of text and its appearance."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.ai.formrecognizer.models.FormElement?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.ai.formrecognizer.models.FormElement?alt=com.azure.ai.formrecognizer.models.FormElement&text=FormElement\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.azure.ai.formrecognizer.models.FormElement.getBoundingBox()?alt=com.azure.ai.formrecognizer.models.FormElement.getBoundingBox&text=getBoundingBox\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.ai.formrecognizer.models.FormElement.getPageNumber()?alt=com.azure.ai.formrecognizer.models.FormElement.getPageNumber&text=getPageNumber\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.ai.formrecognizer.models.FormElement.getText()?alt=com.azure.ai.formrecognizer.models.FormElement.getText&text=getText\" data-throw-if-not-resolved=\"False\" />"
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **FormLine**</br> extends <xref href=\"com.azure.ai.formrecognizer.models.FormElement?alt=com.azure.ai.formrecognizer.models.FormElement&text=FormElement\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.azure.ai.formrecognizer.models.FormLine.FormLine(java.lang.String,com.azure.ai.formrecognizer.models.FieldBoundingBox,java.lang.Integer,java.util.List<com.azure.ai.formrecognizer.models.FormWord>)"
fullName: "com.azure.ai.formrecognizer.models.FormLine.FormLine(String text, FieldBoundingBox boundingBox, Integer pageNumber, List<FormWord> words)"
name: "FormLine(String text, FieldBoundingBox boundingBox, Integer pageNumber, List<FormWord> words)"
nameWithType: "FormLine.FormLine(String text, FieldBoundingBox boundingBox, Integer pageNumber, List<FormWord> words)"
summary: "Creates raw OCR item."
parameters:
- description: "The text content of recognized field."
name: "text"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The BoundingBox of the recognized field."
name: "boundingBox"
type: "<xref href=\"com.azure.ai.formrecognizer.models.FieldBoundingBox?alt=com.azure.ai.formrecognizer.models.FieldBoundingBox&text=FieldBoundingBox\" data-throw-if-not-resolved=\"False\" />"
- description: "the page number."
name: "pageNumber"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- description: "The list of word element references."
name: "words"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.models.FormWord?alt=com.azure.ai.formrecognizer.models.FormWord&text=FormWord\" data-throw-if-not-resolved=\"False\" />>"
syntax: "public FormLine(String text, FieldBoundingBox boundingBox, Integer pageNumber, List<FormWord> words)"
desc: "Creates raw OCR item. When includeFieldElements is set to true, a list of recognized text lines."
methods:
- uid: "com.azure.ai.formrecognizer.models.FormLine.getAppearance()"
fullName: "com.azure.ai.formrecognizer.models.FormLine.getAppearance()"
name: "getAppearance()"
nameWithType: "FormLine.getAppearance()"
summary: "Get the appearance of the text line."
syntax: "public TextAppearance getAppearance()"
desc: "Get the appearance of the text line."
returns:
description: "the appearance of the text line."
type: "<xref href=\"com.azure.ai.formrecognizer.models.TextAppearance?alt=com.azure.ai.formrecognizer.models.TextAppearance&text=TextAppearance\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.models.FormLine.getBoundingBox()"
fullName: "com.azure.ai.formrecognizer.models.FormLine.getBoundingBox()"
name: "getBoundingBox()"
nameWithType: "FormLine.getBoundingBox()"
summary: "Bounding<wbr>Box property of the element."
overridden: "com.azure.ai.formrecognizer.models.FormElement.getBoundingBox()"
syntax: "public FieldBoundingBox getBoundingBox()"
desc: "BoundingBox property of the element."
returns:
type: "<xref href=\"com.azure.ai.formrecognizer.models.FieldBoundingBox?alt=com.azure.ai.formrecognizer.models.FieldBoundingBox&text=FieldBoundingBox\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.models.FormLine.getPageNumber()"
fullName: "com.azure.ai.formrecognizer.models.FormLine.getPageNumber()"
name: "getPageNumber()"
nameWithType: "FormLine.getPageNumber()"
summary: "Get the 1-based page number in the input document."
overridden: "com.azure.ai.formrecognizer.models.FormElement.getPageNumber()"
syntax: "public int getPageNumber()"
desc: "Get the 1-based page number in the input document."
returns:
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.models.FormLine.getText()"
fullName: "com.azure.ai.formrecognizer.models.FormLine.getText()"
name: "getText()"
nameWithType: "FormLine.getText()"
summary: "The text content of the form element."
overridden: "com.azure.ai.formrecognizer.models.FormElement.getText()"
syntax: "public String getText()"
desc: "The text content of the form element."
returns:
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.ai.formrecognizer.models.FormLine.getWords()"
fullName: "com.azure.ai.formrecognizer.models.FormLine.getWords()"
name: "getWords()"
nameWithType: "FormLine.getWords()"
summary: "Get the list of words in the text line."
syntax: "public List<FormWord> getWords()"
desc: "Get the list of words in the text line."
returns:
description: "the unmodifiable list of words in the <code>FormLine</code>."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.models.FormWord?alt=com.azure.ai.formrecognizer.models.FormWord&text=FormWord\" data-throw-if-not-resolved=\"False\" />>"
type: "class"
desc: "Represents a line of text and its appearance."
metadata: {}
package: "com.azure.ai.formrecognizer.models"
artifact: com.azure:azure-ai-formrecognizer:4.1.9