[ type ] MouseWheelEvent

Description:

Mouse wheel event received by the onMouseWheel() or ui.onMouseWheel() handler callback.

Type: Object

Properties:

Name Type Description

target

object

The component that triggered the event.

type

string

One of: pixels, line, or pages.

deltaX

number

Amount of units scrolled in horizontal direction.

deltaY

number

Amount of units scrolled in vertical direction.

scrollAmount

number

Tells how many pixels, line, or pages to scroll, depending on teh type.

rotation

number

Number of wheel "clicks" rotated. Can be zero until a full click is accumulated on high-resolution wheels.

screenX

number

Mouse X position relative to the screen.

screenY

number

Mouse Y position relative to the screen.

[x]

number

Mouse X position relative to the component. (not present for global event)

[y]

number

Mouse Y position relative to the component. (not present for global event)

[button]

number

Button number. One of MouseButton enum values. Present when applicable.

[modifiers]

number

Keyboard modifiers (bitmask or flags).

[alt]

boolean

Indicates if ALT key was pressed.

[shift]

boolean

Indicates if SHIFT key was pressed.

[ctrl]

boolean

Indicates if CTRL key was pressed.

Also See: