Skip to content

ElectronMouseWheelInputEvent

Unofficial

Mouse wheel input event passed to ElectronWebContents.sendInputEvent to inject a trusted scroll.

Import:

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

Signature:

export interface ElectronMouseWheelInputEvent extends ElectronMouseInputEvent

Extends: ElectronMouseInputEvent

Properties

Property Type Description
accelerationRatioX? number The acceleration ratio along the x axis.
accelerationRatioY? number The acceleration ratio along the y axis.
button? 'left' | 'middle' | 'right' The button pressed.
(Inherited from ElectronMouseInputEvent)
canScroll? boolean Whether the wheel event can trigger scrolling.
clickCount? number The number of consecutive clicks.
(Inherited from ElectronMouseInputEvent)
deltaX? number The scroll delta along the x axis.
deltaY? number The scroll delta along the y axis.
globalX? number The x coordinate of the pointer relative to the screen.
(Inherited from ElectronMouseInputEvent)
globalY? number The y coordinate of the pointer relative to the screen.
(Inherited from ElectronMouseInputEvent)
hasPreciseScrollingDeltas? boolean Whether the event carries precise scrolling deltas.
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 ElectronMouseInputEvent)
movementX? number The x movement delta since the previous mouse event.
(Inherited from ElectronMouseInputEvent)
movementY? number The y movement delta since the previous mouse event.
(Inherited from ElectronMouseInputEvent)
type 'mouseWheel' The type of the mouse wheel event.
wheelTicksX? number The number of wheel ticks along the x axis.
wheelTicksY? number The number of wheel ticks along the y axis.
x number The x coordinate (web-contents DIP) of the pointer.
(Inherited from ElectronMouseInputEvent)
y number The y coordinate (web-contents DIP) of the pointer.
(Inherited from ElectronMouseInputEvent)