1# 绑定手势方法 2 3为组件绑定不同类型的手势事件，并设置事件的响应方法。 4 5> **说明：** 6> 7> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 8 9 10## 绑定手势识别 11 12通过如下属性给组件绑定手势识别，手势识别成功后可以通过事件回调通知组件。 13可以通过[触摸热区](ts-universal-attributes-touch-target.md)指定可识别手势的区域。 14 15**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 16 17| 名称 | 参数类型 | 默认值 | 描述 | 18| -------- | -------- | -------- | -------- | 19| gesture | gesture: [GestureType](#gesturetype),<br/>mask?: [GestureMask](#gesturemask枚举说明) | gesture: -，<br/>mask: GestureMask.Normal | 绑定手势。<br/>- gesture: 绑定的手势类型。 <br>- mask: 事件响应设置。 | 20| priorityGesture | gesture: [GestureType](#gesturetype),<br/>mask?: [GestureMask](#gesturemask枚举说明) | gesture: -，<br/>mask: GestureMask.Normal | 绑定优先识别手势。<br/>- gesture: 绑定的手势类型。 <br/>- mask: 事件响应设置。<br/>1、默认情况下，子组件优先识别通过gesture绑定的手势，当父组件配置priorityGesture时，父组件优先识别priorityGesture绑定的手势。<br/>2、长按手势时，设置触发长按的最短时间小的组件会优先响应，会忽略priorityGesture设置。| 21| parallelGesture | gesture: [GestureType](#gesturetype),<br/>mask?: [GestureMask](#gesturemask枚举说明) | gesture: -，<br/>mask: GestureMask.Normal | 绑定可与子组件手势同时触发的手势。<br/>- gesture: 绑定的手势类型。 <br>- mask: 事件响应设置。<br/>手势事件为非冒泡事件。父组件设置parallelGesture时，父子组件相同的手势事件都可以触发，实现类似冒泡效果。 | 22 23 24## GestureType 25 26**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 27 28| 名称 | 描述 | 29| -------- | -------- | 30| [TapGesture](ts-basic-gestures-tapgesture.md) | 点击手势，支持单次点击、多次点击识别。 | 31| [LongPressGesture](ts-basic-gestures-longpressgesture.md) | 长按手势。 | 32| [PanGesture](ts-basic-gestures-pangesture.md) | 平移手势，滑动最小距离为5vp时识别成功。 | 33| [PinchGesture](ts-basic-gestures-pinchgesture.md) | 捏合手势。 | 34| [RotationGesture](ts-basic-gestures-rotationgesture.md) | 旋转手势。 | 35| [SwipeGesture](ts-basic-gestures-swipegesture.md) | 滑动手势，滑动最小速度为100vp/s时识别成功。 | 36| [GestureGroup](ts-combined-gestures.md) | 手势识别组，多种手势组合为复合手势，支持连续识别、并行识别和互斥识别。 | 37 38 39## GestureMask枚举说明 40 41**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 42 43| 名称 | 描述 | 44| -------- | -------- | 45| Normal | 不屏蔽子组件的手势，按照默认手势识别顺序进行识别。 | 46| IgnoreInternal | 屏蔽子组件的手势，包括子组件上系统内置的手势，如子组件为List组件时，内置的滑动手势同样会被屏蔽。 若父子组件区域存在部分重叠，则只会屏蔽父子组件重叠的部分。| 47 48## 响应手势事件 49 50组件通过手势事件绑定不同GestureType的手势对象，各手势对象在响应手势操作的事件回调中提供手势相关信息。下面通过TapGesture手势对象的onAction事件响应点击事件，获取事件相关信息。其余手势对象的事件定义见各个手势对象章节。 若需绑定多种手势请使用 [组合手势](ts-combined-gestures.md)。 51 52**TapGesture事件说明** 53 54| 名称 | 功能描述 | 55| -------- | -------- | 56| onAction((event:GestureEvent) => void) | Tap手势识别成功回调。 | 57 58## GestureEvent对象说明 59 60继承于[BaseEvent](ts-gesture-customize-judge.md#baseevent对象说明8)。 61 62**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 63 64| 名称 | 类型 | 描述 | 65| -------- | -------- | -------- | 66| repeat | boolean | 是否为重复触发事件，用于LongPressGesture手势触发场景。 | 67| offsetX | number | 手势事件偏移量X，单位为vp，用于PanGesture手势触发场景，从左向右滑动offsetX为正，反之为负。 | 68| offsetY | number | 手势事件偏移量Y，单位为vp，用于PanGesture手势触发场景，从上向下滑动offsetY为正，反之为负。 | 69| angle | number | 用于RotationGesture手势触发场景时，表示旋转角度。<br/>用于SwipeGesture手势触发场景时，表示滑动手势的角度，即两根手指间的线段与水平方向的夹角变化的度数。<br/>**说明：**<br/>角度计算方式：滑动手势被识别到后，连接两根手指之间的线被识别为起始线条，随着手指的滑动，手指之间的线条会发生旋转，根据起始线条两端点和当前线条两端点的坐标，使用反正切函数分别计算其相对于水平方向的夹角，最后arctan2(cy2-cy1,cx2-cx1)-arctan2(y2-y1,x2-x1)为旋转的角度。以起始线条为坐标系，顺时针旋转为0到180度，逆时针旋转为-180到0度。 | 70| scale | number | 缩放比例，用于PinchGesture手势触发场景。<br/>取值范围：[0, +∞) | 71| pinchCenterX | number | 捏合手势中心点的x轴坐标，单位为vp，用于PinchGesture手势触发场景。<br/>取值范围：[0, +∞) | 72| pinchCenterY | number | 捏合手势中心点的y轴坐标，单位为vp，用于PinchGesture手势触发场景。<br/>取值范围：[0, +∞) | 73| speed<sup>8+</sup> | number | 滑动手势速度，即所有手指相对当前组件元素原始区域滑动的平均速度，单位为vp/秒，用于SwipeGesture手势触发场景。<br/>取值范围：[0, +∞) | 74| fingerList<sup>8+</sup> | [FingerInfo](#fingerinfo对象说明8)[] | 输入源为触屏产生的手势，fingerList中会包含触发事件的所有触点信息；由鼠标发起的手势，fingerList中只会有一条记录；触摸板的事件大类与鼠标一致，所以由触摸板发起的手势，fingerList只会携带一条记录。<br/>**说明：**<br/>手指索引编号与位置对应，即fingerList[index]的id为index。先按下且未参与当前手势触发的手指在fingerList中对应位置为空。 | 75| velocityX<sup>10+</sup> | number | 用于[PanGesture](ts-basic-gestures-pangesture.md)手势中，获取当前手势的x轴方向速度。坐标轴原点为屏幕左上角，分正负方向速度，从左往右为正，反之为负。单位为vp/s。 | 76| velocityY<sup>10+</sup> | number | 用于[PanGesture](ts-basic-gestures-pangesture.md)手势中，获取当前手势的y轴方向速度。坐标轴原点为屏幕左上角，分正负方向速度，从上往下为正，反之为负。单位为vp/s。 | 77| velocity<sup>10+</sup> | number | 用于[PanGesture](ts-basic-gestures-pangesture.md)手势中，获取当前手势的主方向速度。为xy轴方向速度的平方和的算术平方根。单位为vp/s。 | 78 79## SourceType枚举说明<sup>8+</sup> 80 81**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 82 83| 名称 | 描述 | 84| -------- | -------- | 85| Unknown | 未知设备。 | 86| Mouse | 鼠标。 | 87| TouchScreen | 触摸屏。 | 88 89## FingerInfo对象说明<sup>8+</sup> 90 91| 名称 | 类型 | 描述 | 92| -------- | -------- | -------- | 93| id | number | 手指的索引编号。<br/>取值范围：[0, +∞)<br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 94| globalX | number | 相对于应用窗口左上角的x轴坐标，单位为vp。<br/>取值范围：[0, +∞)<br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 95| globalY | number | 相对于应用窗口左上角的y轴坐标，单位为vp。<br/>取值范围：[0, +∞)<br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 96| localX | number | 相对于当前组件元素原始区域左上角的x轴坐标，单位为vp。<br/>取值范围：[0, +∞)<br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 97| localY | number | 相对于当前组件元素原始区域左上角的y轴坐标，单位为vp。<br/>取值范围：[0, +∞)<br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 98| displayX<sup>12+</sup> | number | 相对于屏幕左上角的x轴坐标，单位为vp。<br/>取值范围：[0, +∞)<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 99| displayY<sup>12+</sup> | number | 相对于屏幕左上角的y轴坐标，单位为vp。<br/>取值范围：[0, +∞)<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 100| hand<sup>15+</sup> | [InteractionHand](#interactionhand枚举说明15) | 表示事件是由左手点击还是右手点击触发。<br/>**原子化服务API：** 从API version 15开始，该接口支持在原子化服务中使用。 | 101 102## SourceTool枚举说明<sup>9+</sup> 103 104| 名称 | 描述 | 105| -------- | -------- | 106| Unknown | 未知输入源。<br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 107| Finger | 手指输入。<br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 108| Pen | 手写笔输入。<br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 109| Mouse<sup>12+</sup> | 鼠标输入。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 110| Touchpad<sup>12+</sup> | 触控板输入。触控板单指输入被视为鼠标输入操作。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 111| Joystick<sup>12+</sup> | 手柄输入。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。 | 112 113## InteractionHand枚举说明<sup>15+</sup> 114 115定义事件是由左手点击还是右手点击触发。 116 117**原子化服务API：** 从API version 15开始，该接口支持在原子化服务中使用。 118 119**系统能力：** SystemCapability.ArkUI.ArkUI.Full 120 121| 名称 | 描述 | 122| -------- | -------- | 123| NONE | 未知。 | 124| LEFT | 左手。 | 125| RIGHT | 右手。 | 126 127 128## 示例 129 130该示例通过配置priorityGesture和parallelGesture分别实现了父组件优先识别手势和父子组件同时触发手势。 131 132```ts 133// xxx.ets 134@Entry 135@Component 136struct GestureSettingsExample { 137 @State priorityTestValue: string = '' 138 @State parallelTestValue: string = '' 139 140 build() { 141 Column() { 142 Column() { 143 Text('TapGesture:' + this.priorityTestValue).fontSize(28) 144 .gesture( 145 TapGesture() 146 .onAction((event: GestureEvent) => { 147 this.priorityTestValue += '\nText' 148 })) 149 } 150 .height(200) 151 .width(250) 152 .padding(20) 153 .margin(20) 154 .border({ width: 3 }) 155 // 设置为priorityGesture时，点击文本会忽略Text组件的TapGesture手势事件，优先识别父组件Column的TapGesture手势事件 156 .priorityGesture( 157 TapGesture() 158 .onAction((event: GestureEvent) => { 159 this.priorityTestValue += '\nColumn' 160 }), GestureMask.IgnoreInternal) 161 162 Column() { 163 Text('TapGesture:' + this.parallelTestValue).fontSize(28) 164 .gesture( 165 TapGesture() 166 .onAction((event: GestureEvent) => { 167 this.parallelTestValue += '\nText' 168 })) 169 } 170 .height(200) 171 .width(250) 172 .padding(20) 173 .margin(20) 174 .border({ width: 3 }) 175 // 设置为parallelGesture时，点击文本会同时触发子组件Text与父组件Column的TapGesture手势事件 176 .parallelGesture( 177 TapGesture() 178 .onAction((event: GestureEvent) => { 179 this.parallelTestValue += '\nColumn' 180 }), GestureMask.Normal) 181 } 182 } 183} 184``` 185 186 187
