• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# @ohos.multimodalInput.touchEvent (触屏输入事件)
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,ToolType,SourceType,Touch,TouchEvent } from '@kit.InputKit';
20```
21
22## Action
23
24触屏事件类型。
25
26**系统能力:** SystemCapability.MultimodalInput.Input.Core
27
28| 名称     | 值   | 说明   |
29| ------ | ------ | ---- |
30| CANCEL | 0 | 触屏取消。 |
31| DOWN   | 1 | 触屏按下。 |
32| MOVE   | 2 | 触屏移动。 |
33| UP     | 3 | 触屏抬起。 |
34
35## ToolType
36
37操作触屏的工具类型。
38
39**系统能力:** SystemCapability.MultimodalInput.Input.Core
40
41| 名称       | 值   | 说明   |
42| -------- | ------ | ---- |
43| FINGER   | 0 | 手指。  |
44| PEN      | 1 | 笔。    |
45| RUBBER   | 2 | 橡皮擦。  |
46| BRUSH    | 3 | 笔刷。   |
47| PENCIL   | 4 | 铅笔。   |
48| AIRBRUSH | 5 | 气笔。   |
49| MOUSE    | 6 | 鼠标。   |
50| LENS     | 7 | 透镜。   |
51
52## SourceType
53
54触屏来源的设备类型,当前仅支持触摸屏、触控板类型上报。
55
56**系统能力:** SystemCapability.MultimodalInput.Input.Core
57
58| 名称           | 值  | 说明   |
59| ------------ | ------ | ---- |
60| TOUCH_SCREEN | 0 | 触摸屏。  |
61| PEN          | 1 | 手写笔。  |
62| TOUCH_PAD    | 2 | 触控板。  |
63
64## Touch
65
66触屏点信息。
67
68**系统能力:** SystemCapability.MultimodalInput.Input.Core
69
70| 名称          | 类型   | 只读   | 可选   | 说明                                  |
71| ----------- | ------ | ---- | ---- | ----------------------------------- |
72| id          | number | 否    | 否    | 触屏事件标识。                                |
73| pressedTime | number | 否    | 否    | 按下时间戳,单位:μs。                           |
74| screenX     | number | 否    | 否    | 该触屏事件以指定屏幕左上角为原点的相对坐标系的X坐标。当前仅支持整数。    |
75| screenY     | number | 否    | 否    | 该触屏事件以指定屏幕左上角为原点的相对坐标系的Y坐标。当前仅支持整数。    |
76| windowX     | number | 否    | 否    | 触屏所在窗口左上角为原点的相对坐标系的X坐标。当前仅支持整数。 |
77| windowY     | number | 否    | 否    | 触屏所在窗口左上角为原点的相对坐标系的Y坐标。当前仅支持整数。 |
78| pressure    | number | 否    | 否    | 压力值,取值范围是[0.0, 1.0],0.0表示不支持。       |
79| width       | number | 否    | 否    | 触屏区域的宽度。当前仅支持整数。         |
80| height      | number | 否    | 否    | 触屏区域的高度。当前仅支持整数。         |
81| tiltX       | number | 否    | 否    | 相对YZ平面的角度,取值的范围[-90, 90],其中正值是向右倾斜。 |
82| tiltY       | number | 否    | 否    | 相对XZ平面的角度,取值的范围[-90, 90],其中正值是向下倾斜。 |
83| toolX       | number | 否    | 否    | 工具区域的中心点以指定屏幕左上角为原点的相对坐标系的X坐标。当前仅支持整数。  |
84| toolY       | number | 否    | 否    | 工具区域的中心点以指定屏幕左上角为原点的相对坐标系的Y坐标。当前仅支持整数。  |
85| toolWidth   | number | 否    | 否    | 工具区域宽度。当前仅支持整数。  |
86| toolHeight  | number | 否    | 否    | 工具区域高度。当前仅支持整数。  |
87| rawX        | number | 否    | 否    | 输入设备上的X坐标。当前仅支持整数。 |
88| rawY        | number | 否    | 否    | 输入设备上的Y坐标。当前仅支持整数。 |
89| toolType    | [ToolType](#tooltype) | 否    | 否    | 工具类型。                                |
90| globalX<sup>20+</sup> | number | 否    | 是    | 该触屏事件以主屏左上角为原点的全局坐标系的X坐标。<!--Del-->作为入参时,若接口参数中的[TouchEventData.useGlobalCoordinate](./js-apis-inputeventclient-sys.md#toucheventdata11)为true,该值必填,当前仅支持整数。若为false,该值无需填写,使用指定屏幕左上角为原点的相对坐标系的X坐标计算注入事件。<!--DelEnd-->作为出参时,由系统上报。 |
91| globalY<sup>20+</sup> | number | 否    | 是    | 该触屏事件以主屏左上角为原点的全局坐标系的Y坐标。<!--Del-->作为入参时,若接口参数中的[TouchEventData.useGlobalCoordinate](./js-apis-inputeventclient-sys.md#toucheventdata11)为true,该值必填,当前仅支持整数。若为false,该值无需填写,使用指定屏幕左上角为原点的相对坐标系的Y坐标计算注入事件。<!--DelEnd-->作为出参时,由系统上报。 |
92
93## TouchEvent
94
95触屏事件。
96
97**系统能力:** SystemCapability.MultimodalInput.Input.Core
98
99| 名称         | 类型       | 只读   | 可选   | 说明        |
100| ---------- | ---------- | ---- | ---- | --------- |
101| action     | [Action](#action)     | 否    | 否    | 触屏事件类型。     |
102| touch      | [Touch](#touch)      | 否    | 否    | 当前触屏点信息。   |
103| touches    | [Touch](#touch)[]    | 否    | 否    | 所有触屏点。     |
104| sourceType | [SourceType](#sourcetype) | 否    | 否    | 触屏来源的设备类型。 |
105