FormTableCell Class

  • Reference

Represents a cell contained in a table recognized from the input document.

New in version v2.1: FormSelectionMark is added to the types returned in the list of field_elements, support for to_dict and from_dict methods

Inheritance
builtins.object
FormTableCell

Constructor

FormTableCell(**kwargs: Any)

Methods

from_dict

Converts a dict in the shape of a FormTableCell to the model itself.
to_dict

Returns a dict representation of FormTableCell.

from_dict

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

from_dict(data: Dict) -> FormTableCell

Parameters

Name Description
data
Required
dict

A dictionary in the shape of FormTableCell.

Returns

Type Description
FormTableCell

FormTableCell

to_dict

Returns a dict representation of FormTableCell.

to_dict() -> Dict

Returns

Type Description
dict

dict

Attributes

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]

column_index

Column index of the cell.

column_index: int

column_span

Number of columns spanned by this cell.

column_span: int

confidence

Measures the degree of certainty of the recognition result. Value is between [0.0, 1.0].

confidence: float

field_elements

When include_field_elements is set to true, a list of elements constituting this cell is returned. The list constitutes of elements such as lines, words, and selection marks. For calls to begin_recognize_content(), this list is always populated.

field_elements: List[FormElement | FormWord | FormLine | FormSelectionMark]

Whether the current cell is a footer cell.

is_footer: bool

is_header

Whether the current cell is a header cell.

is_header: bool

page_number

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

page_number: int

row_index

Row index of the cell.

row_index: int

row_span

Number of rows spanned by this cell.

row_span: int

text

Text content of the cell.

text: str