The UIEvent interface represents simple user interface events.
UIEvent derives from Event. Although the UIEvent.initUIEvent() method is kept for backward compatibility, you should create a UIEvent object using the UIEvent() constructor.
Several interfaces are direct or indirect descendants of this one: MouseEvent, TouchEvent, FocusEvent, KeyboardEvent, WheelEvent, InputEvent, and CompositionEvent.
Constructors
UIEvent()- Creates a
UIEventobject.
Properties
This interface also inherits properties of its parent, Event.
UIEvent.cancelBubble- Is a
Booleanindicating whether the bubbling of the event has been canceled or not.
UIEvent.detailRead only- Returns a
longwith details about the event, depending on the event type. UIEvent.isCharRead only- Returns a
Booleanindicating whether the event produced a key character or not. UIEvent.layerXRead only- Returns the horizontal coordinate of the event relative to the current layer.
UIEvent.layerYRead only- Returns the vertical coordinate of the event relative to the current layer.
UIEvent.pageXRead only- Returns the horizontal coordinate of the event relative to the whole document.
UIEvent.pageYRead only- Returns the vertical coordinate of the event relative to the whole document.
UIEvent.sourceCapabilitiesRead only- Returns an instance of the InputDeviceCapabilities interface which provides information about the physical device responsible for generating a touch event.
UIEvent.viewRead only- Returns a
WindowProxythat contains the view that generated the event. UIEvent.whichRead only- Returns the numeric
keyCodeof the key pressed, or the character code (charCode) for an alphanumeric key pressed.
Methods
This interface also inherits methods of its parent, Event.
UIEvent.initUIEvent()- Initializes a
UIEventobject. If the event has already being dispatched, this method does nothing.
Specifications
| Specification | Status | Comment |
|---|---|---|
| InputDeviceCapabilities | Editor's Draft | Added sourceCapabilities property. |
| Document Object Model (DOM) Level 3 Events Specification The definition of 'UIEvent' in that specification. |
Working Draft | Added the UIEvent() constructor, deprecated the initUIEvent() method and changed the type of view from AbstractView to WindowProxy. |
| Document Object Model (DOM) Level 2 Events Specification The definition of 'UIEvent' in that specification. |
Recommendation | Initial definition |
Browser compatibility
| Feature | Chrome | Edge | Firefox (Gecko) | Internet Explorer | Opera | Safari |
|---|---|---|---|---|---|---|
| Basic support | (Yes) | (Yes) | (Yes)[2] | ? | (Yes) | ? |
UIEvent() |
(Yes) | (Yes) | 11 (11) | ? | (Yes) | ? |
cancelBubble defined on Event |
? | (Yes) | 53 (53)[1] | ? | ? | ? |
| Feature | Android | Edge | Firefox Mobile (Gecko) | IE Mobile | Opera Mobile | Safari Mobile |
|---|---|---|---|---|---|---|
| Basic support | (Yes) | (Yes) | (Yes)[2] | ? | (Yes) | ? |
UIEvent() |
(Yes) | (Yes) | 11.0 (11) | ? | (Yes) | ? |
cancelBubble defined on Event |
? | (Yes) | 53.0 (53)[1] | ? | ? | ? |
[1] From Firefox 52, this property is now defined on the Event interface instead. See bug 1298970 for more details.
[2] The isChar property has never been supported by any browser but Firefox, and even on Firefox it's never worked except on Mac OSX. For that reason, it's been removed in Firefox 55 to align with other browsers.