The WheelEvent interface represents events that occur due to the user moving a mouse wheel or similar input device.
Documentation WheelEvent by Mozilla Contributors, licensed under CC-BY-SA 2.5.
See also:
Static variables
Constructor
Variables
Returns an unsigned long representing the unit of the delta values scroll amount. Permitted values are:
DOM_DELTA_PIXEL |
0x00 |
The delta values are specified in pixels. |
DOM_DELTA_LINE |
0x01 |
The delta values are specified in lines. |
DOM_DELTA_PAGE |
0x02 |
The delta values are specified in pages. |
Returns a double representing the horizontal scroll amount.
Returns a double representing the vertical scroll amount.
Returns a double representing the scroll amount for the z-axis.
Inherited Variables
Returns true if the alt key was down when the mouse event was fired.
The button number that was pressed (if applicable) when the mouse event was fired.
The buttons being depressed (if any) when the mouse event was fired.
The X coordinate of the mouse pointer in local (DOM content) coordinates.
The Y coordinate of the mouse pointer in local (DOM content) coordinates.
Returns true if the control key was down when the mouse event was fired.
Returns true if the meta key was down when the mouse event was fired.
The X coordinate of the mouse pointer relative to the position of the last mousemove event.
The Y coordinate of the mouse pointer relative to the position of the last mousemove event.
The X coordinate of the mouse pointer relative to the position of the padding edge of the target node.
The Y coordinate of the mouse pointer relative to the position of the padding edge of the target node.
Returns the id of the hit region affected by the event. If no hit region is affected, null is returned.
The secondary target for the event, if there is one.
The X coordinate of the mouse pointer in global (screen) coordinates.
The Y coordinate of the mouse pointer in global (screen) coordinates.
Returns true if the shift key was down when the mouse event was fired.
Returns a long with details about the event, depending on the event type.
Returns the horizontal coordinate of the event relative to the current layer.
Returns the vertical coordinate of the event relative to the current layer.
Returns the horizontal coordinate of the event relative to the whole document.
Returns the vertical coordinate of the event relative to the whole document.
Returns a WindowProxy that contains the view that generated the event.
Returns the numeric keyCode of the key pressed, or the character code (charCode) for an alphanumeric key pressed.
Defined by Event
A Boolean indicating whether the event bubbles up through the DOM or not.
A historical alias to Event.stopPropagation(). Setting its value to true before returning from an event handler prevents propagation of the event.
A Boolean indicating whether the event is cancelable.
A Boolean value indicating whether or not the event can bubble across the boundary between the shadow DOM and the regular DOM.
A reference to the currently registered target for the event. This is the object to which the event is currently slated to be sent; it's possible this has been changed along the way through retargeting.
Indicates whether or not event.preventDefault() has been called on the event.
Indicates which phase of the event flow is being processed.
The explicit original target of the event (Mozilla-specific).
Indicates whether or not the event was initiated by the browser (after a user click for instance) or by a script (using an event creation method, like event.initEvent).
The original target of the event, before any retargetings (Mozilla-specific).
A historical property introduced by Internet Explorer and eventually adopted into the DOM specification in order to ensure existing sites continue to work. Ideally, you should try to use Event.preventDefault() and Event.defaultPrevented instead, but you can use returnValue if you choose to do so.
A reference to the target to which the event was originally dispatched.
The time at which the event was created (in milliseconds). By specification, this value is time since epoch, but in reality browsers' definitions vary; in addition, work is underway to change this to be a DOMHighResTimeStamp instead.
The name of the event (case-insensitive).
Inherited Methods
@:value({ buttonArg : 0, metaKeyArg : false, shiftKeyArg : false, altKeyArg : false, ctrlKeyArg : false, clientYArg : 0, clientXArg : 0, screenYArg : 0, screenXArg : 0, detailArg : 0, cancelableArg : false, canBubbleArg : false })initMouseEvent(typeArg:String, canBubbleArg:Bool = false, cancelableArg:Bool = false, ?viewArg:Window, detailArg:Int = 0, screenXArg:Int = 0, screenYArg:Int = 0, clientXArg:Int = 0, clientYArg:Int = 0, ctrlKeyArg:Bool = false, altKeyArg:Bool = false, shiftKeyArg:Bool = false, metaKeyArg:Bool = false, buttonArg:Int = 0, ?relatedTargetArg:EventTarget):Void
Initializes the value of a MouseEvent created. If the event has already being dispatched, this method does nothing.
@:value({ inputSourceArg : 0, pressure : 0.0, buttonArg : 0, metaKeyArg : false, shiftKeyArg : false, altKeyArg : false, ctrlKeyArg : false, clientYArg : 0, clientXArg : 0, screenYArg : 0, screenXArg : 0, detailArg : 0, cancelableArg : false, canBubbleArg : false })initNSMouseEvent(typeArg:String, canBubbleArg:Bool = false, cancelableArg:Bool = false, ?viewArg:Window, detailArg:Int = 0, screenXArg:Int = 0, screenYArg:Int = 0, clientXArg:Int = 0, clientYArg:Int = 0, ctrlKeyArg:Bool = false, altKeyArg:Bool = false, shiftKeyArg:Bool = false, metaKeyArg:Bool = false, buttonArg:Int = 0, ?relatedTargetArg:EventTarget, pressure:Float = 0.0, inputSourceArg:Int = 0):Void
@:value({ aDetail : 0, aCancelable : false, aCanBubble : false })initUIEvent(aType:String, aCanBubble:Bool = false, aCancelable:Bool = false, ?aView:Window, aDetail:Int = 0):Void
Initializes a UIEvent object. If the event has already being dispatched, this method does nothing.
Defined by Event
Returns the event’s path (objects on which listeners will be invoked). This does not include nodes in shadow trees if the shadow root was created with its ShadowRoot.mode closed.
@:value({ cancelable : false, bubbles : false })initEvent(type:String, bubbles:Bool = false, cancelable:Bool = false):Void
Initializes the value of an Event created. If the event has already being dispatched, this method does nothing.
Cancels the event (if it is cancelable).
For this particular event, no other listener will be called. Neither those attached on the same element, nor those attached on elements which will be traversed later (in capture phase, for instance)
Stops the propagation of events further along in the DOM.