@univerjs/engine-render v0.5.0-beta.1 • Docs

Interface: IMouseEvent

Native friendly interface for MouseEvent Object

Extends

IUIEvent.MouseEvent

Extended by

Properties

Property	Modifier	Type	Description	Overrides	Inherited from	Defined in
`altKey`	`public`	`boolean`	Status of Alt key being pressed	`MouseEvent.altKey`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:189
`AT_TARGET`	`readonly`	`2`	-	-	`IUIEvent`.`AT_TARGET`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:8192
`bubbles`	`readonly`	`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	-	`IUIEvent`.`bubbles`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:8087
`BUBBLING_PHASE`	`readonly`	`3`	-	-	`IUIEvent`.`BUBBLING_PHASE`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:8193
`button`	`public`	`number`	Value of single mouse button pressed	`MouseEvent.button`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:194
`buttons`	`public`	`number`	Value of all mouse buttons pressed	`MouseEvent.buttons`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:199
`cancelable`	`readonly`	`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	-	`IUIEvent`.`cancelable`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:8099
~~`cancelBubble`~~	`public`	`boolean`	Deprecated MDN Reference	-	`IUIEvent`.`cancelBubble`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:8093
`CAPTURING_PHASE`	`readonly`	`1`	-	-	`IUIEvent`.`CAPTURING_PHASE`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:8191
`clientX`	`public`	`number`	Current X coordinate	`MouseEvent.clientX`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:204
`clientY`	`public`	`number`	Current Y coordinate	`MouseEvent.clientY`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:209
`composed`	`readonly`	`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	-	`IUIEvent`.`composed`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:8105
`ctrlKey`	`public`	`boolean`	Status of Ctrl key being pressed	`MouseEvent.ctrlKey`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:214
`currentState`	`public`	`Nullable`<`number`>	Current state of given input	-	`IUIEvent`.`currentState`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:122
`currentTarget`	`readonly`	`null` \| `EventTarget`	Returns the object whose event listener’s callback is currently being invoked. MDN Reference	-	`IUIEvent`.`currentTarget`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:8111
`defaultPrevented`	`readonly`	`boolean`	Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise. MDN Reference	-	`IUIEvent`.`defaultPrevented`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:8117
`detail`	`readonly`	`number`	MDN Reference	-	`IUIEvent`.`detail`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:22316
`deviceType`	`public`	`DeviceType`	Device type	-	`IUIEvent`.`deviceType`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:110
`eventPhase`	`readonly`	`number`	Returns the event’s phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE. MDN Reference	-	`IUIEvent`.`eventPhase`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:8123
`inputIndex`	`public`	`number`	Device slot	-	`IUIEvent`.`inputIndex`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:114
`isTrusted`	`readonly`	`boolean`	Returns true if event was dispatched by the user agent, and false otherwise. MDN Reference	-	`IUIEvent`.`isTrusted`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:8129
`layerX`	`readonly`	`number`	MDN Reference	-	`MouseEvent.layerX`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:15355
`layerY`	`readonly`	`number`	MDN Reference	-	`MouseEvent.layerY`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:15357
`metaKey`	`public`	`boolean`	Status of Meta key (eg. Windows key) being pressed	`MouseEvent.metaKey`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:219
`movementX`	`public`	`number`	Delta of movement on X axis	`MouseEvent.movementX`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:224
`movementY`	`public`	`number`	Delta of movement on Y axis	`MouseEvent.movementY`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:229
`mozMovementX?`	`public`	`number`	Delta of movement on X axis	-	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:234
`mozMovementY?`	`public`	`number`	Delta of movement on Y axis	-	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:239
`msMovementX?`	`public`	`any`	Delta of movement on X axis	-	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:244
`msMovementY?`	`public`	`any`	Delta of movement on Y axi s	-	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:249
`NONE`	`readonly`	`0`	-	-	`IUIEvent`.`NONE`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:8190
`offsetX`	`public`	`number`	Current coordinate of X within container	`MouseEvent.offsetX`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:254
`offsetY`	`public`	`number`	Current coordinate of Y within container	`MouseEvent.offsetY`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:259
`pageX`	`readonly`	`number`	MDN Reference	-	`MouseEvent.pageX`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:15369
`pageY`	`readonly`	`number`	MDN Reference	-	`MouseEvent.pageY`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:15371
`previousState`	`public`	`Nullable`<`number`>	Previous state of given input, for what???, nobody read this value.	-	`IUIEvent`.`previousState`	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:118
`relatedTarget`	`readonly`	`null` \| `EventTarget`	MDN Reference	-	`MouseEvent.relatedTarget`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:15373
~~`returnValue`~~	`public`	`boolean`	Deprecated MDN Reference	-	`IUIEvent`.`returnValue`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:8135
`screenX`	`readonly`	`number`	MDN Reference	-	`MouseEvent.screenX`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:15375
`screenY`	`readonly`	`number`	MDN Reference	-	`MouseEvent.screenY`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:15377
`shiftKey`	`public`	`boolean`	Status of Shift key being pressed	`MouseEvent.shiftKey`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:264
~~`srcElement`~~	`readonly`	`null` \| `EventTarget`	Deprecated MDN Reference	-	`IUIEvent`.`srcElement`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:8141
`target`	`readonly`	`null` \| `EventTarget`	Returns the object to which event is dispatched (its target). MDN Reference	-	`IUIEvent`.`target`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:8147
`timeStamp`	`readonly`	`number`	Returns the event’s timestamp as the number of milliseconds measured relative to the time origin. MDN Reference	-	`IUIEvent`.`timeStamp`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:8153
`type`	`readonly`	`string`	Returns the type of event, e.g. “click”, “hashchange”, or “submit”. MDN Reference	-	`IUIEvent`.`type`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:8159
`view`	`readonly`	`null` \| `Window`	MDN Reference	-	`IUIEvent`.`view`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:22318
`webkitMovementX?`	`public`	`any`	Delta of movement on X axis	-	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:269
`webkitMovementY?`	`public`	`any`	Delta of movement on Y axis	-	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:274
~~`which`~~	`readonly`	`number`	Deprecated MDN Reference	-	`IUIEvent`.`which`	node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:22324
`x`	`public`	`number`	Alias of clientX	`MouseEvent.x`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:279
`y`	`public`	`number`	Alias of clientY	`MouseEvent.y`	-	packages/api/tmp/univer-pro/submodules/univer/packages/engine-render/src/basics/i-events.ts:284

Methods

composedPath()

composedPath(undefined)

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

IUIEvent.composedPath

Defined in

node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:8165

composedPath(undefined)

composedPath(): EventTarget[]

MDN Reference

Returns

EventTarget[]

Inherited from

IUIEvent.composedPath

Defined in

node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.webworker.d.ts:2473

getModifierState()

getModifierState(keyArg): boolean

MDN Reference

Parameters

Parameter	Type
`keyArg`	`string`

Returns

boolean

Inherited from

MouseEvent.getModifierState

Defined in

node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:15385

initEvent()

initEvent(type, bubbles, cancelable)

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

Parameters

Parameter	Type
`type`	`string`
`bubbles`?	`boolean`
`cancelable`?	`boolean`

Returns

void

Deprecated

MDN Reference

Inherited from

IUIEvent.initEvent

Defined in

node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:8171

initEvent(type, bubbles, cancelable)

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

Parameters

Parameter	Type
`type`	`string`
`bubbles`?	`boolean`
`cancelable`?	`boolean`

Returns

void

Deprecated

MDN Reference

Inherited from

IUIEvent.initEvent

Defined in

node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.webworker.d.ts:2479

initMouseEvent()

initMouseEvent(
   typeArg, 
   canBubbleArg, 
   cancelableArg, 
   viewArg, 
   detailArg, 
   screenXArg, 
   screenYArg, 
   clientXArg, 
   clientYArg, 
   ctrlKeyArg, 
   altKeyArg, 
   shiftKeyArg, 
   metaKeyArg, 
   buttonArg, 
   relatedTargetArg): void

Parameters

Parameter	Type
`typeArg`	`string`
`canBubbleArg`	`boolean`
`cancelableArg`	`boolean`
`viewArg`	`Window`
`detailArg`	`number`
`screenXArg`	`number`
`screenYArg`	`number`
`clientXArg`	`number`
`clientYArg`	`number`
`ctrlKeyArg`	`boolean`
`altKeyArg`	`boolean`
`shiftKeyArg`	`boolean`
`metaKeyArg`	`boolean`
`buttonArg`	`number`
`relatedTargetArg`	`null` \| `EventTarget`

Returns

void

Deprecated

MDN Reference

Inherited from

MouseEvent.initMouseEvent

Defined in

node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:15391

initUIEvent()

initUIEvent(
   typeArg, 
   bubblesArg?, 
   cancelableArg?, 
   viewArg?, 
   detailArg?): void

Parameters

Parameter	Type
`typeArg`	`string`
`bubblesArg`?	`boolean`
`cancelableArg`?	`boolean`
`viewArg`?	`null` \| `Window`
`detailArg`?	`number`

Returns

void

Deprecated

MDN Reference

Inherited from

IUIEvent.initUIEvent

Defined in

node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:22330

preventDefault()

preventDefault(undefined)

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

IUIEvent.preventDefault

Defined in

node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.dom.d.ts:8177

preventDefault(undefined)

preventDefault(): void

MDN Reference

Returns

void

Inherited from

IUIEvent.preventDefault

Defined in

node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.webworker.d.ts:2485

stopImmediatePropagation()

stopImmediatePropagation(undefined)

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