-
<static> setInitialsTextHandler(initialsTextHandler)
-
Parameters:
| Name |
Type |
Description |
initialsTextHandler |
function
|
A function that should return a string that will be used as the "Initials" text when the widget requires initials |
-
<static> setTextHandler(textHandler)
-
Parameters:
| Name |
Type |
Description |
textHandler |
function
|
A function that should return a string that will be used as the "sign here" text |
-
addEventListener(type, fn [, options])
-
Add a handler to the given event name
Parameters:
| Name |
Type |
Argument |
Description |
type |
string
|
number
|
|
The name of the event to listen to |
fn |
function
|
|
The handler to be called when the event is triggered |
options |
object
|
<optional>
|
Optional options object for addEventListener
Properties
| Name |
Type |
Description |
once |
boolean
|
If true then the handler will be called only once |
|
- Inherited From:
-
Returns:
Returns the object that 'addEventListener' is being called on
-
Type
-
object
Example
myObject.addEventListener('eventName', (eventParameter1, eventParameter2) => {
...
});
-
addInitials()
-
Returns:
A promise that resolves when the intials are added to the document
-
Type
-
Promise.<void>
-
addSignature()
-
Returns:
A promise that resolves when the signature is added to the document
-
Type
-
Promise.<void>
-
clearInitialsCanvas()
-
Clears the initials canvas and the underlying annotation
-
clearLocation()
-
Clear the location which is set when a mouse click is performed
-
clearSignatureCanvas()
-
Clears the signature canvas and the underlying annotation
-
-
The function is called when a context menu should be shown.
Use e.preventDefault to disable the default browser context menu.
Parameters:
| Name |
Type |
Description |
e |
|
The event object |
- Inherited From:
-
-
deleteSavedInitials(index)
-
Delete an initials annotation in the tool
Parameters:
| Name |
Type |
Description |
index |
number
|
The index of the saved initials annotation to be deleted |
-
deleteSavedSignature(index)
-
Delete a full signature annotation in the tool
Parameters:
| Name |
Type |
Description |
index |
number
|
The index of the saved annotation to be deleted |
-
exportInitials()
-
Exports all saved initials as an array
The array can be stringified using JSON.stringify and saved for later use
Returns:
Returns a promise that resolves an array that contains arrays of path points or a base64 image data
-
Type
-
Promise.<Array.<(string|Array.<Array.<Core.Math.Point>>)>>
-
exportSignatures()
-
Exports all saved signatures as an array
The array can be stringified using JSON.stringify and saved for later use
Returns:
Returns a promise that resolves an array that contains arrays of path points or a base64 image data
-
Type
-
Promise.<Array.<(string|Array.<Array.<Core.Math.Point>>)>>
-
getDocumentViewer()
-
Returns the instance of DocumentViewer for this tool.
- Inherited From:
-
Returns:
The instance of DocumentViewer for this tool.
-
Type
-
Core.DocumentViewer
-
getFullSignatureAnnotation()
-
Returns the annotation used as a full signature
Returns:
a signature annotation
-
Type
-
Core.Annotations.FreeHandAnnotation
|
Core.Annotations.StampAnnotation
-
getInitialsAnnotation()
-
Returns the annotation used as initials
Returns:
an initials annotation
-
Type
-
Core.Annotations.FreeHandAnnotation
|
Core.Annotations.StampAnnotation
-
getMouseLocation(e)
-
Takes an event object from a mouse event and converts the location into window coordinates
Parameters:
| Name |
Type |
Description |
e |
|
The event object containing mouse coordinates |
- Inherited From:
-
Returns:
Returns an object with x and y coordinates of the mouse cursor in the viewer
-
Type
-
Core.Math.Point
-
getPreview(annotation)
-
Gets the preview about how the annot will be drawn on the document
Parameters:
Returns:
A promise that resolves with a base64 string of the preview image
-
Type
-
Promise.<string>
-
getSavedInitials()
-
Returns the array of saved annotations used as initials
Returns:
an array of annotations
-
Type
-
Array.<(Core.Annotations.FreeHandAnnotation|Core.Annotations.StampAnnotation)>
-
getSavedSignatures()
-
Returns the array of saved annotations used as full signatures
Returns:
an array of annotations
-
Type
-
Array.<(Core.Annotations.FreeHandAnnotation|Core.Annotations.StampAnnotation)>
-
getSigningMode()
-
Gets the current signing mode.
Returns:
Returns the current signing mode;
-
Type
-
Core.Tools.SignatureCreateTool.SigningModes
-
hasLocation()
-
Returns if the signature tool has any location to draw the signature
Returns:
-
Type
-
boolean
-
hidePreview()
-
Hide the preview element
-
importInitials(initialsData)
-
Loads initials data into the signature tool
Parameters:
| Name |
Type |
Description |
initialsData |
Array.<(string|Array.<Array.<Core.Math.Point>>)>
|
An array contains arrays of path points or base64 image data
If the element is a string, a stamp annotation will be saved and the string will be the value of its ImageData property
If the element is an array of objects, a freehand annotation will be saved and the array will be its paths |
Returns:
Promise Resolves when the initials data has been loaded
-
importSignatures(signatureData)
-
Loads signature data into the signature tool
Parameters:
| Name |
Type |
Description |
signatureData |
Array.<(string|Array.<Array.<Core.Math.Point>>)>
|
An array contains arrays of path points or base64 image data
If the element is a string, a stamp annotation will be saved and the string will be the value of its ImageData property
If the element is an array of objects, a freehand annotation will be saved and the array will be its paths |
Returns:
Promise
-
isEmptyInitialsSignature()
-
Checks if the initials set in the tool are empty.
If the underlying annotation is a freehand, it's empty if it doesn't have any paths
If the underlying annotation is a stamp, it's empty if its ImageData property has a falsy value
Returns:
If number of drawn paths is 0.
-
Type
-
Promise.<boolean>
-
isEmptySignature()
-
Checks if the underlying annotation is empty.
If the underlying annotation is a freehand, it's empty if it doesn't have any paths
If the underlying annotation is a stamp, it's empty if its ImageData property has a falsy value
Returns:
If number of drawn paths is 0.
-
Type
-
Promise.<boolean>
-
keyDown(e)
-
The function is called when a keyboard key is down.
Parameters:
| Name |
Type |
Description |
e |
|
The event object containing keyboard key data. |
- Inherited From:
-
-
mouseDoubleClick(e)
-
The function is called when the mouse left button is double clicked.
Parameters:
| Name |
Type |
Description |
e |
|
The event object containing mouse coordinates. |
- Inherited From:
-
-
mouseLeftDown(e)
-
The function called when the left mouse button is down
Parameters:
| Name |
Type |
Description |
e |
|
The event object containing mouse coordinates. |
- Inherited From:
-
-
mouseLeftUp(e)
-
The function called when the left mouse button is up.
Typically, annotations are created and added to the annotation manager at this point.
Parameters:
| Name |
Type |
Description |
e |
|
The event object containing mouse coordinates. |
- Inherited From:
-
-
mouseMove(e)
-
The function called when the mouse moves.
Parameters:
| Name |
Type |
Description |
e |
|
The event object containing mouse coordinates. |
- Inherited From:
-
-
mouseRightDown(e)
-
The function called when the right mouse button is down.
Parameters:
| Name |
Type |
Description |
e |
|
The event object containing mouse coordinates. |
- Inherited From:
-
-
off( [type] [, fn])
-
Remove a handler of the given event name
Parameters:
| Name |
Type |
Argument |
Description |
type |
string
|
number
|
<optional>
|
The name of the event to remove the handler of.
If type is undefined, all the handlers of the object will be removed |
fn |
function
|
<optional>
|
The handler associated with this event to be removed.
If fn is undefined, all the handlers of the given event name will be removed |
- Inherited From:
-
- Deprecated:
-
Returns:
Returns the object that 'off' is being called on
-
Type
-
object
Example
myObject.off();
myObject.off('eventName');
myObject.off('eventName', fn);
-
on(type, fn)
-
Add a handler to the given event name
Parameters:
| Name |
Type |
Description |
type |
string
|
number
|
The name of the event to listen to |
fn |
function
|
The handler to be called when the event is triggered |
- Inherited From:
-
- Deprecated:
-
Returns:
Returns the object that 'on' is being called on
-
Type
-
object
Example
myObject.on('eventName', (eventParameter1, eventParameter2) => {
...
});
-
one(type, fn)
-
Same as 'on' except the handler will be called only once
Parameters:
| Name |
Type |
Description |
type |
string
|
number
|
The name of the event to listen to |
fn |
function
|
The handler to be called when the event is triggered |
- Inherited From:
-
- Deprecated:
-
Returns:
Returns the object that 'one' is being called on
-
Type
-
object
Example
myObject.one('eventName', (eventParameter1, eventParameter2) => {
...
});
-
removeEventListener( [type] [, fn])
-
Remove a handler of the given event name
Parameters:
| Name |
Type |
Argument |
Description |
type |
string
|
number
|
<optional>
|
The name of the event to remove the handler of.
If type is undefined, all the handlers of the object will be removed |
fn |
function
|
<optional>
|
The handler associated with this event to be removed.
If fn is undefined, all the handlers of the given event name will be removed |
- Inherited From:
-
- Deprecated:
-
- for version 9.0. Use [removeEventListener] with fn specified
Returns:
Returns the object that 'removeEventListener' is being called on
-
Type
-
object
Example
myObject.removeEventListener();
myObject.removeEventListener('eventName');
myObject.removeEventListener('eventName', fn);
-
resizeCanvas()
-
Resize the current signature canvas
-
saveInitials(annotations)
-
Save an array of freehand or stamp annotations to the signature tool as initials
Parameters:
-
saveSignatures(annotations)
-
Save an array of freehand or stamp annotations to the signature tool
Parameters:
-
setDefaultSignatureOptions(options)
-
Sets the default options for signatures created with the signature tool.
Parameters:
| Name |
Type |
Description |
options |
object
|
Signature options that should become the default
Properties
| Name |
Type |
Description |
maximumDimensionSize |
number
|
The maximum size of the signature's largest dimension. Default is 200. |
|
-
setInitials(annotation [, fileSize])
-
Sets the underlying annotation used by the tool as initials
If a base64 string is passed, the underlying annotation will be a stamp annotation with the string being its ImageData
Parameters:
Returns:
A promise that will resolve when the initials are set in the tool
-
Type
-
Promise.<void>
-
setInitialsCanvas(canvas)
-
Sets the canvas to be used by the signature tool for initials.
Parameters:
| Name |
Type |
Description |
canvas |
HTMLCanvasElement
|
The canvas that the signature tool uses to draw initials on. |
-
setName(name)
-
Set the name of the tool, which can be accessed by toolObject.name
Parameters:
| Name |
Type |
Description |
name |
string
|
Name of the tool |
- Inherited From:
-
-
setSignature(annotation [, fileSize])
-
Sets the underlying annotation used by the tool as a full signature
If a base64 string is passed, the underlying annotation will be a stamp annotation with the string being its ImageData
Parameters:
Returns:
A promise that will resolve when the signature is set in the tool
-
Type
-
Promise.<void>
-
setSignatureCanvas(canvas)
-
Sets the canvas to be used by the signature tool for full signatures.
Parameters:
| Name |
Type |
Description |
canvas |
HTMLCanvasElement
|
The canvas that the signature tool uses to draw on. |
-
setSigningMode(signingMode)
-
Sets the signing mode for the tool
Parameters:
| Name |
Type |
Description |
signingMode |
Core.Tools.SignatureCreateTool.SigningModes
|
The signing mode to select |
signingModes.appearance |
string
|
Sets the Signature Tool to sign with appearance mode intended for use with digital signatures |
Example
WebViewer(...).then(instance => {
const tool = instance.Core.documentViewer.getTool('AnnotationCreateSignature');
tool.setSigningMode(instance.Core.Tools.SignatureCreateTool.SigningModes.APPEARANCE);
})
-
setStyles(newStyles)
-
Set the style for the tool, which will be applied to annotations drawn afterwards
Parameters:
| Name |
Type |
Description |
newStyles |
object
|
function
|
if an object is used, it should contain properties of the new styles.
If a function is used, the current styles will be passed as its argument and the function should return an object which contains properties of the new styles.
Example of valid properties: StrokeColor, TextColor, FillColor, FontSize, Opacity, StrokeThickness, Precision, Scale, OverlayText, Style and Dashes. |
- Inherited From:
-
-
showInitialsPreview()
-
Shows the preview about how the underlying annot looks like if it's drawn.
Returns:
A promise that resolves when the preview is appended to the DOM and shown in the viewer
-
Type
-
Promise.<void>
-
showPreview()
-
Shows the preview about how the underlying annot looks like if it's drawn.
Returns:
A promise that resolves when the preview is appended to the DOM and shown in the viewer
-
Type
-
Promise.<void>
-
switchIn(oldTool)
-
The function is called when this tool is selected.
Typically use for changing mouse cursors, and initializing states for the tool.
Parameters:
| Name |
Type |
Description |
oldTool |
Core.Tools.Tool
|
The Tool class that was previously selected. |
- Inherited From:
-
-
switchOut(newTool)
-
The function is called when this tool is deselected.
Typically use for changing mouse cursors, and cleaning up states for the tool.
Parameters:
| Name |
Type |
Description |
newTool |
Core.Tools.Tool
|
The Tool class that was newly selected. |
- Inherited From:
-
-
trigger(type [, data])
-
Calls the handlers of the event name with given data
Parameters:
| Name |
Type |
Argument |
Description |
type |
string
|
number
|
|
event name of which the handlers will be called. |
data |
*
|
<optional>
|
data that will be passed to the handlers.
If data is an array, it will be spread and then passed to the handlers |
- Inherited From:
-
Returns:
Returns the object that 'trigger' is being called on
-
Type
-
object
Example
myObject.trigger('eventName');
myObject.trigger('eventName', [eventParameter1, eventParameter2]);