FormTable Class

Information about the extracted table contained on a page.

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

Inheritance
builtins.object
FormTable

Constructor

FormTable(**kwargs)

Variables

page_number
int

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

cells
list[FormTableCell]

List of cells contained in the table.

row_count
int

Number of rows in table.

column_count
int

Number of columns in table.

bounding_box
list[Point]

A list of 4 points representing the quadrilateral bounding box that outlines the table. 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.

Methods

from_dict

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

to_dict

Returns a dict representation of FormTable.

from_dict

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

from_dict(data: dict) -> azure.ai.formrecognizer._models.FormTable

Parameters

data
dict
Required

A dictionary in the shape of FormTable.

data
Required

Returns

FormTable

Return type

to_dict

Returns a dict representation of FormTable.

to_dict() -> dict

Returns

dict

Return type