$rootScope.Scope.$on()

$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=}: calling stopPropagation function will cancel further event propagation (available only for events that were $emit-ed).
  • preventDefault - {function}: calling preventDefault sets defaultPrevented flag to true.
  • defaultPrevented - {boolean}: true if preventDefault 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.

doc_AngularJS
2016-03-29 16:10:40
Comments
Leave a Comment

Please login to continue.