1# @ohos.multimodalInput.mouseEvent (鼠标输入事件) 2 3<!--Kit: Input Kit--> 4<!--Subsystem: MultimodalInput--> 5<!--Owner: @zhaoxueyuan--> 6<!--Designer: @hanruofei--> 7<!--Tester: @Lyuxin--> 8<!--Adviser: @Brilliantry_Rui--> 9 10设备上报的鼠标事件，继承自[InputEvent](./js-apis-inputevent.md)。 11 12> **说明：** 13> 14> 本模块首批接口从API version 9开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 15 16## 导入模块 17 18```js 19import { Action, Button, Axis, AxisValue, MouseEvent } from '@kit.InputKit'; 20``` 21 22## Action 23 24鼠标事件类型。 25 26**系统能力：** SystemCapability.MultimodalInput.Input.Core 27 28| 名称 | 值 | 说明 | 29| ----------- | -------- | -------------------- | 30| CANCEL | 0 | 取消。 | 31| MOVE | 1 | 鼠标移动。 | 32| BUTTON_DOWN | 2 | 鼠标按钮按下。 | 33| BUTTON_UP | 3 | 鼠标按钮抬起。 | 34| AXIS_BEGIN | 4 | 鼠标轴事件开始。 | 35| AXIS_UPDATE | 5 | 鼠标轴事件更新。 | 36| AXIS_END | 6 | 鼠标轴事件结束。 | 37| ACTION_DOWN<sup>11+</sup> | 7 | 触摸板按下。 | 38| ACTION_UP<sup>11+</sup> | 8 | 触摸板抬起。 | 39 40## Button 41 42鼠标按键。 43 44**系统能力：** SystemCapability.MultimodalInput.Input.Core 45 46| 名称 | 值 | 说明 | 47| ------- | ------| ----- | 48| LEFT | 0 | 鼠标左键。 | 49| MIDDLE | 1 | 鼠标中键。 | 50| RIGHT | 2 | 鼠标右键。 | 51| SIDE | 3 | 鼠标侧边键。 | 52| EXTRA | 4 | 鼠标扩展键。 | 53| FORWARD | 5 | 鼠标前进键。 | 54| BACK | 6 | 鼠标后退键。 | 55| TASK | 7 | 鼠标任务键。 | 56 57## Axis 58 59鼠标轴类型。 60 61**系统能力：** SystemCapability.MultimodalInput.Input.Core 62 63| 名称 | 值 | 说明 | 64| ----------------- | ------- | ----- | 65| SCROLL_VERTICAL | 0 | 垂直滚动轴。 | 66| SCROLL_HORIZONTAL | 1 | 水平滚动轴。 | 67| PINCH | 2 | 捏合轴。 | 68 69 70## AxisValue 71 72鼠标轴类型和轴的值。 73 74**系统能力：** SystemCapability.MultimodalInput.Input.Core 75 76| 名称 | 类型 | 只读 | 可选 | 说明 | 77| ----- | ------ | ---- | ---- | ---- | 78| axis | [Axis](#axis) | 否 | 否 | 轴类型。 | 79| value | number | 否 | 否 | 轴的值。 | 80 81## ToolType<sup>11+</sup> 82 83工具类型。 84 85**系统能力：** SystemCapability.MultimodalInput.Input.Core 86 87| 名称 | 值 | 说明 | 88| ------- | ------| ----- | 89| UNKNOWN | 0 | 未知类型。 | 90| MOUSE | 1 | 鼠标。 | 91| JOYSTICK | 2 | 摇杆。 | 92| TOUCHPAD | 3 | 触摸板。 | 93 94## MouseEvent 95 96鼠标事件。 97 98**系统能力：** SystemCapability.MultimodalInput.Input.Core 99 100| 名称 | 类型 | 只读 | 可选 | 说明 | 101| -------------- | ----------- | ---- | ---- | ---------------------------------------- | 102| action | [Action](#action) | 否 | 否 | 鼠标事件动作。 | 103| screenX | number | 否 | 否 | 该鼠标事件以指定屏幕左上角为原点的相对坐标系的X坐标。当前仅支持整数。 | 104| screenY | number | 否 | 否 | 该鼠标事件以指定屏幕左上角为原点的相对坐标系的Y坐标。当前仅支持整数。 | 105| windowX | number | 否 | 否 | 鼠标所在窗口左上角为原点的相对坐标系的X坐标。当前仅支持整数。 | 106| windowY | number | 否 | 否 | 鼠标所在窗口左上角为原点的相对坐标系的Y坐标。当前仅支持整数。 | 107| rawDeltaX | number | 否 | 否 | 鼠标当前事件相对于上次事件的X坐标偏移值。当前仅支持整数。 | 108| rawDeltaY | number | 否 | 否 | 鼠标当前事件相对于上次事件的Y坐标偏移值。当前仅支持整数。 | 109| button | [Button](#button) | 否 | 否 | 鼠标按钮。 | 110| pressedButtons | [Button](#button)[] | 否 | 否 | 当前处于按下状态的鼠标按钮。 | 111| axes | [AxisValue](#axisvalue)[] | 否 | 否 | 事件包含的所有轴数据。 | 112| pressedKeys | [KeyCode](js-apis-keycode.md#keycode)[] | 否 | 否 | 当前处于按下状态的按键列表。 | 113| ctrlKey | boolean | 否 | 否 | 当前ctrlKey是否处于按下状态。 <br>true表示处于按下状态，false表示处于抬起状态。 | 114| altKey | boolean | 否 | 否 | 当前altKey是否处于按下状态。 <br>true表示处于按下状态，false表示处于抬起状态。 | 115| shiftKey | boolean | 否 | 否 | 当前shiftKey是否处于按下状态。 <br>true表示处于按下状态，false表示处于抬起状态。 | 116| logoKey | boolean | 否 | 否 | 当前logoKey是否处于按下状态。 <br>true表示处于按下状态，false表示处于抬起状态。 | 117| fnKey | boolean | 否 | 否 | 当前fnKey是否处于按下状态。 <br>true表示处于按下状态，false表示处于抬起状态。 | 118| capsLock | boolean | 否 | 否 | 当前capsLock是否处于激活状态。 <br>true表示激活状态，false表示处于未激活状态。 | 119| numLock | boolean | 否 | 否 | 当前numLock是否处于激活状态。 <br>true表示激活状态，false表示处于未激活状态。 | 120| scrollLock | boolean | 否 | 否 | 当前scrollLock是否处于激活状态。 <br>true表示激活状态，false表示处于未激活状态。 | 121| toolType<sup>11+</sup> | [ToolType](#tooltype11) | 否 | 否 | 工具类型。 | 122| globalX<sup>20+</sup> | number | 否 | 是 | 该鼠标事件以主屏左上角为原点的全局坐标系的X坐标。<!--Del-->作为入参时，若接口参数中的[MouseEventData.useGlobalCoordinate](./js-apis-inputeventclient-sys.md#mouseeventdata11)为true，该值必填，当前仅支持整数。若为false，该值无需填写，使用指定屏幕左上角为原点的相对坐标系的X坐标计算注入事件。<!--DelEnd-->作为出参时，由系统上报。 | 123| globalY<sup>20+</sup> | number | 否 | 是 | 该鼠标事件以主屏左上角为原点的全局坐标系的Y坐标。<!--Del-->作为入参时，若接口参数中的[MouseEventData.useGlobalCoordinate](./js-apis-inputeventclient-sys.md#mouseeventdata11)为true，该值必填，当前仅支持整数。若为false，该值无需填写，使用指定屏幕左上角为原点的相对坐标系的Y坐标计算注入事件。<!--DelEnd-->作为出参时，由系统上报。 |