Share via

DocumentTableCell Class

An object representing the location and content of a table cell.

Constructor

DocumentTableCell(*args: Any, **kwargs: Any)

Variables

Name Description
kind
str or DocumentTableCellKind

Table cell kind. Known values are: "content", "rowHeader", "columnHeader", "stubHead", and "description".
row_index
int

Row index of the cell. Required.
column_index
int

Column index of the cell. Required.
row_span
int

Number of rows spanned by this cell.
column_span
int

Number of columns spanned by this cell.
content
str

Concatenated content of the table cell in reading order. Required.
bounding_regions
list[BoundingRegion]

Bounding regions covering the table cell.
spans
list[DocumentSpan]

Location of the table cell in the reading order concatenated content. Required.
elements
list[str]

Child elements of the table cell.

Methods

as_dict

Return a dict that can be JSONify using json.dump.
clear
copy
get
items
keys
pop
popitem
setdefault
update
values

as_dict

Return a dict that can be JSONify using json.dump.

as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]

Keyword-Only Parameters

Name Description
exclude_readonly
bool

Whether to remove the readonly properties.

Default value: False

Returns

Type Description
dict

A dict JSON compatible object

clear 

clear() -> None

copy 

copy() -> Model

get 

get(key: str, default: Any = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

items 

items() -> ItemsView[str, Any]

keys 

keys() -> KeysView[str]

pop 

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

popitem 

popitem() -> Tuple[str, Any]

setdefault 

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Name Description
key
Required
default

update 

update(*args: Any, **kwargs: Any) -> None

values 

values() -> ValuesView[Any]

Attributes

bounding_regions

Bounding regions covering the table cell.

bounding_regions: List[_models.BoundingRegion] | None

column_index

Column index of the cell. Required.

column_index: int

column_span

Number of columns spanned by this cell.

column_span: int | None

content

Concatenated content of the table cell in reading order. Required.

content: str

elements

Child elements of the table cell.

elements: List[str] | None

kind

"content", "rowHeader", "columnHeader", "stubHead", and "description".

kind: str | _models.DocumentTableCellKind | None

row_index

Row index of the cell. Required.

row_index: int

row_span

Number of rows spanned by this cell.

row_span: int | None

spans

Location of the table cell in the reading order concatenated content. Required.

spans: List[_models.DocumentSpan]