Signature Pad Question Schema Properties
A question that captures a handwritten signature.
Element type: signaturepad
Key properties: 16
Generation Hints
Section titled “Generation Hints”- Aliases: signature, e-signature, drawn signature.
- Use when: respondents need to provide a handwritten signature.
- Recommended properties:
type,name,title,signatureWidth,signatureHeight,isRequired.
{ "type": "signaturepad", "name": "signature", "title": "Sign here", "isRequired": true }Key Properties
Section titled “Key Properties”signatureWidth
Section titled “signatureWidth”- Type:
number - Default:
300
Specifies the width of the signature area. Accepts positive integer numbers.
signatureHeight
Section titled “signatureHeight”- Type:
number - Default:
200
Specifies the height of the signature area. Accepts positive integer numbers.
signatureAutoScaleEnabled
Section titled “signatureAutoScaleEnabled”- Type:
boolean - Default:
false
Specifies whether the signature area should be scaled to fit into the question width.
backgroundColor
Section titled “backgroundColor”- Type:
color - Default:
—
Specifies a color for the signature area background. Ignored if backgroundImage is set.
backgroundImage
Section titled “backgroundImage”- Type:
file - Default:
—
An image to display in the background of the signature area. Accepts a base64 or URL string value.
penColor
Section titled “penColor”- Type:
color - Default:
—
Specifies a color for the pen.
penMinWidth
Section titled “penMinWidth”- Type:
number - Default:
0.5
Speicifies the minimum width of pen strokes, measured in pixels.
penMaxWidth
Section titled “penMaxWidth”- Type:
number - Default:
2.5
Speicifies the maximum width of pen strokes, measured in pixels.
dataFormat
Section titled “dataFormat”- Type:
string - Default:
"png" - Allowed values:
png,jpeg,svg
Specifies the format in which to store the signature image.
placeholder
Section titled “placeholder”- Type:
text - Default:
— - Localizable: Yes
A placeholder text for the signature area. Applies when the showPlaceholder property is true.
placeholderReadOnly
Section titled “placeholderReadOnly”- Type:
text - Default:
— - Localizable: Yes
A placeholder text for the signature area in read-only or preview mode. Applies when the showPlaceholder property is true.
showPlaceholder
Section titled “showPlaceholder”- Type:
boolean - Default:
true
A Boolean value that specifies whether to show the placeholder text in the signature area.
showNumber
Section titled “showNumber”- Type:
boolean - Default:
true
Specifies whether to show a number for this question. Setting this property to false hides the question number from the title and excludes the question from numbering.
storeDataAsText
Section titled “storeDataAsText”- Type:
boolean - Default:
true
Specifies whether to store file or signature content as text in SurveyModel’s data property.
waitForUpload
Section titled “waitForUpload”- Type:
boolean - Default:
false
Enable this property if you want to wait until files are uploaded to complete the survey.
allowClear
Section titled “allowClear”- Type:
boolean - Default:
true
Specifies whether to display a button that clears the signature area.
Shared Properties
Section titled “Shared Properties”This page lists only properties that are specific to this element type or especially important for generation.
- Use Shared Question Properties for common fields such as
name,title,description,isRequired,requiredIf,visibleIf,enableIf,readOnly,defaultValue,validators,width, and layout options.