class MouseScrollEvent
package js.html
extends MouseEvent › UIEvent › Event
@:native("MouseScrollEvent")Available on js
The MouseScrollEvent interface represents events that occur due to the user moving a mouse wheel or similar input device.
Documentation MouseScrollEvent by Mozilla Contributors, licensed under CC-BY-SA 2.5.
See also:
Static variables
Variables
Methods
@:value({ axis : 0, button : 0, metaKey : false, shiftKey : false, altKey : false, ctrlKey : false, clientY : 0, clientX : 0, screenY : 0, screenX : 0, detail : 0, cancelable : false, canBubble : false })initMouseScrollEvent(type:String, canBubble:Bool = false, cancelable:Bool = false, ?view:Window, detail:Int = 0, screenX:Int = 0, screenY:Int = 0, clientX:Int = 0, clientY:Int = 0, ctrlKey:Bool = false, altKey:Bool = false, shiftKey:Bool = false, metaKey:Bool = false, button:Int = 0, ?relatedTarget:EventTarget, axis:Int = 0):Void
Inherited Variables
Defined by MouseEvent
read onlybutton:Int
The button number that was pressed (if applicable) when the mouse event was fired.
read onlymovementX:Int
The X coordinate of the mouse pointer relative to the position of the last mousemove event.
read onlymovementY:Int
The Y coordinate of the mouse pointer relative to the position of the last mousemove event.
read onlyoffsetX:Int
The X coordinate of the mouse pointer relative to the position of the padding edge of the target node.
read onlyoffsetY:Int
The Y coordinate of the mouse pointer relative to the position of the padding edge of the target node.
Defined by UIEvent
Defined by Event
cancelBubble:Bool
A historical alias to Event.stopPropagation(). Setting its value to true before returning from an event handler prevents propagation of the event.
read onlycomposed:Bool
A Boolean value indicating whether or not the event can bubble across the boundary between the shadow DOM and the regular DOM.
read onlycurrentTarget:EventTarget
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.
read onlydefaultPrevented:Bool
Indicates whether or not event.preventDefault() has been called on the event.
read onlyexplicitOriginalTarget:EventTarget
The explicit original target of the event (Mozilla-specific).
read onlyisTrusted:Bool
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).
read onlyoriginalTarget:EventTarget
The original target of the event, before any retargetings (Mozilla-specific).
returnValue:Bool
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.
Inherited Methods
Defined by MouseEvent
getModifierState(keyArg:String):Bool
Returns the current state of the specified modifier key. See the KeyboardEvent.getModifierState() for details.
@: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
Defined by UIEvent
Defined by Event
composedPath():Array<EventTarget>
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.
stopImmediatePropagation():Void
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)