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

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