@univerjs/engine-render v0.5.4


Interface: IEvent

Defined in: packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:105

Native friendly interface for Event Obj ect

Extends

  • Event

Extended by

Properties

PropertyModifierTypeDescriptionInherited fromDefined in
AT_TARGETreadonly2-Event.AT_TARGETnode_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8602
bubblesreadonlybooleanReturns 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 ReferenceEvent.bubblesnode_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8497
BUBBLING_PHASEreadonly3-Event.BUBBLING_PHASEnode_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8603
cancelablereadonlybooleanReturns 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 ReferenceEvent.cancelablenode_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8509
cancelBubblepublicbooleanDeprecated MDN ReferenceEvent.cancelBubblenode_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8503
CAPTURING_PHASEreadonly1-Event.CAPTURING_PHASEnode_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8601
composedreadonlybooleanReturns 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 ReferenceEvent.composednode_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8515
currentStatepublicNullable<number>Current state of given input-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:122
currentTargetreadonlynull | EventTargetReturns the object whose event listener’s callback is currently being invoked. MDN ReferenceEvent.currentTargetnode_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8521
defaultPreventedreadonlybooleanReturns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise. MDN ReferenceEvent.defaultPreventednode_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8527
deviceTypepublicDeviceTypeDevice type-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:110
eventPhasereadonlynumberReturns the event’s phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE. MDN ReferenceEvent.eventPhasenode_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8533
inputIndexpublicnumberDevice slot-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:114
isTrustedreadonlybooleanReturns true if event was dispatched by the user agent, and false otherwise. MDN ReferenceEvent.isTrustednode_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8539
NONEreadonly0-Event.NONEnode_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8600
previousStatepublicNullable<number>Previous state of given input, for what???, nobody read this value.-packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:118
returnValuepublicbooleanDeprecated MDN ReferenceEvent.returnValuenode_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8545
srcElementreadonlynull | EventTargetDeprecated MDN ReferenceEvent.srcElementnode_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8551
targetreadonlynull | EventTargetReturns the object to which event is dispatched (its target). MDN ReferenceEvent.targetnode_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8557
timeStampreadonlynumberReturns the event’s timestamp as the number of milliseconds measured relative to the time origin. MDN ReferenceEvent.timeStampnode_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8563
typereadonlystringReturns the type of event, e.g. “click”, “hashchange”, or “submit”. MDN ReferenceEvent.typenode_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8569

Methods

composedPath()

Call Signature

composedPath(): EventTarget[]

Defined in: node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8575

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

Call Signature

composedPath(): EventTarget[]

Defined in: node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.webworker.d.ts:2734

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

initEvent()

Call Signature

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

Defined in: node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8581

Parameters
ParameterType
typestring
bubbles?boolean
cancelable?boolean
Returns

void

Deprecated

MDN Reference

Inherited from
Event.initEvent

Call Signature

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

Defined in: node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.webworker.d.ts:2740

Parameters
ParameterType
typestring
bubbles?boolean
cancelable?boolean
Returns

void

Deprecated

MDN Reference

Inherited from
Event.initEvent

preventDefault()

Call Signature

preventDefault(): void

Defined in: node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8587

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

Call Signature

preventDefault(): void

Defined in: node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.webworker.d.ts:2746

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

stopImmediatePropagation()

Call Signature

stopImmediatePropagation(): void

Defined in: node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8593

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

Call Signature

stopImmediatePropagation(): void

Defined in: node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.webworker.d.ts:2752

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

stopPropagation()

Call Signature

stopPropagation(): void

Defined in: node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.dom.d.ts:8599

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

Call Signature

stopPropagation(): void

Defined in: node_modules/.pnpm/typescript@5.7.2/node_modules/typescript/lib/lib.webworker.d.ts:2758

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