FieldData Class

Contains the data for the form field. This includes the text, location of the text on the form, and a collection of the elements that make up the text.

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

FieldData

Constructor

FieldData(**kwargs: Any)

Methods

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

from_dict

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

from_dict(data: Dict) -> FieldData

Parameters

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

Returns

Type	Description
FieldData	FieldData

to_dict

Returns a dict representation of FieldData.

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]

field_elements

When include_field_elements is set to true, a list of elements constituting this field or value is returned. The list constitutes of elements such as lines, words, and selection marks.

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

page_number

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

page_number: int

text

The string representation of the field or value.

text: str