Skip to main content

Interface: IOdinEvent<T>

Interface describing a custom event containing payload.

Extends​

  • Event

Type Parameters​

• T

Properties​

AT_TARGET​

readonly AT_TARGET: 2

Inherited from​

Event.AT_TARGET

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8226

bubbles​

readonly bubbles: boolean

Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise.

MDN Reference

Inherited from​

Event.bubbles

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8121

BUBBLING_PHASE​

readonly BUBBLING_PHASE: 3

Inherited from​

Event.BUBBLING_PHASE

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8227

cancelable​

readonly cancelable: boolean

Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method.

MDN Reference

Inherited from​

Event.cancelable

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8133

cancelBubble​

cancelBubble: boolean

Deprecated​

MDN Reference

Inherited from​

Event.cancelBubble

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8127

CAPTURING_PHASE​

readonly CAPTURING_PHASE: 1

Inherited from​

Event.CAPTURING_PHASE

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8225

composed​

readonly composed: boolean

Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise.

MDN Reference

Inherited from​

Event.composed

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8139

currentTarget​

readonly currentTarget: EventTarget

Returns the object whose event listener's callback is currently being invoked.

MDN Reference

Inherited from​

Event.currentTarget

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8145

defaultPrevented​

readonly defaultPrevented: boolean

Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.

MDN Reference

Inherited from​

Event.defaultPrevented

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8151

eventPhase​

readonly eventPhase: number

Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.

MDN Reference

Inherited from​

Event.eventPhase

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8157

isTrusted​

readonly isTrusted: boolean

Returns true if event was dispatched by the user agent, and false otherwise.

MDN Reference

Inherited from​

Event.isTrusted

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8163

NONE​

readonly NONE: 0

Inherited from​

Event.NONE

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8224

payload​

readonly payload: T

Custom payload of the event (see IOdin*Payload interfaces).

Defined in​

ari/lib/utils/odin-event-target.d.ts:8

returnValue​

returnValue: boolean

Deprecated​

MDN Reference

Inherited from​

Event.returnValue

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8169

srcElement​

readonly srcElement: EventTarget

Deprecated​

MDN Reference

Inherited from​

Event.srcElement

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8175

target​

readonly target: EventTarget

Returns the object to which event is dispatched (its target).

MDN Reference

Inherited from​

Event.target

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8181

timeStamp​

readonly timeStamp: number

Returns the event's timestamp as the number of milliseconds measured relative to the time origin.

MDN Reference

Inherited from​

Event.timeStamp

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8187

type​

readonly type: string

Returns the type of event, e.g. "click", "hashchange", or "submit".

MDN Reference

Inherited from​

Event.type

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8193

Methods​

composedPath()​

composedPath(): EventTarget[]

Returns the invocation target objects of event's path (objects on which listeners will be invoked), except for any nodes in shadow trees of which the shadow root's mode is "closed" that are not reachable from event's currentTarget.

MDN Reference

Returns​

EventTarget[]

Inherited from​

Event.composedPath

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8199

initEvent()​

initEvent(type, bubbles?, cancelable?): void

Parameters​

• type: string

• bubbles?: boolean

• cancelable?: boolean

Returns​

void

Deprecated​

MDN Reference

Inherited from​

Event.initEvent

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8205

preventDefault()​

preventDefault(): void

If invoked when the cancelable attribute value is true, and while executing a listener for the event with passive set to false, signals to the operation that caused event to be dispatched that it needs to be canceled.

MDN Reference

Returns​

void

Inherited from​

Event.preventDefault

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8211

stopImmediatePropagation()​

stopImmediatePropagation(): void

Invoking this method prevents event from reaching any registered event listeners after the current one finishes running and, when dispatched in a tree, also prevents event from reaching any other objects.

MDN Reference

Returns​

void

Inherited from​

Event.stopImmediatePropagation

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8217

stopPropagation()​

stopPropagation(): void

When dispatched in a tree, invoking this method prevents event from reaching any objects other than the current object.

MDN Reference

Returns​

void

Inherited from​

Event.stopPropagation

Defined in​

developer-documentation/node_modules/typescript/lib/lib.dom.d.ts:8223