@univerjs/engine-render v0.4.2 • Docs

Interface: IMouseEvent

Native friendly interface for MouseEvent Object

Extends

IUIEvent.MouseEvent

Extended by

Properties

Property	Modifier	Type	Description	Overrides	Inherited from	Defined in
`AT_TARGET`	`readonly`	`2`	-	-	`IUIEvent`.`AT_TARGET`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:8226
`BUBBLING_PHASE`	`readonly`	`3`	-	-	`IUIEvent`.`BUBBLING_PHASE`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:8227
`CAPTURING_PHASE`	`readonly`	`1`	-	-	`IUIEvent`.`CAPTURING_PHASE`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:8225
`NONE`	`readonly`	`0`	-	-	`IUIEvent`.`NONE`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:8224
`altKey`	`public`	`boolean`	Status of Alt key being pressed	`MouseEvent.altKey`	-	submodules/univer/packages/engine-render/src/basics/i-events.ts:189 (opens in a new tab)
`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 (opens in a new tab)	-	`IUIEvent`.`bubbles`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:8121
`button`	`public`	`number`	Value of single mouse button pressed	`MouseEvent.button`	-	submodules/univer/packages/engine-render/src/basics/i-events.ts:194 (opens in a new tab)
`buttons`	`public`	`number`	Value of all mouse buttons pressed	`MouseEvent.buttons`	-	submodules/univer/packages/engine-render/src/basics/i-events.ts:199 (opens in a new tab)
~~`cancelBubble`~~	`public`	`boolean`	Deprecated MDN Reference (opens in a new tab)	-	`IUIEvent`.`cancelBubble`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:8127
`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 (opens in a new tab)	-	`IUIEvent`.`cancelable`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:8133
`clientX`	`public`	`number`	Current X coordinate	`MouseEvent.clientX`	-	submodules/univer/packages/engine-render/src/basics/i-events.ts:204 (opens in a new tab)
`clientY`	`public`	`number`	Current Y coordinate	`MouseEvent.clientY`	-	submodules/univer/packages/engine-render/src/basics/i-events.ts:209 (opens in a new tab)
`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 (opens in a new tab)	-	`IUIEvent`.`composed`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:8139
`ctrlKey`	`public`	`boolean`	Status of Ctrl key being pressed	`MouseEvent.ctrlKey`	-	submodules/univer/packages/engine-render/src/basics/i-events.ts:214 (opens in a new tab)
`currentState`	`public`	`Nullable`<`number`>	Current state of given input	-	`IUIEvent`.`currentState`	submodules/univer/packages/engine-render/src/basics/i-events.ts:122 (opens in a new tab)
`currentTarget`	`readonly`	`null` \| `EventTarget`	Returns the object whose event listener's callback is currently being invoked. MDN Reference (opens in a new tab)	-	`IUIEvent`.`currentTarget`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:8145
`defaultPrevented`	`readonly`	`boolean`	Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise. MDN Reference (opens in a new tab)	-	`IUIEvent`.`defaultPrevented`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:8151
`detail`	`readonly`	`number`	MDN Reference (opens in a new tab)	-	`IUIEvent`.`detail`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:22847
`deviceType`	`public`	`DeviceType`	Device type	-	`IUIEvent`.`deviceType`	submodules/univer/packages/engine-render/src/basics/i-events.ts:110 (opens in a new tab)
`eventPhase`	`readonly`	`number`	Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE. MDN Reference (opens in a new tab)	-	`IUIEvent`.`eventPhase`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:8157
`inputIndex`	`public`	`number`	Device slot	-	`IUIEvent`.`inputIndex`	submodules/univer/packages/engine-render/src/basics/i-events.ts:114 (opens in a new tab)
`isTrusted`	`readonly`	`boolean`	Returns true if event was dispatched by the user agent, and false otherwise. MDN Reference (opens in a new tab)	-	`IUIEvent`.`isTrusted`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:8163
`layerX`	`readonly`	`number`	MDN Reference (opens in a new tab)	-	`MouseEvent.layerX`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:15875
`layerY`	`readonly`	`number`	MDN Reference (opens in a new tab)	-	`MouseEvent.layerY`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:15877
`metaKey`	`public`	`boolean`	Status of Meta key (eg. Windows key) being pressed	`MouseEvent.metaKey`	-	submodules/univer/packages/engine-render/src/basics/i-events.ts:219 (opens in a new tab)
`movementX`	`public`	`number`	Delta of movement on X axis	`MouseEvent.movementX`	-	submodules/univer/packages/engine-render/src/basics/i-events.ts:224 (opens in a new tab)
`movementY`	`public`	`number`	Delta of movement on Y axis	`MouseEvent.movementY`	-	submodules/univer/packages/engine-render/src/basics/i-events.ts:229 (opens in a new tab)
`mozMovementX?`	`public`	`number`	Delta of movement on X axis	-	-	submodules/univer/packages/engine-render/src/basics/i-events.ts:234 (opens in a new tab)
`mozMovementY?`	`public`	`number`	Delta of movement on Y axis	-	-	submodules/univer/packages/engine-render/src/basics/i-events.ts:239 (opens in a new tab)
`msMovementX?`	`public`	`any`	Delta of movement on X axis	-	-	submodules/univer/packages/engine-render/src/basics/i-events.ts:244 (opens in a new tab)
`msMovementY?`	`public`	`any`	Delta of movement on Y axi s	-	-	submodules/univer/packages/engine-render/src/basics/i-events.ts:249 (opens in a new tab)
`offsetX`	`public`	`number`	Current coordinate of X within container	`MouseEvent.offsetX`	-	submodules/univer/packages/engine-render/src/basics/i-events.ts:254 (opens in a new tab)
`offsetY`	`public`	`number`	Current coordinate of Y within container	`MouseEvent.offsetY`	-	submodules/univer/packages/engine-render/src/basics/i-events.ts:259 (opens in a new tab)
`pageX`	`readonly`	`number`	MDN Reference (opens in a new tab)	-	`MouseEvent.pageX`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:15889
`pageY`	`readonly`	`number`	MDN Reference (opens in a new tab)	-	`MouseEvent.pageY`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:15891
`previousState`	`public`	`Nullable`<`number`>	Previous state of given input	-	`IUIEvent`.`previousState`	submodules/univer/packages/engine-render/src/basics/i-events.ts:118 (opens in a new tab)
`relatedTarget`	`readonly`	`null` \| `EventTarget`	MDN Reference (opens in a new tab)	-	`MouseEvent.relatedTarget`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:15893
~~`returnValue`~~	`public`	`boolean`	Deprecated MDN Reference (opens in a new tab)	-	`IUIEvent`.`returnValue`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:8169
`screenX`	`readonly`	`number`	MDN Reference (opens in a new tab)	-	`MouseEvent.screenX`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:15895
`screenY`	`readonly`	`number`	MDN Reference (opens in a new tab)	-	`MouseEvent.screenY`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:15897
`shiftKey`	`public`	`boolean`	Status of Shift key being pressed	`MouseEvent.shiftKey`	-	submodules/univer/packages/engine-render/src/basics/i-events.ts:264 (opens in a new tab)
~~`srcElement`~~	`readonly`	`null` \| `EventTarget`	Deprecated MDN Reference (opens in a new tab)	-	`IUIEvent`.`srcElement`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:8175
`target`	`readonly`	`null` \| `EventTarget`	Returns the object to which event is dispatched (its target). MDN Reference (opens in a new tab)	-	`IUIEvent`.`target`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:8181
`timeStamp`	`readonly`	`number`	Returns the event's timestamp as the number of milliseconds measured relative to the time origin. MDN Reference (opens in a new tab)	-	`IUIEvent`.`timeStamp`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:8187
`type`	`readonly`	`string`	Returns the type of event, e.g. "click", "hashchange", or "submit". MDN Reference (opens in a new tab)	-	`IUIEvent`.`type`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:8193
`view`	`readonly`	`null` \| `Window`	MDN Reference (opens in a new tab)	-	`IUIEvent`.`view`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:22849
`webkitMovementX?`	`public`	`any`	Delta of movement on X axis	-	-	submodules/univer/packages/engine-render/src/basics/i-events.ts:269 (opens in a new tab)
`webkitMovementY?`	`public`	`any`	Delta of movement on Y axis	-	-	submodules/univer/packages/engine-render/src/basics/i-events.ts:274 (opens in a new tab)
~~`which`~~	`readonly`	`number`	Deprecated MDN Reference (opens in a new tab)	-	`IUIEvent`.`which`	node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:22855
`x`	`public`	`number`	Alias of clientX	`MouseEvent.x`	-	submodules/univer/packages/engine-render/src/basics/i-events.ts:279 (opens in a new tab)
`y`	`public`	`number`	Alias of clientY	`MouseEvent.y`	-	submodules/univer/packages/engine-render/src/basics/i-events.ts:284 (opens in a new tab)

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 (opens in a new tab)

Returns

EventTarget[]

Inherited from

IUIEvent.composedPath

Defined in

node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:8199

composedPath(undefined)

composedPath(): EventTarget[]

MDN Reference (opens in a new tab)

Returns

EventTarget[]

Inherited from

IUIEvent.composedPath

Defined in

node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.webworker.d.ts:2523

getModifierState()

getModifierState(keyArg): boolean

MDN Reference (opens in a new tab)

Parameters

Parameter	Type
`keyArg`	`string`

Returns

boolean

Inherited from

MouseEvent.getModifierState

Defined in

node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:15905

initEvent()

initEvent(type, bubbles, cancelable)

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

Parameters

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

Returns

void

Deprecated

MDN Reference (opens in a new tab)

Inherited from

IUIEvent.initEvent

Defined in

node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:8205

initEvent(type, bubbles, cancelable)

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

Parameters

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

Returns

void

Deprecated

MDN Reference (opens in a new tab)

Inherited from

IUIEvent.initEvent

Defined in

node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.webworker.d.ts:2529

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 (opens in a new tab)

Inherited from

MouseEvent.initMouseEvent

Defined in

node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:15911

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 (opens in a new tab)

Inherited from

IUIEvent.initUIEvent

Defined in

node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:22861

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 (opens in a new tab)

Returns

void

Inherited from

IUIEvent.preventDefault

Defined in

node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.dom.d.ts:8211

preventDefault(undefined)

preventDefault(): void

MDN Reference (opens in a new tab)

Returns

void

Inherited from

IUIEvent.preventDefault

Defined in

node_modules/.pnpm/typescript@5.5.3/node_modules/typescript/lib/lib.webworker.d.ts:2535

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 (opens in a new tab)