Namespace JXG.EventEmitter
↳ JXG.EventEmitter
Defined in: event.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Event namespace
|
| Field Attributes | Field Name and Description |
|---|---|
| <static> |
JXG.EventEmitter.eventHandlers
Holds the registered event handlers.
|
| <static> |
JXG.EventEmitter.suspended
Events can be suspended to prevent endless loops.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
JXG.EventEmitter.eventify(o)
Implements the functionality from this interface in the given object.
|
| <static> |
JXG.EventEmitter.off(event, handler)
Unregister an event handler.
|
| <static> |
JXG.EventEmitter.on(event, handler, context)
Register a new event handler.
|
| <static> |
JXG.EventEmitter.trigger(event, args)
Triggers all event handlers of this element for a given event.
|
Field Detail
<static>
{Object}
JXG.EventEmitter.eventHandlers
Holds the registered event handlers.
<static>
{Object}
JXG.EventEmitter.suspended
Events can be suspended to prevent endless loops.
Method Detail
<static>
JXG.EventEmitter.eventify(o)
Implements the functionality from this interface in the given object.
All objects getting their event handling
capabilities from this method should document it by adding
the on, off, triggerEventHandlers via the
borrows tag as methods to their documentation:
@borrows JXG.EventEmitter#on as this.on
- Parameters:
- {Object} o
<static>
JXG.EventEmitter.off(event, handler)
Unregister an event handler.
- Parameters:
- {String} event
- {Function} handler Optional
- Returns:
- Reference to the object.
<static>
JXG.EventEmitter.on(event, handler, context)
Register a new event handler. For a list of possible events see documentation
of the elements and objects implementing
the EventEmitter interface.
As of version 1.5.0, it is only possible to access the element via "this" if the event listener
is supplied as regular JavaScript function and not as arrow function.
- Parameters:
- {String} event
- {Function} handler
- {Object} context Optional
- The context the handler will be called in, default is the element itself.
- Returns:
- Reference to the object.
<static>
JXG.EventEmitter.trigger(event, args)
Triggers all event handlers of this element for a given event.
- Parameters:
- {Array} event
- {Array} args
- The arguments passed onto the event handler
- Returns:
- Reference to the object.