Skip to main content

RenderBitmap

Renders an image of the signature. Optionally encodes the SigObj in the generated image using steganographic techniques.

ParameterDescription
Will InkCanvasInking canvas for rendering the image using Wacom WILL Ink SDK. If this value is null, the image is rendered using a common JavaScript canvas.
widthint value indicating the width specified as DPI (dots per inch) or Pixels. Negative value = DPI (the signature is not scaled). Positive value = Pixels (the signature is scaled to fit the area).
heightint value indicating the height specified as DPI (dots per inch) or Pixels. Negative value = DPI (the signature is not scaled). Positive value = Pixels (the signature is scaled to fit the area).
mimeType

String specifying the image format as one of:

  • image/png
  • image/jpeg
inkWidthfloat value with the signature ink width in pixels. This is only valid when using a standard JavaScript canvas. When using WILL Ink canvas, this value is ignored.
inkColorString with the signature ink colour.
inkBackgroundString with the image background colour.
paddingX, paddingY

float values with the padding around the signature image, added to both the left and the right for paddingX, and both the top and bottom for paddingY. Dimensions are specified as mm or pixels.

  • Negative value = mm.
  • Positive value = pixels.
Flagsint value with a combination of the following values (a single value from each mandatory group must be included):

Image extension (optional):

0x400000 (RenderEncodeData) – Encode signature data within image (only valid for png type)

Other (optional):

0x1000000 (RenderClipped) – Crop signature image, omitting any parts which were outside of the original capture window.

0x2000000 (RenderRelative) – Renders the signature image relative to the origin of the original capture window. (Dimensions must be equal DPI (negative) values; padding values must be 0)

Return values
The function returns a promise that resolves to an image URL (String) when it succeeds or raises an exception if false.