SignatureModel

Interface representing the signature class.

Properties

backgroundColor String

Specifies the background color, in either a hex, rgb and text value, of the control.

Default: ""

backgroundImage String

Specifies the background image of the control.

Default: ""

enabled Boolean

Specifies whether the textbox is enabled or not.

Default: true

enableRtl Boolean

Specifies whether to render the control in right to left direction.

Default: false

enableState Boolean

Specifies whether to persist the state of the control between page loads.

The following properties will be saved to state.
  • signatureValue

Default: false

locale String

Specifies the culture and localization value for this control, overriding the globally defined value.

Default: en-US

maxStrokeWidth Number

Specifies the maximum thickness of the stroke. The stroke is calculated by using the velocity, minStrokeWidth and maxStrokeWidth.

Default: 3

minStrokeWidth Number

Specifies the minimum thickness of the stroke. The stroke is calculated by using the velocity, minStrokeWidth and maxStrokeWidth.

Default: 0.5

readonly Boolean

Specifies whether the control is readonly disabling all user interaction with the control.

Default: false

saveWithBackground Boolean

Specifies whether to save the background color and background image with the saved image.

Default: false

strokeColor String

Specifies the stroke color, in either a hex, rgb and text value, of the signature.

Default: 1

velocity Number

Specifies the velocity of the stroke to calculate the thickness based on the pressure of the contact on the surface. The stroke is calculated by using the velocity, minStrokeWidth and maxStrokeWidth.

Default: 0.7

Events

beforeSave EmitType<SignatureBeforeSaveEventArgs>

Event callback that is raised before saving the signature only when using (ctrl + s).

change EmitType<SignatureChangeEventArgs>

Event callback that is raised when the actions undo, redo, clear and user completed signing occur.

created EmitType<CreatedEventArgs>

Event callback that is raised when the control has been created.