• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 设置组件绑定的手势
2<!--Kit: ArkUI-->
3<!--Subsystem: ArkUI-->
4<!--Owner: @jiangtao92-->
5<!--Designer: @piggyguy-->
6<!--Tester: @songyanhong-->
7<!--Adviser: @HelloCrease-->
8
9用于设置组件绑定的手势。可以通过UIGestureEvent对象调用其接口添加或删除手势。
10
11>**说明:**
12>
13>本模块首批接口从API version 12开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。
14>
15>  在[GestureEvent](ts-gesture-common.md#gestureevent对象说明)的fingerList元素中,手指索引编号与位置相对应,即fingerList[index]的id为index。对于先按下但未参与当前手势触发的手指,fingerList中对应的位置为空。建议优先使用fingerInfos。
16
17## UIGestureEvent
18
19用于设置组件绑定的手势。
20
21### addGesture
22
23addGesture\<T>(gesture: GestureHandler\<T>, priority?: GesturePriority, mask?: GestureMask): void
24
25添加手势。
26
27**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
28
29**系统能力:** SystemCapability.ArkUI.ArkUI.Full
30
31**参数:**
32
33| 参数名 | 类型   | 必填 | 说明                       |
34| ------ | ------ | ---- | -------------------------- |
35| gesture  |  [GestureHandler\<T>](./ts-gesturehandler.md#gesturehandlert) | 是   | 手势处理器对象。 |
36| priority  |  [GesturePriority](./ts-gesturehandler.md#gesturepriority枚举说明) | 否   | 绑定手势的优先级。<br>默认值:GesturePriority.NORMAL |
37| mask  |  [GestureMask](./ts-gesture-common.md#gesturemask11枚举说明) | 否   | 事件响应设置。<br>默认值:GestureMask.Normal |
38
39### addParallelGesture
40
41addParallelGesture\<T>(gesture: GestureHandler\<T>, mask?: GestureMask): void
42
43绑定可与子组件手势同时触发的手势。
44
45**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
46
47**系统能力:** SystemCapability.ArkUI.ArkUI.Full
48
49**参数:**
50
51| 参数名 | 类型   | 必填 | 说明                       |
52| ------ | ------ | ---- | -------------------------- |
53| gesture  |  [GestureHandler\<T>](./ts-gesturehandler.md#gesturehandlert) | 是   | 手势处理器对象。 |
54| mask  |  [GestureMask](./ts-gesture-common.md#gesturemask11枚举说明) | 否   | 事件响应设置。<br>默认值:GestureMask.Normal |
55
56### removeGestureByTag
57
58removeGestureByTag(tag: string): void
59
60移除该组件上通过modifier绑定的设置为指定标志的手势。
61
62**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
63
64**系统能力:** SystemCapability.ArkUI.ArkUI.Full
65
66**参数:**
67
68| 参数名 | 类型   | 必填 | 说明                       |
69| ------ | ------ | ---- | -------------------------- |
70| tag  |  string | 是   | 手势处理器标志。 |
71
72### clearGestures
73
74clearGestures(): void
75
76清除该组件上通过modifier绑定的所有手势。
77
78**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
79
80**系统能力:** SystemCapability.ArkUI.ArkUI.Full
81
82## 示例
83
84见[动态手势设置](./ts-universal-attributes-gesture-modifier.md)。