Complex event arguments that is used by the CanvasComponent to indicate mouse events in world coordinates.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.view.MouseEventArgs
Constructors
MouseEventArgs
(originalEvent: Event, eventType: MouseEventTypes, location: Point, changedButtons?: MouseButtons, changedModifiers?: ModifierKeys, buttons?: MouseButtons, modifiers?: ModifierKeys, clickCount?: number, mouseWheelDelta?: number, mouseWheelDeltaX?: number, scrollAmount?: number, scrollType?: MouseWheelDeltaMode)Constructs a new mouse event argument.
Parameters
A map of options to pass to the method.
- originalEvent - Event
- The original DOM event.
- eventType - MouseEventTypes
- The type of the event
- location - Point
- the position of the mouse in world coordinates at the time of the event
- changedButtons - MouseButtons
- changedModifiers - ModifierKeys
- the modifier Keys that have been changed
- buttons - MouseButtons
- the current state of the MouseButtons
- modifiers - ModifierKeys
- the current state of the modifier Keys
- clickCount - number
- the number of clicks this event represents, 2 for a double click
- mouseWheelDelta - number
- the signed number of vertical mouse wheel turn units
- mouseWheelDeltaX - number
- the signed number of horizontal mouse wheel turn units
- scrollAmount - number
- The number of lines to scroll, if
scrollTypeis LINES. - scrollType - MouseWheelDeltaMode
- The type of scrolling performed.
Properties
Gets the state of the mouse buttons at the time of the event creation.
Gets the mouse buttons that have changed for this event.
See Also
Gets the modifier keys that have changed for this event.
See Also
Gets the number of clicks the current event represents if it is of type CLICK.
Gets a value indicating whether the default behaviors for this event have been prevented by a previous call to preventDefault.
Gets the scrolling behavior.
Remarks
Gets the type of this event.
Gets the coordinates in the world coordinate space associated with this event.
Gets the state of the modifier keys at the time of the event creation.
Methods
Sets this event's defaultPrevented property to true signaling that the event has been properly handled and any default behaviors should be prevented.