Event Type
| Event Name | Version | Description |
|---|---|---|
릴리즈 2.1.0 이상 | This event occurs when the Editor is initialized. | |
릴리즈 2.2.0 이상 | This event occurs before an image is uploaded. | |
| afterUploadImage | 릴리즈 2.2.0 이상 | This event occurs after an image is uploaded. |
| beforeUploadVideo | 릴리즈 2.2.0 이상 | This event occurs before a video is uploaded. |
| afterUploadVideo | 릴리즈 2.2.0 이상 | This event occurs after a video is uploaded. |
| beforeUploadFile | 릴리즈 2.2.0 이상 | This event occurs before a file is uploaded. |
| afterUploadFile | 릴리즈 2.2.0 이상 | This event occurs after a file is uploaded. |
| beforeOpenDocument | 릴리즈 2.3.0 이상 | This event occurs before a document is opened (imported). |
| afterOpenDocument | 릴리즈 2.3.0 이상 | This event occurs after a document is opened (imported). |
| beforeNewDocument | 릴리즈 2.4.1 이상 | This event occurs before creating a new document. |
| afterNewDocument | 릴리즈 2.4.1 이상 | This event occurs after creating a new document. |
Adding Events
Using API
editor.setEventListener()
API used to add an event.
editor.setEventListener('Event Name', function(e) {
});
Adding at the Editor Initialization
var editorId = 'synapEditor';
var editorConfig = {};
var html = '';
var eventListeners = {
'Event Name': function (e) {
}
};
new SynapEditor(editorId, editorConfig, html, eventListeners);
Using Functions
var editorId = 'synapEditor';
var editorConfig = {};
var html = '';
function SynapEditorEvent Name(e) {
// The first letter of the event name shall be capitalized
// ex: initialized => SynapEditorInitialized
// ex: beforeUploadImage => SynapEditorBeforeUploadImage
}
new SynapEditor(editorId, editorConfig, html);
Removing Events
Using API
editor.removeEventListener()
API used to remove an event..
editor.removeEventListener('Event Name');
Object Delivered by Functions
{
editor: {Editor Object}, // Editor
eventType: 'initialized', // Event Name
cancelable: false, // Whether the event is cancelable
returnValue: null, // Return Value
....
}
- editor: Editor in which the event is occurred.
- eventType: Event name.
- cancelable: Whether the event is cancelable.
- returValue: Return value. As for cancelable events, the events can be cancelled by delivering (cancelable: true) false.
Cancelling Events
When cancelable is set to true, you may cancel the event by setting returnValue to false.
var editorId = 'synapEditor';
var editorConfig = {};
var html = '';
var eventListeners = {
'beforeUploadImage': function (e) {
e.returnValue = false; // Upload will be no longer proceed.
}
};
new SynapEditor(editorId, editorConfig, html, eventListeners);