capture-signature
Version compatibility
The
capture-signature component was visually updated in version 4.74.0 of the JourneyApps Runtime.Allows users to capture a signature digitally.
Signatures are captured as SVG's with a path that describes it. That path can be accessed using toText():
// Get the SVG text of the signature as XML
// Assuming the name of the signature is `captured_sig`
var signatureSVG = view.captured_sig.toText();
Signatures can also be printed using a Zebra bluetooth printer (see docs) directly from version 4.34.4 of the JourneyApps Container. The Zebra printer uses a language called ZPL, so we can convert the signature to ZPL by using:
// Get the SVG text of the signature as ZPL
// Assuming the name of the signature is `captured_sig`
var signatureSVG = view.captured_sig.toZPL();
<var name="my_signature" type="signature" />
<capture-signature label="Add a signature" bind="my_signature" required="true" />
Version compatibility
dialog-title was introduced in version 4.88.0 of the JourneyApps Runtime.Optional
Default: "Sign here"
Override the title that is displayed at the top of the dialog when capturing a signature.
main.view.xml
<capture-signature label="Add a signature" bind="my_signature" dialog-title="Custodian signature" required="true" />
Optional
Type:
booleanDefault:
falseSpecify whether the signature preview should span the full width of the available screen space.
capture-signature
display-signature
<capture-signature bind="authorization_sig" label="Authorized" fullwith="true"/>
<capture-signature bind="authorization_sig" label="Authorized" fullwith="true"/>
Version compatibility
icon-position was introduced in version 4.86.1 of the JourneyApps Runtime.Version compatibility
label-case was introduced in version 4.80.0 of the JourneyApps Runtime.Version compatibility
orientationwas introduced in version 4.88.0 of the JourneyApps Runtime and is supported on mobile platforms: Android and iOS.- Container version 23.5.1 or later is required for this feature on iOS, and is recommended for Android.
Optional
Type:
auto | landscape | portraitDefault:
autoLock the orientation of the draw-pad for capturing a signature.
When
orientation is set to landscape or portrait, the draw-pad will always display in the specified orientation, regardless of the orientation of the device. When orientation is set to auto, or not specified, the orientation of the draw-pad mirrors the orientation of the device.The following component methods are available when an
id is assigned to the component and component.captureSignature({id:'my-id'}) / component.displaySignature({id:'my-id'}) is called from JS/TS:Programmatically open the signature dialog that allows the user to sign.
try {
component.captureSignature({id: 'my-id'}).captureMedia();
} catch (e) {
// handle exception here
}
Programmatically close the signature preview.
capture-signature
display-signature
try {
component.captureSignature({id: 'my-id'}).closeMedia();
} catch (e) {
// handle exception here
}
try {
component.displaySignature({id: 'my-id'}).closeMedia();
} catch (e) {
// handle exception here
}
Programmatically clear a captured signature.
try {
component.captureSignature({id: 'my-id'}).deleteMedia();
} catch (e) {
// handle exception here
}
Programmatically open the signature preview.
capture-signature
display-signature
try {
component.captureSignature({id: 'my-id'}).openMedia();
} catch (e) {
// handle exception here
}
try {
component.displaySignature({id: 'my-id'}).openMedia();
} catch (e) {
// handle exception here
}
Programmatically scroll until the
capture-signature / display-signature component is visible in the view.capture-signature
display-signature
try {
component.captureSignature({id: 'my-id'}).scrollIntoView();
} catch (e) {
// handle exception here
}
try {
component.displaySignature({id: 'my-id'}).scrollIntoView();
} catch (e) {
// handle exception here
}
Last modified 3mo ago