Signature Pad
An input field to capture a signature and save it as an image. It can perform validation of required field and custom rules.
Properties
Available properties for Signature Pad with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read information about components.
The base64-encoded image of the captured signature.
Whether user input, interaction, or selection is disabled.
The message to display if no value is set.
The key used by a Form component to assign default values to input fields using form.initialData, and to construct the form.data property.
Whether the component is visible.
Whether to hide the validation message if the invalid is true.
Whether the current value has failed any validation rules.
The text to display as a label for the input field.
The horizontal alignment of the label.
The additional text to display with the label.
The position of the label relative to the input field.
The label width, in the unit specified in labelWidthUnit.
The specified units for labelWidth.
Whether the label can wrap to multiple lines.
Whether the component takes up space on the canvas if hidden is true.
The amount of margin to render outside of the component.
Whether the input is required for validation.
Whether the component remains visible in the editor if hidden is true.
Whether to display a button to clear the current value of the input field.
The text to display in a tooltip on hover or focus.
The validation message to display if the input is invalid.
Events
Events are triggered by user interactions with Signature Pad. Use event handling to trigger queries or other actions in response to events.
A user changes the current value.
Methods
Methods for interacting with Signature Pad. You can write JavaScript almost anywhere in Retool and use methods to manipulate data or components.
Clear the current value.
Scrolls the canvas or parent container so that the selected component appears in the visible area.
Validates the value of the input field.
Clear the validation message from the input field.
Set the hidden value to toggle whether the component is visible. Defaults to true without a parameter.
Set the disabled value to toggle whether the input field is disabled. Defaults to true without a parameter.
Reset value to the default value.
Set focus on the input field.
Removes focus on the input field.