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