Dela via

FormPage Class

Package:
com.azure.ai.formrecognizer.models
Maven Artifact:
com.azure:azure-ai-formrecognizer:4.1.13
  • java.lang.Object
    • com.azure.ai.formrecognizer.models.FormPage

public final class FormPage

Represents a page recognized from the input document. Contains lines, words, tables, selection marks, and page metadata.

Constructor Summary

Constructor Description
FormPage(float height, float textAngle, LengthUnit unit, float width, List<FormLine> lines, List<FormTable> tables, int pageNumber)

Constructs a FormPage object.

Method Summary

Modifier and Type Method and Description
float getHeight()

Get the height property: The height of the image/PDF in pixels/inches, respectively.
List<FormLine> getLines()

Get the lines property: When includeFieldElements is set to true, a list of recognized text lines.
Integer getPageNumber()

Get the 1-based page number in the input document.
List<FormSelectionMark> getSelectionMarks()

Get the selection marks in the input document.
List<FormTable> getTables()

Get the tables property: List of data tables extracted from the page.
float getTextAngle()

Get the text angle property.
LengthUnit getUnit()

Get the unit property: The unit used by the width, height and boundingBox properties.
float getWidth()

Get the width property: The width of the image/PDF in pixels/inches, respectively.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

FormPage

public FormPage(float height, float textAngle, LengthUnit unit, float width, List<FormLine> lines, List<FormTable> tables, int pageNumber)

Constructs a FormPage object.

Parameters:

height - The height of the image/PDF in pixels/inches, respectively.
textAngle - The general orientation of the text in clockwise direction.
unit - The unit used by the width, height and boundingBox properties.
width - The width of the image/PDF in pixels/inches, respectively.
lines - When includeFieldElements is set to true, a list of recognized text lines.
tables - List of data tables extracted from the page.
pageNumber - the 1-based page number in the input document.

Method Details

getHeight

public float getHeight()

Get the height property: The height of the image/PDF in pixels/inches, respectively.

Returns:

the height value.

getLines

public List<FormLine> getLines()

Get the lines property: When includeFieldElements is set to true, a list of recognized text lines.

Returns:

the unmodifiable list of recognized lines.

getPageNumber

public Integer getPageNumber()

Get the 1-based page number in the input document.

Returns:

the page number value.

getSelectionMarks

public List<FormSelectionMark> getSelectionMarks()

Get the selection marks in the input document.

Returns:

the selection marks.

getTables

public List<FormTable> getTables()

Get the tables property: List of data tables extracted from the page.

Returns:

the unmodifiable list of recognized tables.

getTextAngle

public float getTextAngle()

Get the text angle property.

Returns:

the text angle value.

getUnit

public LengthUnit getUnit()

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:

the unit value.

getWidth

public float getWidth()

Get the width property: The width of the image/PDF in pixels/inches, respectively.

Returns:

the width value.

Applies to