Event

js.html.Event (extern class) → ErrorEvent, GamepadEvent, UIEvent, js.html.eme.MediaKeyError

The Event interface represents any event which takes place in the DOM; some are user-generated (such as mouse or keyboard events), while others are generated by APIs (such as events that indicate an animation has finished running, a video has been paused, and so forth). There are many types of events, some of which use other interfaces based on the main Event interface. Event itself contains the properties and methods which are common to all events.

Documentation Event by Mozilla Contributors, licensed under CC-BY-SA 2.5.

See:

Static Members

NONE: Int
CAPTURING_PHASE: Int
AT_TARGET: Int
BUBBLING_PHASE: Int
ALT_MASK: Int
CONTROL_MASK: Int
SHIFT_MASK: Int
META_MASK: Int

Instance Members

type: String

The name of the event (case-insensitive).

target: EventTarget

A reference to the target to which the event was originally dispatched.

currentTarget: 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.

eventPhase: Int

Indicates which phase of the event flow is being processed.

bubbles: Bool

A Boolean indicating whether the event bubbles up through the DOM or not.

cancelable: Bool

A Boolean indicating whether the event is cancelable.

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.

defaultPrevented: Bool

Indicates whether or not event.preventDefault() has been called on the event.

composed: Bool

A Boolean value indicating whether or not the event can bubble across the boundary between the shadow DOM and the regular DOM.

isTrusted: 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).

timeStamp: Float

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.

cancelBubble: Bool

A historical alias to Event.stopPropagation(). Setting its value to true before returning from an event handler prevents propagation of the event.

originalTarget: EventTarget

The original target of the event, before any retargetings (Mozilla-specific).

explicitOriginalTarget: EventTarget

The explicit original target of the event (Mozilla-specific).

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.

Returns
Array<EventTarget>
stopPropagation(): Void

Stops the propagation of events further along in the DOM.

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)

preventDefault(): Void

Cancels the event (if it is cancelable).

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.

Name Type Default
type String
bubbles Bool false
cancelable Bool false
new(type: String, ?eventInitDict: Null<EventInit>): Void
Name Type Default
type String
eventInitDict Null<EventInit> (optional)