PanGesture

用于触发拖动手势事件，滑动的最小距离为5vp时拖动手势识别成功。

说明： 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。

接口

PanGesture(value?: { fingers?: number, direction?: PanDirection, distance?: number } | PanGestureOptions)

参数：

参数名称 参数类型 必填 参数描述
fingers number 否 触发拖动的最少手指数，最小为1指， 最大取值为10指。
默认值：1
direction PanDirection 否 触发拖动的手势方向，此枚举值支持逻辑与(&)和逻辑或（|）运算。
默认值：PanDirection.All
distance number 否 最小拖动识别距离，单位为vp。
默认值：5.0
说明：
> tab滑动与该拖动手势事件同时存在时，可将distance值设为1，使拖动更灵敏，避免造成事件错乱。

PanDirection枚举说明

名称 描述
All 所有方向。
Horizontal 水平方向。
Vertical 竖直方向。
Left 向左拖动。
Right 向右拖动。
Up 向上拖动。
Down 向下拖动。
None 任何方向都不可触发拖动手势事件。

PanGestureOptions

通过PanGestureOptions对象接口可以动态修改滑动手势识别器的属性，从而避免通过状态变量修改属性（状态变量修改会导致UI刷新）。

PanGestureOptions(options?: { fingers?: number, direction?: PanDirection, distance?: number })

参数：

同PanGesture参数说明。

接口：

名称 功能描述
setDirection(value: PanDirection) 设置direction属性。
setDistance(value: number) 设置distance属性。
setFingers(value: number) 设置fingers属性。

事件

名称 功能描述
onActionStart(event: (event?: GestureEvent) => void) Pan手势识别成功回调。
onActionUpdate(event: (event?: GestureEvent) => void) Pan手势移动过程中回调。
onActionEnd(event: (event?: GestureEvent) => void) Pan手势识别成功，手指抬起后触发回调。
onActionCancel(event: () => void) Pan手势识别成功，接收到触摸取消事件触发回调。

示例

// xxx.ets
@Entry
@Component
struct PanGestureExample {
  @State offsetX: number = 0
  @State offsetY: number = 0

  build() {
    Flex({ direction: FlexDirection.Column, alignItems: ItemAlign.Center, justifyContent: FlexAlign.SpaceBetween }) {
      Text('PanGesture offset:\nX: ' + this.offsetX + '\n' + 'Y: ' + this.offsetY)
    }
    .height(100).width(200).padding(20).border({ width: 1 }).margin(80)
    .translate({ x: this.offsetX, y: this.offsetY, z: 5 })
    .gesture(
      PanGesture({})
        .onActionStart((event: GestureEvent) => {
          console.info('Pan start')
        })
        .onActionUpdate((event: GestureEvent) => {
          this.offsetX = event.offsetX
          this.offsetY = event.offsetY
        })
        .onActionEnd(() => {
          console.info('Pan end')
        })
    )
  }
}

zh-cn_image_0000001174264374