Events
This page details the events available in Annotations API.
Annotations API provides methods which provide the ability to bind callback functions to particular events, usually triggered by user actions, or specific events occurring in an Annotations element.
On this page:
Events
- drawing:changeTool
- drawing:enterDrawingMode
- drawing:exitDrawingMode
- drawing:hide
- drawing:show
- notepad:setVisibility
- notepad:toggleVisibility
- stickynote:add
- stickynote:remove
- texthighlight:add
- texthighlight:remove
Examples >>
Event name | Description | Event data |
---|---|---|
drawing:changeTool
|
Notifies you when the drawing tool changes state. Returns the name of the drawing tool in use. |
|
drawing:enterDrawingMode
|
Notifies you when drawing mode has been entered. |
|
drawing:exitDrawingMode
|
Notifies you when drawing mode has been exited. |
|
drawing:hide
|
Notifies when drawings have been hidden. |
|
drawing:show
|
Notifies when drawings have been shown. |
|
notepad:setVisibility
|
Notifies you when setVisibility is called on the notepad module. |
|
notepad:toggleVisibility
|
Notifies you when toggleVisibility is called on the notepad module. |
|
stickynote:add
|
Triggered when a sticky note is created. Returns the payloadData object for the sticky note, containing the variables listed. Version added: v2018.2.LTS |
|
stickynote:remove
|
Triggered when a sticky note is removed. |
|
texthighlight:add
|
Triggered whenever a text highlight is added. |
|
texthighlight:remove
|
Triggered whenever a text highlight is removed. |
|
Examples
drawing:changeTool
annotationsApp.on('drawing:changeTool', function () {
console.log('The current drawing tool is: ' + annotationsApp.module('drawing').getDrawingTool());
});
drawing:enterDrawingMode
annotationsApp.on('drawing:enterDrawingMode', function () {
console.log('We are now in drawing mode.');
});
drawing:exitDrawingMode
annotationsApp.on('drawing:exitDrawingMode', function () {
console.log('We have left drawing mode.');
});
drawing:hide
annotationsApp.on('drawing:hide', function () {
console.log('Drawings are now hidden.');
});
drawing:show
annotationsApp.on('drawing:show', function () {
console.log('Drawings are now showing.');
});
notepad:setVisibility
annotationsApp.on('notepad:setVisibility', function () {
console.log('Notepad visibility has been set to: ' + annotationsApp.module('notepad').isVisible());
});
notepad:toggleVisibility
annotationsApp.on('notepad:toggleVisibility', function () {
console.log('Notepad visibility changed to: ' + annotationsApp.module('notepad').isVisible());
});
stickynote:add
annotationsApp.on('stickynote:add', function (payloadData) {
console.log('Added a Sticky Note with an ID of ' + payloadData.id);
});
stickynote:remove
annotationsApp.on('stickynote:remove', function (payloadData) {
console.log('Removed a Sticky Note with an ID of ' + payloadData.id);
});
texthighlight:add
annotationsApp.on('texthighlight:add', function (textHighlightInfo) {
var textHighlightModule = annotationsApp.module('texthighlight');
var id = textHighlightInfo.id;
var startElement = textHighlightModule.utils.deserializePath(
textHighlightInfo.startContainerPath,
textHighlightInfo.startOffset,
);
var endElement = textHighlightModule.utils.deserializePath(
textHighlightInfo.endContainerPath,
textHighlightInfo.endOffset,
);
console.log('The text selection with id ' + id + ' ranges between:', startElement, endElement);
});
texthighlight:remove
annotationsApp.on('texthighlight:remove', function (textHighlightInfo) {
console.log('Text highlight with id ' + textHighlightInfo.id + ' was removed.');
});