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