Class: object

Extends

• geo.timestamp

Members

idle

Getter for the idle state. Read only.

Properties:

Name	Type	Description
idle	boolean	true if the object is idle (onIdle would call a handler immediately).

Methods

addPromise(promise){this}

object.js, line 80

Add a new promise object preventing idle event handlers from being called until it is resolved.

Name	Type	Description
promise	Promise	A promise object.

Returns:

Type	Description
this

geoIsOn(event, handler){boolean}

object.js, line 189

Report if an event handler is bound to this object.

Name	Type	Description
event	string | Array.<string>	An event or list of events to check.
handler	function	optional A function that might be bound. If undefined, this will report true if there is any handler for the specified event.

Returns:

Type	Description
boolean	true if any of the specified events are bound to the specified handler.

geoOff(event, arg){this}

object.js, line 248

Remove handlers from one event or an array of events. If no event is provided all handlers will be removed.

Name	Type	Description
event	string | Array.<string>	optional An event or a list of events from geo.event or defined by the user, or undefined to remove all events (in which case arg is ignored).
arg	function | Array.<function()>	optional nullable A function or array of functions to remove from the events or a falsy value to remove all handlers from the events.

Returns:

Type	Description
this

geoOn(event, handler){this}

object.js, line 139

Bind an event handler to this object.

Name	Type	Description
event	string	An event from geo.event or a user-defined value.
handler	function	A function that is called when event is triggered. The function is passed a geo.event object.

Returns:

Type	Description
this

geoOnce(event, handler){function}

object.js, line 168

Bind an event handler to this object that will fire once and then deregister itself.

Name	Type	Description
event	string	An event from geo.event or a user-defined value.
handler	function	A function that is called when event is triggered. The function is passed a geo.event object.

Returns:

Type	Description
function	The actual bound handler. This is a wrapper around the handler that was passed to the function.

geoTrigger(event, args){this}

object.js, line 209

Trigger an event (or events) on this object and call all handlers.

Name	Type	Description
event	string | Array.<string>	An event or list of events from geo.event or defined by the user.
args	object	optional Additional information to add to the geo.event object passed to the handlers.

Returns:

Type	Description
this

inherited modified(){this}

timestamp.js, line 25

Update the timestamp to the next global timestamp value.

Returns:

Type	Description
this

onIdle(handler){this}

object.js, line 36

Bind a handler that will be called one time when all internal promises are resolved. If there are no outstanding promises, this is invoked synchronously.

Name	Type	Description
handler	function	A function taking no arguments.

Returns:

Type	Description
this

removePromise(promise){this}

object.js, line 116

Mark a promise as no longer required to resolve before the idle state is reached.

Name	Type	Description
promise	Promise	A promise object.

Returns:

Type	Description
this

inherited timestamp(){number}

timestamp.js, line 37

Get time.

Returns:

Type	Description
number	The timestamp. This is 0 if the timestamp has never been modified.