Class: TrackerTask

TrackerTask

new TrackerTask()

TrackerTask utility.
Source:

Extends

Members

on

Adds a listener to the end of the listeners array for the specified event.
Inherited From:
Source:

Methods

addListener(event, listener) → {object}

Adds a listener to the end of the listeners array for the specified event.
Parameters:
Name Type Description
event string
listener function
Inherited From:
Source:
Returns:
Returns emitter, so calls can be chained.
Type
object

emit(event, opt_args) → {boolean}

Execute each of the listeners in order with the supplied arguments.
Parameters:
Name Type Description
event string
opt_args * [arg1], [arg2], [...]
Inherited From:
Source:
Returns:
Returns true if event had listeners, false otherwise.
Type
boolean

getTracker() → {tracking.Tracker}

Gets the tracker instance managed by this task.
Source:
Returns:
Type
tracking.Tracker

listeners(event) → {array}

Returns an array of listeners for the specified event.
Parameters:
Name Type Description
event string
Inherited From:
Source:
Returns:
Array of listeners.
Type
array

once(event, listener) → {object}

Adds a one time listener for the event. This listener is invoked only the next time the event is fired, after which it is removed.
Parameters:
Name Type Description
event string
listener function
Inherited From:
Source:
Returns:
Returns emitter, so calls can be chained.
Type
object

removeAllListeners(event) → {object}

Removes all listeners, or those of the specified event. It's not a good idea to remove listeners that were added elsewhere in the code, especially when it's on an emitter that you didn't create.
Parameters:
Name Type Description
event string
Inherited From:
Source:
Returns:
Returns emitter, so calls can be chained.
Type
object

removeListener(event, listener) → {object}

Remove a listener from the listener array for the specified event. Caution: changes array indices in the listener array behind the listener.
Parameters:
Name Type Description
event string
listener function
Inherited From:
Source:
Returns:
Returns emitter, so calls can be chained.
Type
object

run() → {object}

Emits a `run` event on the tracker task for the implementers to run any child action, e.g. `requestAnimationFrame`.
Source:
Returns:
Returns itself, so calls can be chained.
Type
object

setMaxListeners(n)

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default which helps finding memory leaks. Obviously not all Emitters should be limited to 10. This function allows that to be increased. Set to zero for unlimited.
Parameters:
Name Type Description
n number The maximum number of listeners.
Inherited From:
Source:

setTracker() → {tracking.Tracker}

Sets the tracker instance managed by this task.
Source:
Returns:
Type
tracking.Tracker

stop() → {object}

Emits a `stop` event on the tracker task for the implementers to stop any child action being done, e.g. `requestAnimationFrame`.
Source:
Returns:
Returns itself, so calls can be chained.
Type
object