Share via

DocumentFigure Class

An object representing a figure in the document.

Constructor

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

Variables

Name Description
bounding_regions
list[BoundingRegion]

Bounding regions covering the figure.
spans
list[DocumentSpan]

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

Child elements of the figure, excluding any caption or footnotes.
caption
DocumentCaption

Caption associated with the figure.
footnotes
list[DocumentFootnote]

List of footnotes associated with the figure.
id
str

Figure ID.

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 figure.

bounding_regions: List[_models.BoundingRegion] | None

caption

Caption associated with the figure.

caption: _models.DocumentCaption | None

elements

Child elements of the figure, excluding any caption or footnotes.

elements: List[str] | None

footnotes

List of footnotes associated with the figure.

footnotes: List[_models.DocumentFootnote] | None

id

Figure ID.

id: str | None

spans

Location of the figure in the reading order concatenated content. Required.

spans: List[_models.DocumentSpan]