Checkbox field

Add a checkbox field and control on which condition it should be checked. The checkbox style is currently limited to a cross.

Attributes

The field is rendered as a square. The bounding box height is determining the size of the square. The square is centered horizontally in the bounding box.

bbox.xrequired

X coordinate of the lower left corner of the bounding box of the field. Needs to be greater than or equal to 0.

bbox.yrequired

Y coordinate of the lower left corner of the bounding box of the field. Needs to be greater than or equal to 0.

bbox.widthrequired

Width of the bounding box of the field. Needs to be greater or equal to 1.

bbox.heightrequired

Height of the bounding box of the field. Needs to be greater or equal to 1.

The units of the bounding box are points. They are mainly driven by the page size and resolution of the underlying PDF document. For example an A4 page with width of 210 mm and height of 297 mm and a default resolution of 72 DPI results in a page width of 595.27 and height of 841.88 pts. The root coordinate (0, 0) is the lower left corner of the page.

namerequired

Key name of the field. This is going to be the key for populating the value when filling the template. This key name can be used multiple times, every occurrence of the key will be filled with the same value. Caution: do not mix field types.

pagerequired

The index of the page the field is residing on, starting with 0. Upper limit is the number of pages in the template

requiredoptional

Is the key required in the payload when filling the PDF. Default is true.

typerequired

Identifier of the type of the field. Always set to check.

evalrequired

String or boolean value to evaluate against if the checkbox is checked. E.g. the check box is checked if the equal boolean value is provided or if the string is matching with te value of the field. A string must be longer than 1 character and the evaluation is case sensitive.

{
    "bbox": {
        "x": 72.15405575993107,
        "y": 556.1774688664345,
        "width": 201.3371400656083,
        "height": 11.637984974890685
    },
    "name": "key",
    "page": 0,
    "required": true,
    "type": "check",
    "eval": true
}

Radio groups

Create a radio group by combining multiple checkbox fields with the same name and different evaluations. An example radio group for a binary question will result in the options true (yes) and false (no). It can be achieved by creating two checkbox fields with eval true and false on the same name e.g. question_yn.