/
com.azure.ai.formrecognizer.models.FormPage.yml
139 lines (139 loc) · 9.65 KB
/
com.azure.ai.formrecognizer.models.FormPage.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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
### YamlMime:JavaType
uid: "com.azure.ai.formrecognizer.models.FormPage"
fullName: "com.azure.ai.formrecognizer.models.FormPage"
name: "FormPage"
nameWithType: "FormPage"
summary: "Represents a page recognized from the input document."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- 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 **FormPage**"
constructors:
- uid: "com.azure.ai.formrecognizer.models.FormPage.FormPage(float,float,com.azure.ai.formrecognizer.models.LengthUnit,float,java.util.List<com.azure.ai.formrecognizer.models.FormLine>,java.util.List<com.azure.ai.formrecognizer.models.FormTable>,int)"
fullName: "com.azure.ai.formrecognizer.models.FormPage.FormPage(float height, float textAngle, LengthUnit unit, float width, List<FormLine> lines, List<FormTable> tables, int pageNumber)"
name: "FormPage(float height, float textAngle, LengthUnit unit, float width, List<FormLine> lines, List<FormTable> tables, int pageNumber)"
nameWithType: "FormPage.FormPage(float height, float textAngle, LengthUnit unit, float width, List<FormLine> lines, List<FormTable> tables, int pageNumber)"
summary: "Constructs a Form<wbr>Page object."
parameters:
- description: "The height of the image/PDF in pixels/inches, respectively."
name: "height"
type: "<xref href=\"float?alt=float&text=float\" data-throw-if-not-resolved=\"False\" />"
- description: "The general orientation of the text in clockwise direction."
name: "textAngle"
type: "<xref href=\"float?alt=float&text=float\" data-throw-if-not-resolved=\"False\" />"
- description: "The unit used by the width, height and boundingBox properties."
name: "unit"
type: "<xref href=\"com.azure.ai.formrecognizer.models.LengthUnit?alt=com.azure.ai.formrecognizer.models.LengthUnit&text=LengthUnit\" data-throw-if-not-resolved=\"False\" />"
- description: "The width of the image/PDF in pixels/inches, respectively."
name: "width"
type: "<xref href=\"float?alt=float&text=float\" data-throw-if-not-resolved=\"False\" />"
- description: "When includeFieldElements is set to true, a list of recognized text lines."
name: "lines"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.models.FormLine?alt=com.azure.ai.formrecognizer.models.FormLine&text=FormLine\" data-throw-if-not-resolved=\"False\" />>"
- description: "List of data tables extracted from the page."
name: "tables"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.models.FormTable?alt=com.azure.ai.formrecognizer.models.FormTable&text=FormTable\" data-throw-if-not-resolved=\"False\" />>"
- description: "the 1-based page number in the input document."
name: "pageNumber"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FormPage(float height, float textAngle, LengthUnit unit, float width, List<FormLine> lines, List<FormTable> tables, int pageNumber)"
desc: "Constructs a FormPage object."
methods:
- uid: "com.azure.ai.formrecognizer.models.FormPage.getHeight()"
fullName: "com.azure.ai.formrecognizer.models.FormPage.getHeight()"
name: "getHeight()"
nameWithType: "FormPage.getHeight()"
summary: "Get the height property: The height of the image/PDF in pixels/inches, respectively."
syntax: "public float getHeight()"
desc: "Get the height property: The height of the image/PDF in pixels/inches, respectively."
returns:
description: "the height value."
type: "<xref href=\"float?alt=float&text=float\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.models.FormPage.getLines()"
fullName: "com.azure.ai.formrecognizer.models.FormPage.getLines()"
name: "getLines()"
nameWithType: "FormPage.getLines()"
summary: "Get the lines property: When include<wbr>Field<wbr>Elements is set to true, a list of recognized text lines."
syntax: "public List<FormLine> getLines()"
desc: "Get the lines property: When includeFieldElements is set to true, a list of recognized text lines."
returns:
description: "the unmodifiable list of recognized lines."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.models.FormLine?alt=com.azure.ai.formrecognizer.models.FormLine&text=FormLine\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.ai.formrecognizer.models.FormPage.getPageNumber()"
fullName: "com.azure.ai.formrecognizer.models.FormPage.getPageNumber()"
name: "getPageNumber()"
nameWithType: "FormPage.getPageNumber()"
summary: "Get the 1-based page number in the input document."
syntax: "public Integer getPageNumber()"
desc: "Get the 1-based page number in the input document."
returns:
description: "the page number value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.ai.formrecognizer.models.FormPage.getSelectionMarks()"
fullName: "com.azure.ai.formrecognizer.models.FormPage.getSelectionMarks()"
name: "getSelectionMarks()"
nameWithType: "FormPage.getSelectionMarks()"
summary: "Get the selection marks in the input document."
syntax: "public List<FormSelectionMark> getSelectionMarks()"
desc: "Get the selection marks in the input document."
returns:
description: "the selection marks."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.models.FormSelectionMark?alt=com.azure.ai.formrecognizer.models.FormSelectionMark&text=FormSelectionMark\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.ai.formrecognizer.models.FormPage.getTables()"
fullName: "com.azure.ai.formrecognizer.models.FormPage.getTables()"
name: "getTables()"
nameWithType: "FormPage.getTables()"
summary: "Get the tables property: List of data tables extracted from the page."
syntax: "public List<FormTable> getTables()"
desc: "Get the tables property: List of data tables extracted from the page."
returns:
description: "the unmodifiable list of recognized tables."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.models.FormTable?alt=com.azure.ai.formrecognizer.models.FormTable&text=FormTable\" data-throw-if-not-resolved=\"False\" />>"
- uid: "com.azure.ai.formrecognizer.models.FormPage.getTextAngle()"
fullName: "com.azure.ai.formrecognizer.models.FormPage.getTextAngle()"
name: "getTextAngle()"
nameWithType: "FormPage.getTextAngle()"
summary: "Get the text angle property."
syntax: "public float getTextAngle()"
desc: "Get the text angle property."
returns:
description: "the text angle value."
type: "<xref href=\"float?alt=float&text=float\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.models.FormPage.getUnit()"
fullName: "com.azure.ai.formrecognizer.models.FormPage.getUnit()"
name: "getUnit()"
nameWithType: "FormPage.getUnit()"
summary: "Get the unit property: The unit used by the width, height and bounding<wbr>Box properties."
syntax: "public LengthUnit getUnit()"
desc: "Get the unit property: The unit used by the width, height and boundingBox properties. For images, the unit is \"pixel\". For PDF, the unit is \"inch\"."
returns:
description: "the unit value."
type: "<xref href=\"com.azure.ai.formrecognizer.models.LengthUnit?alt=com.azure.ai.formrecognizer.models.LengthUnit&text=LengthUnit\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.models.FormPage.getWidth()"
fullName: "com.azure.ai.formrecognizer.models.FormPage.getWidth()"
name: "getWidth()"
nameWithType: "FormPage.getWidth()"
summary: "Get the width property: The width of the image/PDF in pixels/inches, respectively."
syntax: "public float getWidth()"
desc: "Get the width property: The width of the image/PDF in pixels/inches, respectively."
returns:
description: "the width value."
type: "<xref href=\"float?alt=float&text=float\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Represents a page recognized from the input document. Contains lines, words, tables, selection marks, and page metadata."
metadata: {}
package: "com.azure.ai.formrecognizer.models"
artifact: com.azure:azure-ai-formrecognizer:4.1.7