-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the svySignature wiki!
This wiki provides comprehensive documentation for using the svySignature web-component, which allows you to create a signature within Servoy's NGClient.
First import the component using one of the release binaries or via Servoy's Web Package Manager.
If you would like to see the component in an example install the included solution, svySignatureExample.servoy.
First add the component to a form by dragging it into the form using the Palette Wizard. It should be under svySignature (pad).
//Start by initializing the signature object.
//The onShow event will be used here to initialize when the form is displayed.
function onShow(firstShow, event) {
//initialize the component with a black pen color.
elements.pad.init({ penColor:'black' })
}
//when you want to save the signature, create a simple handler:
function onAction$save(event) {
var data = elements.pad.getDataUrl("image/png")
//data contains a base64 string of the signature.
}Setup the chart's data. (This will automatically initialize and draw the chart)
Params
| Type | Name | Summary | Required |
|---|---|---|---|
| Object | data | options object to customize the signature component | Optional |
Some of the options:
- dotSize : (float or function) Radius of a single dot.
- minWidth : (float) Minimum width of a line. Defaults to 0.5.
- maxWidth : (float) Maximum width of a line. Defaults to 2.5.
- throttle : (integer) Draw the next point at most once per every x milliseconds. Set it to 0 to turn off throttling. Defaults to 16.
- minDistance : (integer) Add the next point only if the previous one is farther than x pixels. Defaults to 5.
- backgroundColor : (string) Color used to clear the background. Can be any color format accepted by context.fillStyle.Defaults to "rgba(0,0,0,0)" (transparent black). Use a non-transparent color e.g. "rgb(255,255,255)" (opaque white) if you'd like to save signatures as JPEG images.
- penColor: (string) Color used to draw the lines. Can be any color format accepted by context.fillStyle. Defaults to "black".
- velocityFilterWeight : (float) Weight used to modify new velocity based on the previous velocity. Defaults to 0.7.
Clear the signature image pad.
Get signature image as base64 string.
Draw signature image with a base 64 string.
There two handlers which can detect when a user starts writing and when they are finished.