FormElement Class

Base type which includes properties for a form element.

New in version v2.1: Support for to_dict and from_dict methods

Inheritance

builtins.object

FormElement

Constructor

FormElement(**kwargs: Any)

Methods

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

from_dict

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

from_dict(data: Dict) -> FormElement

Parameters

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

Returns

Type	Description
FormElement	FormElement

to_dict

Returns a dict representation of FormElement.

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]

kind

The kind of form element. Possible kinds are "word", "line", or "selectionMark" which correspond to a FormWord FormLine, or FormSelectionMark, respectively.

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

text: str