WriteIn
This element provides a blank field in which the respondent can hand write some text or draw a picture.
The hand-filled content of the write_in element is stored as an image during recognition and can be can be passed to optical character recognition API or saved.
WriteIn element can be used to request some information in free form (name, phone, address, and the like) or to offer a respondent answer an open-ended question.
Declaration
WriteIn element is declared as an object with "element_type": "WriteIn" property.
{
"element_type": "WriteIn"
}
Required properties
| Name | Type | Description |
|---|---|---|
| element_type | string | Must be "WriteIn" (case-insensitive). |
Optional properties
| Name | Type | Default value | Description |
|---|---|---|---|
| name | string | n/a | Used as a reminder of the element’s purpose; for example, “Phone”. You can use the same value for multiple elements. This text is not displayed on the form. |
| required | Boolean | false | Set to true to store the element’s content during recognition. Set to false or omit the attribute to ignore this element during recognition. |
| hint | string | “write-in” | Redefine the underlying label of the write-in element. |
| color | string | black | Color of the underlying label text. Can be picked from one of the supported values. |
| adaptive | Boolean | false | Set to true to fill the remaining height of the parent container with the write-in element. Set to false or omit the property to render the write-in element with the fixed height. See Adaptive write-in height for details. |
Adaptive write-in height
The adaptive property affects both the rendering height of the write-in element and the height of the handwriting / drawing capture area.
Combining with VerticalChoicebox elements
WriteIn element can be included into VerticalChoicebox element to give the respondent the opportunity to provide a free-form answer to an open-ended question.
In this case, the content of the element is stored only if the respondent marks the corresponding bubble.
Allowed child elements
None.
Example
{
"element_type": "Template",
"children": [
{
"element_type": "Page",
"children": [
{
"element_type": "Container",
"name": "Example",
"children": [
{
"element_type": "Block",
"children": [
{
"element_type": "Content",
"name": "Your phone number:",
"font_style": "bold"
},
{
"element_type": "WriteIn",
"name": "Phone",
"required": true
}
]
}
]
}
]
}
]
}
