Share via

DocumentPage Class

  • Reference
Package:
com.azure.ai.formrecognizer.documentanalysis.models
Maven Artifact:
com.azure:azure-ai-formrecognizer:4.1.9
  • java.lang.Object
    • com.azure.ai.formrecognizer.documentanalysis.models.DocumentPage

public final class DocumentPage

Content and layout elements extracted from a page from the input.

Constructor Summary

Constructor Description
DocumentPage()

Creates a DocumentPage object.

Method Summary

Modifier and Type Method and Description
Float getAngle()

Get the general orientation of the content in clockwise direction, measured in degrees between (-180, 180].
List<DocumentBarcode> getBarcodes()

Get the extracted barcodes from the page.
List<DocumentFormula> getFormulas()

Get the extracted formulas from the page.
Float getHeight()

Get the height of the image/PDF in pixels/inches, respectively.
List<DocumentLine> getLines()

Get the extracted lines from the page, potentially containing both textual and visual elements.
int getPageNumber()

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

Get the extracted selection marks from the page.
List<DocumentSpan> getSpans()

Get the location of the page in the reading order concatenated content.
DocumentPageLengthUnit getUnit()

Get the unit used by the width, height, and boundingBox properties.
Float getWidth()

Get the width of the image/PDF in pixels/inches, respectively.
List<DocumentWord> getWords()

Get the extracted words from the page.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DocumentPage

public DocumentPage()

Creates a DocumentPage object.

Method Details

getAngle

public Float getAngle()

Get the general orientation of the content in clockwise direction, measured in degrees between (-180, 180].

Returns:

the angle value.

getBarcodes

public List getBarcodes()

Get the extracted barcodes from the page.

Returns:

the barcodes value.

getFormulas

public List getFormulas()

Get the extracted formulas from the page.

Returns:

the formulas value.

getHeight

public Float getHeight()

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

Returns:

the height value.

getLines

public List getLines()

Get the extracted lines from the page, potentially containing both textual and visual elements.

Returns:

the lines value.

getPageNumber

public int getPageNumber()

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

Returns:

the pageNumber value.

getSelectionMarks

public List getSelectionMarks()

Get the extracted selection marks from the page.

Returns:

the selectionMarks value.

getSpans

public List getSpans()

Get the location of the page in the reading order concatenated content.

Returns:

the spans value.

getUnit

public DocumentPageLengthUnit getUnit()

Get 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 of the image/PDF in pixels/inches, respectively.

Returns:

the width value.

getWords

public List getWords()

Get the extracted words from the page.

Returns:

the words value.

Applies to