FieldSetting
A FieldSetting defines the signing field settings within a task. The task owner can set up one or more FieldSetting elements for each stage of a task, providing signers with fields to fill in during the signing process.
FieldSetting primarily consists of three attributes, which are field type, field coordinates, and field options.
Field Type
| Field Type | Description |
|---|---|
signature | A signature field. Signers can apply their pre-established signatures, stamps, or organizational seals. |
textfield | A text field. Signers can enter text. |
datefield | A date field. Signers can enter a date. |
checkbox | A checkbox field. Signers can select one or more checkboxes from a checkbox group. |
radio | A radio button field. Signers can select one option from a radio group. |
image | An image field. Signers can upload an image and apply it. |
link | A hyperlink field. Signers can enter an URL, and the exported PDF will display it as an hyperlink. |
Field Coordinates
The FieldSetting's coordinates are based on a system where the bottom-left corner serves as the origin. This system uses points (pt) as the unit of measurement, with 72 pixels per point. The position of a field is denoted by four numbers: [x-axis of the bottom-left corner, y-axis of the bottom-left corner, x-axis of the top-right corner, y-axis of the top-right corner].
For an A4 size page, the dimensions are approximately 595.28 pt (width) by 841.89 pt (height). As illustrated in the diagram below, coordinates are represented in the format [x1, y1, x2, y2], providing a precise location for each field within the document.
Field Options
FieldSetting provides numerous options for each file type. Please refer to the Create SignTask API for more details.
FieldSettingGroup
FieldSettingGroup binds multiple FieldSettings into a group, currently utilized only for checkbox and radio fields. In DottedSign API, all checkbox and radio FieldSettings must be assigned a user-defined field_group_object_id. Additionally, FieldSettingGroup provides its own set of options. Please refer to the Create SignTask API for more details.
Updated 16 days ago