@serenity-is/sleekgrid / IEventData

Interface: IEventData<TArgs, TEvent>

Defined in: src/core/event.ts:7

Core event object passed to every grid event handler. Mirrors W3C/jQuery event semantics with propagation and default-prevent controls.

Type Parameters

TArgs

TArgs = { }

Payload specific to the event.

TEvent

TEvent = { }

Native DOM event wrapped by this object.

Properties

args

args: TArgs

Defined in: src/core/event.ts:9

Payload supplied by the event emitter (e.g. {row, cell, grid}).

---

defaultPrevented

defaultPrevented: boolean

Defined in: src/core/event.ts:11

Whether IEventData.preventDefault has been called.

---

nativeEvent

nativeEvent: TEvent

Defined in: src/core/event.ts:36

The wrapped native DOM event, if any.

Methods

getReturnValue()

getReturnValue(): any

Defined in: src/core/event.ts:32

Returns the last non-undefined return value from the handlers that have run.

Returns

any

---

getReturnValues()

getReturnValues(): any[]

Defined in: src/core/event.ts:34

Returns all return values collected from handlers.

Returns

any[]

---

isDefaultPrevented()

isDefaultPrevented(): boolean

Defined in: src/core/event.ts:26

Returns true if IEventData.preventDefault has been called or the native event is default-prevented.

Returns

boolean

---

isImmediatePropagationStopped()

isImmediatePropagationStopped(): boolean

Defined in: src/core/event.ts:28

Returns true if IEventData.stopImmediatePropagation has been called.

Returns

boolean

---

isPropagationStopped()

isPropagationStopped(): boolean

Defined in: src/core/event.ts:30

Returns true if IEventData.stopPropagation has been called.

Returns

boolean

---

preventDefault()

preventDefault(): void

Defined in: src/core/event.ts:15

Prevents the default action associated with the event.

Returns

void

---

stopImmediatePropagation()

stopImmediatePropagation(): void

Defined in: src/core/event.ts:24

Prevents remaining handlers from being executed. Also stops DOM propagation.

Returns

void

---

stopPropagation()

stopPropagation(): void

Defined in: src/core/event.ts:20

Stops the event from bubbling further, but remaining handlers on the same emitter still run. Also calls stopPropagation on the native event when present.

Returns

void