ElectronMouseInputEvent

Unofficial

Both Official Unofficial

Both Own Inherited

Mouse input event passed to ElectronWebContents.sendInputEvent to inject a trusted pointer event.

Import:

import type { ElectronMouseInputEvent } from '@obsidian-typings/obsidian-public-latest';

Signature:

export interface ElectronMouseInputEvent extends ElectronInputEvent

Extends: ElectronInputEvent

Properties

	Property	Type	Description
	button?	'left' | 'middle' | 'right'	The button pressed.
	clickCount?	number	The number of consecutive clicks.
	globalX?	number	The x coordinate of the pointer relative to the screen.
	globalY?	number	The y coordinate of the pointer relative to the screen.
	modifiers?	Array< | 'alt' | 'capsLock' | 'cmd' | 'command' | 'control' | 'ctrl' | 'isAutoRepeat' | 'isKeypad' | 'left' | 'leftButtonDown' | 'meta' | 'middleButtonDown' | 'numLock' | 'right' | 'rightButtonDown' | 'shift' >	The modifier keys held during the event. (Inherited from ElectronInputEvent)
	movementX?	number	The x movement delta since the previous mouse event.
	movementY?	number	The y movement delta since the previous mouse event.
	type	'contextMenu' | 'mouseDown' | 'mouseEnter' | 'mouseLeave' | 'mouseMove' | 'mouseUp' | 'mouseWheel'	The type of the mouse event.
	x	number	The x coordinate (web-contents DIP) of the pointer.
	y	number	The y coordinate (web-contents DIP) of the pointer.

---

Links to this page:

• ElectronMouseWheelInputEvent