1# PanGesture 2 3滑动手势事件，当滑动的最小距离达到设定的最小值时触发滑动手势事件。 4 5> **说明：** 6> 7> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 8 9 10## 接口 11 12PanGesture(value?: { fingers?: number, direction?: PanDirection, distance?: number } | [PanGestureOptions](#pangestureoptions)) 13 14**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 15 16**参数：** 17 18| 参数名称 | 参数类型 | 必填 | 参数描述 | 19| -------- | -------- | -------- | -------- | 20| fingers | number | 否 | 用于指定触发滑动的最少手指数，最小为1指， 最大取值为10指。<br/>默认值：1<br/>取值范围：[1,10]<br/>**说明：** <br/>当设置的值小于1或不设置时，会被转化为默认值。 | 21| direction | [PanDirection](#pandirection枚举说明) | 否 | 用于指定触发滑动的手势方向，此枚举值支持逻辑与(&)和逻辑或（\|）运算。<br/>默认值：PanDirection.All | 22| distance | number | 否 | 用于指定触发滑动手势事件的最小滑动距离，单位为vp。<br/>取值范围：[0, +∞)<br/>默认值：5<br/>**说明：**<br/>[Tabs组件](ts-container-tabs.md)滑动与该滑动手势事件同时存在时，可将distance值设为1，使滑动更灵敏，避免造成事件错乱。<br/>当设定的值小于0时，按默认值5处理。 | 23| isFingerCountLimited<sup>15+</sup> | boolean | 否 | 是否检查触摸屏幕的手指数量。若触摸屏幕的手指数量不等于设置的触发滑动的最少手指数（即上述fingers参数），手势将不会被识别。只有当触摸屏幕的手指数等于设置的触发滑动的最少手指数，并且滑动距离达到阈值时，手势才能被成功识别。<br>对于已成功识别的手势，后续改变触摸屏幕的手指数量不会引发[onActionUpdate](ts-basic-gestures-pangesture.md#事件)事件，但可以触发[onActionEnd](ts-basic-gestures-pangesture.md#事件)事件。<br>默认值：false。| 24 25## PanDirection枚举说明 26 27与SwipeDirection不同，PanDirection没有角度限制。 28 29**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 30 31| 名称 | 描述 | 32| -------- | -------- | 33| All | 所有方向。 | 34| Horizontal | 水平方向。 | 35| Vertical | 竖直方向。 | 36| Left | 向左滑动。 | 37| Right | 向右滑动。 | 38| Up | 向上滑动。 | 39| Down | 向下滑动。 | 40| None | 任何方向都不可触发滑动手势事件。 | 41 42 43## PanGestureOptions 44 45通过PanGestureOptions对象接口可以动态修改平移手势识别器的属性，从而避免通过状态变量修改属性（状态变量修改会导致UI刷新）。 46 47PanGestureOptions(value?: { fingers?: number, direction?: PanDirection, distance?: number }) 48 49**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 50 51**参数：** 52 53| 参数名称 | 参数类型 | 必填 | 参数描述 | 54| --------- | ------------------------------------- | ---- | ------------------------------------------------------------ | 55| fingers | number | 否 | 用于指定触发滑动的最少手指数，最小为1指， 最大取值为10指。<br/>默认值：1 | 56| direction | [PanDirection](#pandirection枚举说明) | 否 | 用于指定设置滑动方向，此枚举值支持逻辑与(&)和逻辑或（\|）运算。<br/>默认值：PanDirection.All | 57| distance | number | 否 | 用于指定触发滑动手势事件的最小滑动距离，单位为vp。<br/>默认值：5<br/>**说明：**<br/>[Tabs组件](ts-container-tabs.md)滑动与该滑动手势事件同时存在时，可将distance值设为1，使滑动更灵敏，避免造成事件错乱。<br/>当设定的值小于0时，按默认值5处理。<br/>建议设置合理的滑动距离，滑动距离设置过大时会导致滑动不跟手（响应时延慢）的问题。 | 58 59**接口** 60 61| 名称 | 功能描述 | 62| -------- | -------- | 63| setDirection(value: [PanDirection](#pandirection枚举说明)) | 设置滑动方向。 <br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 64| setDistance(value: number) | 设置触发滑动手势事件的最小滑动距离，单位为vp。<br/>取值范围：[0, +∞)<br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 | 65| setFingers(value: number) | 设置触发滑动的最少手指数。<br/>取值范围：[1, 10]，整数。 <br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 66| getDirection()<sup>12+</sup>: [PanDirection](#pandirection枚举说明) | 获取滑动方向。<br/>**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。| 67| getDistance()<sup>18+</sup>: (value: number) | 获取触发滑动手势事件的最小滑动距离。<br/>**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。| 68 69 70## 事件 71 72| 名称 | 功能描述 | 73| -------- | -------- | 74| onActionStart(event: (event: [GestureEvent](ts-gesture-settings.md#gestureevent对象说明)) => void) | Pan手势识别成功回调。 <br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 75| onActionUpdate(event: (event: [GestureEvent](ts-gesture-settings.md#gestureevent对象说明)) => void) | Pan手势移动过程中回调。<br/>fingerList为多根手指时，该回调监听每次只会更新一根手指的位置信息。 <br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 76| onActionEnd(event: (event: [GestureEvent](ts-gesture-settings.md#gestureevent对象说明)) => void) | Pan手势识别成功，手指抬起后触发回调。 <br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 77| onActionCancel(event: () => void) | Pan手势识别成功，接收到触摸取消事件触发回调。不返回手势事件信息。<br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 78| onActionCancel(event: (event: [GestureEvent](ts-gesture-settings.md#gestureevent对象说明)) => void)<sup>18+</sup> | Pan手势识别成功，接收到触摸取消事件触发回调。返回手势事件信息。<br/>**原子化服务API：** 从API version 18开始，该接口支持在原子化服务中使用。| 79 80## 属性 81 82| 名称 | 类型 |描述 | 83| ---- | ------ | ---------------------------------------- | 84| tag<sup>11+</sup> | string | 设置Pan手势标志，用于自定义手势判定时区分绑定的手势。<br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。| 85| allowedTypes<sup>14+</sup> | Array\<[SourceTool](ts-gesture-settings.md#sourcetool枚举说明9)> | 设置Pan手势支持的事件输入源。<br/>**原子化服务API：** 从API version 14开始，该接口支持在原子化服务中使用。 | 86 87## 示例 88 89该示例通过PanGesture实现了单指/双指滑动手势的识别。 90 91```ts 92// xxx.ets 93@Entry 94@Component 95struct PanGestureExample { 96 @State offsetX: number = 0 97 @State offsetY: number = 0 98 @State positionX: number = 0 99 @State positionY: number = 0 100 private panOption: PanGestureOptions = new PanGestureOptions({ direction: PanDirection.Left | PanDirection.Right }) 101 102 build() { 103 Column() { 104 Column() { 105 Text('PanGesture offset:\nX: ' + this.offsetX + '\n' + 'Y: ' + this.offsetY) 106 } 107 .height(200) 108 .width(300) 109 .padding(20) 110 .border({ width: 3 }) 111 .margin(50) 112 .translate({ x: this.offsetX, y: this.offsetY, z: 0 }) // 以组件左上角为坐标原点进行移动 113 // 左右滑动触发该手势事件 114 .gesture( 115 PanGesture(this.panOption) 116 .onActionStart((event: GestureEvent) => { 117 console.info('Pan start') 118 }) 119 .onActionUpdate((event: GestureEvent) => { 120 if (event) { 121 this.offsetX = this.positionX + event.offsetX 122 this.offsetY = this.positionY + event.offsetY 123 } 124 }) 125 .onActionEnd((event: GestureEvent) => { 126 this.positionX = this.offsetX 127 this.positionY = this.offsetY 128 console.info('Pan end') 129 }) 130 ) 131 132 Button('修改PanGesture触发条件') 133 .onClick(() => { 134 // 将PanGesture手势事件触发条件改为双指以任意方向滑动 135 this.panOption.setDirection(PanDirection.All) 136 this.panOption.setFingers(2) 137 }) 138 } 139 } 140} 141``` 142 143示意图： 144 145向左滑动： 146 147 148 149点击按钮修改PanGesture触发条件，双指向左下方滑动： 150 151 
