Skip to content

Canvas-based input fields. The drawing.subType determines whether the field is a free drawing area or a signature pad.

Free drawing

Respondents draw on a canvas with an optional background image.

FieldTypeDescription
drawing.subType"freedrawing"Free-form drawing canvas
drawing.backgroundFileIdstringBackground image file ID from formFiles
drawing.isUserUploadBackgroundbooleanAllow respondents to upload their own background
{
  "_id": "6a0ef7d03affac35058b0683",
  "questionType": "drawing",
  "question": "Drawing",
  "displayOrder": 2,
  "isRequired": false,
  "isDeleted": false,
  "isActive": false,
  "drawing": {
    "subType": "freedrawing",
    "backgroundFileId": "0d37a3e0-550f-11f1-bf67-0242ac120005",
    "isUserUploadBackground": true
  }
}

Signature

A signature pad for capturing handwritten signatures.

FieldTypeDescription
drawing.subType"signature"Signature capture pad
drawing.lineColorstringStroke colour (hex)
{
  "_id": "6a0ef8513affac35058b0793",
  "questionType": "drawing",
  "question": "Signature",
  "displayOrder": 10,
  "isRequired": false,
  "isDeleted": false,
  "isActive": false,
  "drawing": {
    "subType": "signature",
    "lineColor": "#000"
  }
}