ScreenSpaceEventHandler

new Cesium.ScreenSpaceEventHandler(element)
Core/ScreenSpaceEventHandler.js 643

Handles user input events. Custom functions can be added to be executed on when the user enters input.
Name Type Default Description
element Canvas document optional The element to add events to.

Methods

destroy() → undefined
Core/ScreenSpaceEventHandler.js 765

Removes listeners held by this object.

Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.
Returns:
Throws:
  • DeveloperError : This object was destroyed, i.e., destroy() was called.
Example:
handler = handler && handler.destroy();
See:

getInputAction(type, modifier)
Core/ScreenSpaceEventHandler.js 702

Returns the function to be executed on an input event.
Name Type Description
type Number The ScreenSpaceEventType of input event.
modifier Number optional A KeyboardEventModifier key that is held when a type event occurs.
See:

isDestroyed() → Boolean
Core/ScreenSpaceEventHandler.js 744

Returns true if this object was destroyed; otherwise, false.

If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.
Returns:
true if this object was destroyed; otherwise, false.
See:

removeInputAction(type, modifier)
Core/ScreenSpaceEventHandler.js 723

Removes the function to be executed on an input event.
Name Type Description
type Number The ScreenSpaceEventType of input event.
modifier Number optional A KeyboardEventModifier key that is held when a type event occurs.
See:

setInputAction(action, type, modifier)
Core/ScreenSpaceEventHandler.js 678

Set a function to be executed on an input event.
Name Type Description
action function Function to be executed when the input event occurs.
type Number The ScreenSpaceEventType of input event.
modifier Number optional A KeyboardEventModifier key that is held when a type event occurs.
See: