ssCore.Mouse.clearNotify

Cancels notifications for the specified event.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

event - The event you want to receive notifications for. Valid values include: onMouseMove, onMouseWheel, and onMouseButton.


Output Parameters:

No output parameters.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.Mouse.clearNotify( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.Mouse.clearNotify( paramsObject );


Notes:

None.


Examples:

The following example clears the notification for the onMouseMove event setup previously using ssCore.Mouse.setNotify.

ssCore.Mouse.clearNotify({event:"onMouseMove"});