# PanGesture
滑动手势事件，当滑动的最小距离达到设定的最小值时触发滑动手势事件。
> **说明：**
>
> 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
## 接口
PanGesture(value?: { fingers?: number, direction?: PanDirection, distance?: number } | [PanGestureOptions](#pangestureoptions))
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
**参数：**
| 参数名称 | 参数类型 | 必填 | 参数描述 |
| -------- | -------- | -------- | -------- |
| fingers | number | 否 | 用于指定触发滑动的最少手指数，最小为1指， 最大取值为10指。
默认值：1
取值范围：[1,10]
**说明：**
当设置的值小于1或不设置时，会被转化为默认值。 |
| direction | [PanDirection](#pandirection枚举说明) | 否 | 用于指定触发滑动的手势方向，此枚举值支持逻辑与(&)和逻辑或（\|）运算。
默认值：PanDirection.All |
| distance | number | 否 | 用于指定触发滑动手势事件的最小滑动距离，单位为vp。
默认值：5
**说明：**
[Tabs组件](ts-container-tabs.md)滑动与该滑动手势事件同时存在时，可将distance值设为1，使滑动更灵敏，避免造成事件错乱。
当设定的值小于0时，按默认值5处理。 |
## PanDirection枚举说明
与SwipeDirection不同，PanDirection没有角度限制。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
| 名称 | 描述 |
| -------- | -------- |
| All | 所有方向。 |
| Horizontal | 水平方向。 |
| Vertical | 竖直方向。 |
| Left | 向左滑动。 |
| Right | 向右滑动。 |
| Up | 向上滑动。 |
| Down | 向下滑动。 |
| None | 任何方向都不可触发滑动手势事件。 |
## PanGestureOptions
通过PanGestureOptions对象接口可以动态修改平移手势识别器的属性，从而避免通过状态变量修改属性（状态变量修改会导致UI刷新）。
PanGestureOptions(value?: { fingers?: number, direction?: PanDirection, distance?: number })
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
**参数：**
| 参数名称 | 参数类型 | 必填 | 参数描述 |
| --------- | ------------------------------------- | ---- | ------------------------------------------------------------ |
| fingers | number | 否 | 用于指定触发滑动的最少手指数，最小为1指， 最大取值为10指。
默认值：1 |
| direction | [PanDirection](#pandirection枚举说明) | 否 | 用于指定设置滑动方向，此枚举值支持逻辑与(&)和逻辑或（\|）运算。
默认值：PanDirection.All |
| distance | number | 否 | 用于指定触发滑动手势事件的最小滑动距离，单位为vp。
默认值：5
**说明：**
[Tabs组件](ts-container-tabs.md)滑动与该滑动手势事件同时存在时，可将distance值设为1，使滑动更灵敏，避免造成事件错乱。
当设定的值小于0时，按默认值5处理。
建议设置合理的滑动距离，滑动距离设置过大时会导致滑动不跟手（响应时延慢）的问题。 |
**接口**
| 名称 | 功能描述 |
| -------- | -------- |
| setDirection(value: [PanDirection](#pandirection枚举说明)) | 设置direction属性。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。|
| setDistance(value: number) | 设置distance属性。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。 |
| setFingers(value: number) | 设置fingers属性。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。|
| getDirection()12+: [PanDirection](#pandirection枚举说明) | 获取direction属性。
**原子化服务API：** 从API version 12开始，该接口支持在原子化服务中使用。|
## 事件
| 名称 | 功能描述 |
| -------- | -------- |
| onActionStart(event: (event: [GestureEvent](ts-gesture-settings.md#gestureevent对象说明)) => void) | Pan手势识别成功回调。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。|
| onActionUpdate(event: (event: [GestureEvent](ts-gesture-settings.md#gestureevent对象说明)) => void) | Pan手势移动过程中回调。
fingerList为多根手指时，该回调监听每次只会更新一根手指的位置信息。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。|
| onActionEnd(event: (event: [GestureEvent](ts-gesture-settings.md#gestureevent对象说明)) => void) | Pan手势识别成功，手指抬起后触发回调。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。|
| onActionCancel(event: () => void) | Pan手势识别成功，接收到触摸取消事件触发回调。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。|
## 属性
| 名称 | 类型 |描述 |
| ---- | ------ | ---------------------------------------- |
| tag11+ | string | 设置Pan手势标志，用于自定义手势判定时区分绑定的手势。
**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。|
| allowedTypes14+ | Array\<[SourceTool](ts-gesture-settings.md#sourcetool枚举说明9)> | 设置Pan手势支持的事件输入源。
**原子化服务API：** 从API version 14开始，该接口支持在原子化服务中使用。 |
## 示例
该示例通过PanGesture实现了单指/双指滑动手势的识别。
```ts
// xxx.ets
@Entry
@Component
struct PanGestureExample {
@State offsetX: number = 0
@State offsetY: number = 0
@State positionX: number = 0
@State positionY: number = 0
private panOption: PanGestureOptions = new PanGestureOptions({ direction: PanDirection.Left | PanDirection.Right })
build() {
Column() {
Column() {
Text('PanGesture offset:\nX: ' + this.offsetX + '\n' + 'Y: ' + this.offsetY)
}
.height(200)
.width(300)
.padding(20)
.border({ width: 3 })
.margin(50)
.translate({ x: this.offsetX, y: this.offsetY, z: 0 }) // 以组件左上角为坐标原点进行移动
// 左右滑动触发该手势事件
.gesture(
PanGesture(this.panOption)
.onActionStart((event: GestureEvent) => {
console.info('Pan start')
})
.onActionUpdate((event: GestureEvent) => {
if (event) {
this.offsetX = this.positionX + event.offsetX
this.offsetY = this.positionY + event.offsetY
}
})
.onActionEnd((event: GestureEvent) => {
this.positionX = this.offsetX
this.positionY = this.offsetY
console.info('Pan end')
})
)
Button('修改PanGesture触发条件')
.onClick(() => {
// 将PanGesture手势事件触发条件改为双指以任意方向滑动
this.panOption.setDirection(PanDirection.All)
this.panOption.setFingers(2)
})
}
}
}
```
示意图：
向左滑动：
点击按钮修改PanGesture触发条件，双指向左下方滑动：
