ScreenSpaceEventHandler

new Cesium.ScreenSpaceEventHandler(element)
engine/Source/Core/ScreenSpaceEventHandler.js 982

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

Members

static Cesium.ScreenSpaceEventHandler.mouseEmulationIgnoreMilliseconds : Number
engine/Source/Core/ScreenSpaceEventHandler.js 1131

The amount of time, in milliseconds, that mouse events will be disabled after receiving any touch events, such that any emulated mouse events will be ignored.
Default Value: 800

static Cesium.ScreenSpaceEventHandler.touchHoldDelayMilliseconds : Number
engine/Source/Core/ScreenSpaceEventHandler.js 1139

The amount of time, in milliseconds, before a touch on the screen becomes a touch and hold.
Default Value: 1500

Methods

destroy()
engine/Source/Core/ScreenSpaceEventHandler.js 1119

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.
Throws:
  • DeveloperError : This object was destroyed, i.e., destroy() was called.
Example:
handler = handler && handler.destroy();
See:

getInputAction(type, modifier) → ScreenSpaceEventHandler.PositionedEventCallback|ScreenSpaceEventHandler.MotionEventCallback|ScreenSpaceEventHandler.WheelEventCallback|ScreenSpaceEventHandler.TwoPointEventCallback|ScreenSpaceEventHandler.TwoPointMotionEventCallback
engine/Source/Core/ScreenSpaceEventHandler.js 1055

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

isDestroyed() → Boolean
engine/Source/Core/ScreenSpaceEventHandler.js 1100

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)
engine/Source/Core/ScreenSpaceEventHandler.js 1076

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

setInputAction(action, type, modifier)
engine/Source/Core/ScreenSpaceEventHandler.js 1025

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

Type Definitions

Cesium.ScreenSpaceEventHandler.MotionEvent
engine/Source/Core/ScreenSpaceEventHandler.js 911

An Event that starts at one position and ends at another.
Properties:
Name Type Description
startPosition Cartesian2
endPosition Cartesian2

Cesium.ScreenSpaceEventHandler.MotionEventCallback(event)
engine/Source/Core/ScreenSpaceEventHandler.js 920

Name Type Description
event ScreenSpaceEventHandler.MotionEvent The event which triggered the listener

Cesium.ScreenSpaceEventHandler.PositionedEvent
engine/Source/Core/ScreenSpaceEventHandler.js 895

An Event that occurs at a single position on screen.
Properties:
Name Type Description
position Cartesian2

Cesium.ScreenSpaceEventHandler.PositionedEventCallback(event)
engine/Source/Core/ScreenSpaceEventHandler.js 903

Name Type Description
event ScreenSpaceEventHandler.PositionedEvent The event which triggered the listener

Cesium.ScreenSpaceEventHandler.TwoPointEvent
engine/Source/Core/ScreenSpaceEventHandler.js 928

An Event that occurs at a two positions on screen.
Properties:
Name Type Description
position1 Cartesian2
position2 Cartesian2

Cesium.ScreenSpaceEventHandler.TwoPointEventCallback(event)
engine/Source/Core/ScreenSpaceEventHandler.js 937

Name Type Description
event ScreenSpaceEventHandler.TwoPointEvent The event which triggered the listener

Cesium.ScreenSpaceEventHandler.TwoPointMotionEvent
engine/Source/Core/ScreenSpaceEventHandler.js 945

An Event that starts at a two positions on screen and moves to two other positions.
Properties:
Name Type Description
position1 Cartesian2
position2 Cartesian2
previousPosition1 Cartesian2
previousPosition2 Cartesian2

Cesium.ScreenSpaceEventHandler.TwoPointMotionEventCallback(event)
engine/Source/Core/ScreenSpaceEventHandler.js 956

Name Type Description
event ScreenSpaceEventHandler.TwoPointMotionEvent The event which triggered the listener

Cesium.ScreenSpaceEventHandler.WheelEventCallback(delta)
engine/Source/Core/ScreenSpaceEventHandler.js 964

Name Type Description
delta number The amount that the mouse wheel moved
Need help? The fastest way to get answers is from the community and team on the Cesium Forum.
packages/engine
packages/widgets