$on(name, listener);
Listens on events of a given type. See $emit for discussion of event life cycle.
The event listener function format is: function(event, args...)
. The event
object passed into the listener has the following attributes:
-
targetScope
-{Scope}
: the scope on which the event was$emit
-ed or$broadcast
-ed. -
currentScope
-{Scope}
: the scope that is currently handling the event. Once the event propagates through the scope hierarchy, this property is set to null. -
name
-{string}
: name of the event. -
stopPropagation
-{function=}
: callingstopPropagation
function will cancel further event propagation (available only for events that were$emit
-ed). -
preventDefault
-{function}
: callingpreventDefault
setsdefaultPrevented
flag to true. -
defaultPrevented
-{boolean}
: true ifpreventDefault
was called.
Parameters
Param | Type | Details |
---|---|---|
name | string | Event name to listen on. |
listener | function(event, ...args) | Function to call when the event is emitted. |
Returns
function() |
Returns a deregistration function for this listener. |
Please login to continue.