MouseEventTypes

Show usages

Enumeration of the possible MouseEventArgs types.

Type Details

yfiles module: view-component
yfiles-umd modules: All view modules
Legacy UMD name: yfiles.view.MouseEventTypes

Constants

CLICK

: number

A mouse click has been recognized.

Remarks

This is the case if a press has directly been followed by a release.

DOWN

: number

A button has been pressed.

DRAG

: number

The mouse has been dragged, which means it has been moved while at least one button has been pressed.

ENTER

: number

The mouse has entered the control's bounds.

LEAVE

: number

The mouse has exited the control's bounds.

LOST_CAPTURE

: number

Mouse input capture has been lost.

Remarks

This can happen during mouse drags, if any button is pressed and the focus is taken from the application or transferred to another component by other means then moving the mouse.

MOVE

: number

The mouse has been moved.

NONE

: number

Not a mouse event.

UP

: number

A button has been released.

Remarks

If there was no drag event since the last press event, this will result in a click.

WHEEL

: number

The mouse wheel has been turned.

Static Methods

from

(value: MouseEventTypes) : MouseEventTypes

Converts the argument to MouseEventTypes.

Parameters

options - Object
A map of options to pass to the method.

value - MouseEventTypes: The value to convert to MouseEventTypes.

Returns

↪MouseEventTypes: Either value if it is already a MouseEventTypes or an appropriate converted value.