DocumentPage interface

Package:

@azure/ai-form-recognizer

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

Properties

angle	The general orientation of the content in clockwise direction, measured in degrees between (-180, 180].
barcodes	Extracted barcodes from the page.
formulas	Extracted formulas from the page. The "formulas" feature must be enabled or this property will be undefined. See features.
height	The height of the image/PDF in pixels/inches, respectively.
lines	Extracted lines from the page, potentially containing both textual and visual elements.
pageNumber	1-based page number in the input document.
selectionMarks	Extracted selection marks from the page.
spans	Location of the page in the reading order concatenated content.
unit	The unit used by the width, height, and polygon properties. For images, the unit is "pixel". PDF, the unit is "inch".
width	The width of the image/PDF in pixels/inches, respectively.
words	Extracted words from the page.

Property Details

angle

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

angle?: number

Property Value

number

barcodes

Extracted barcodes from the page.

barcodes?: DocumentBarcode[]

Property Value

DocumentBarcode[]

formulas

Extracted formulas from the page.

The "formulas" feature must be enabled or this property will be undefined.

See features.

formulas?: DocumentFormula[]

Property Value

DocumentFormula[]

height

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

height?: number

Property Value

number

lines

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

lines?: DocumentLine[]

Property Value

DocumentLine[]

pageNumber

1-based page number in the input document.

pageNumber: number

Property Value

number

selectionMarks

Extracted selection marks from the page.

selectionMarks?: DocumentSelectionMark[]

Property Value

DocumentSelectionMark[]

spans

Location of the page in the reading order concatenated content.

spans: DocumentSpan[]

Property Value

DocumentSpan[]

unit

The unit used by the width, height, and polygon properties. For images, the unit is "pixel". PDF, the unit is "inch".

unit?: string

Property Value

string

width

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

width?: number

Property Value

number

words

Extracted words from the page.

words?: DocumentWord[]

Property Value

DocumentWord[]