FormLine Class

An object representing an extracted line of text.

New in version v2.1: appearance property, support for to_dict and from_dict methods

Inheritance

azure.ai.formrecognizer._models.FormElement

FormLine

Constructor

FormLine(**kwargs: Any)

Methods

from_dict	Converts a dict in the shape of a FormLine to the model itself.
to_dict	Returns a dict representation of FormLine.

from_dict

Converts a dict in the shape of a FormLine to the model itself.

from_dict(data: Dict) -> FormLine

Parameters

Name	Description
data Required	dict A dictionary in the shape of FormLine.

Returns

Type	Description
FormLine	FormLine

to_dict

Returns a dict representation of FormLine.

to_dict() -> Dict

Returns

Type	Description
dict	dict

Attributes

appearance

An object representing the appearance of the line.

appearance: TextAppearance

bounding_box

A list of 4 points representing the quadrilateral bounding box that outlines the text. The points are listed in clockwise order: top-left, top-right, bottom-right, bottom-left. Units are in pixels for images and inches for PDF.

bounding_box: List[Point]

kind

For FormLine, this is "line".

kind: str

page_number

The 1-based number of the page in which this content is present.

page_number: int

text

The text content of the line.

text: str

words

A list of the words that make up the line.

words: List[FormWord]