绑定手势方法

为组件绑定不同类型的手势事件，并设置事件的响应方法。

说明：

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

绑定手势识别

通过如下属性给组件绑定手势识别，手势识别成功后可以通过事件回调通知组件。可以通过触摸热区指定可识别手势的区域。

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

名称	参数类型	默认值	描述
gesture	gesture: GestureType, mask?: GestureMask	gesture: -， mask: GestureMask.Normal	绑定手势。 - gesture: 绑定的手势类型。 - mask: 事件响应设置。
priorityGesture	gesture: GestureType, mask?: GestureMask	gesture: -， mask: GestureMask.Normal	绑定优先识别手势。 - gesture: 绑定的手势类型。 - mask: 事件响应设置。 1、默认情况下，子组件优先识别通过gesture绑定的手势，当父组件配置priorityGesture时，父组件优先识别priorityGesture绑定的手势。 2、长按手势时，设置触发长按的最短时间小的组件会优先响应，会忽略priorityGesture设置。
parallelGesture	gesture: GestureType, mask?: GestureMask	gesture: -， mask: GestureMask.Normal	绑定可与子组件手势同时触发的手势。 - gesture: 绑定的手势类型。 - mask: 事件响应设置。手势事件为非冒泡事件。父组件设置parallelGesture时，父子组件相同的手势事件都可以触发，实现类似冒泡效果。

GestureType

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称	描述
TapGesture	点击手势，支持单次点击、多次点击识别。
LongPressGesture	长按手势。
PanGesture	平移手势，滑动最小距离为5vp时识别成功。
PinchGesture	捏合手势。
RotationGesture	旋转手势。
SwipeGesture	滑动手势，滑动最小速度为100vp/s时识别成功。
GestureGroup	手势识别组，多种手势组合为复合手势，支持连续识别、并行识别和互斥识别。

GestureMask枚举说明

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称	描述
Normal	不屏蔽子组件的手势，按照默认手势识别顺序进行识别。
IgnoreInternal	屏蔽子组件的手势，包括子组件上系统内置的手势，如子组件为List组件时，内置的滑动手势同样会被屏蔽。若父子组件区域存在部分重叠，则只会屏蔽父子组件重叠的部分。

响应手势事件

组件通过手势事件绑定不同GestureType的手势对象，各手势对象在响应手势操作的事件回调中提供手势相关信息。下面通过TapGesture手势对象的onAction事件响应点击事件，获取事件相关信息。其余手势对象的事件定义见各个手势对象章节。若需绑定多种手势，请使用组合手势。

TapGesture事件说明

名称	功能描述
onAction((event:GestureEvent) => void)	Tap手势识别成功回调。

GestureEvent对象说明

继承于BaseEvent。

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称	类型	必填	描述
repeat	boolean	是	是否为重复触发事件，用于LongPressGesture手势触发场景。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
offsetX	number	是	手势事件偏移量X，单位为vp，用于PanGesture手势触发场景，从左向右滑动offsetX为正，反之为负。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
offsetY	number	是	手势事件偏移量Y，单位为vp，用于PanGesture手势触发场景，从上向下滑动offsetY为正，反之为负。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
angle	number	是	用于RotationGesture手势触发场景时，表示旋转角度。用于SwipeGesture手势触发场景时，表示滑动手势的角度，即两根手指间的线段与水平方向的夹角变化的度数。说明：角度计算方式：滑动手势被识别到后，连接两根手指之间的线被识别为起始线条，随着手指的滑动，手指之间的线条会发生旋转，根据起始线条两端点和当前线条两端点的坐标，使用反正切函数分别计算其相对于水平方向的夹角，最后arctan2(cy2-cy1,cx2-cx1)-arctan2(y2-y1,x2-x1)为旋转的角度。以起始线条为坐标系，顺时针旋转为0到180度，逆时针旋转为-180到0度。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
scale	number	是	缩放比例，用于PinchGesture手势触发场景。取值范围：[0, +∞) 原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
pinchCenterX	number	是	捏合手势中心点的x轴坐标，单位为vp，用于PinchGesture手势触发场景。取值范围：[0, +∞) 原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
pinchCenterY	number	是	捏合手势中心点的y轴坐标，单位为vp，用于PinchGesture手势触发场景。取值范围：[0, +∞) 原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
speed⁸⁺	number	是	滑动手势速度，即所有手指相对当前组件元素原始区域滑动的平均速度，单位为vp/秒，用于SwipeGesture手势触发场景。取值范围：[0, +∞) 原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
fingerList⁸⁺	FingerInfo[]	是	输入源为触屏产生的手势，fingerList中会包含触发事件的所有触点信息；由鼠标发起的手势，fingerList中只会有一条记录；触摸板的事件大类与鼠标一致，所以由触摸板发起的手势，fingerList只会携带一条记录。说明：手指索引编号与位置对应，即fingerList[index]的id为index。先按下且未参与当前手势触发的手指在fingerList中对应位置为空。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
fingerInfos²⁰⁺	FingerInfo[]	否	由触屏产生的手势，fingerInfos中会包含触发事件的所有触点信息；由鼠标发起的手势，fingerInfos中只会有一条记录；触摸板的事件大类与鼠标一致，所以由触摸板发起的手势，fingerInfos只会携带一条记录。说明： fingerInfos只会记录参与触摸的有效手指信息，先按下但未参与当前手势触发的手指在fingerInfos中不会显示。默认值为空数组[]，返回空数组时，表示当前无有效触点信息。原子化服务API：从API version 20开始，该接口支持在原子化服务中使用。
velocityX¹⁰⁺	number	是	用于PanGesture手势中，获取当前手势的x轴方向速度。坐标轴原点为屏幕左上角，分正负方向速度，从左往右为正，反之为负。单位为vp/s。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
velocityY¹⁰⁺	number	是	用于PanGesture手势中，获取当前手势的y轴方向速度。坐标轴原点为屏幕左上角，分正负方向速度，从上往下为正，反之为负。单位为vp/s。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
velocity¹⁰⁺	number	是	用于PanGesture手势中，获取当前手势的主方向速度。为xy轴方向速度的平方和的算术平方根。单位为vp/s。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
tapLocation²⁰⁺	EventLocationInfo	是	用于点击手势中，获取当前手势的坐标信息。取值范围：[0, +∞) 原子化服务API：从API version 20开始，该接口支持在原子化服务中使用。

SourceType枚举说明⁸⁺

原子化服务API： 从API version 11开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称	描述
Unknown	未知设备。
Mouse	鼠标。
TouchScreen	触摸屏。

FingerInfo对象说明⁸⁺

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称	类型	描述
id	number	手指的索引编号。取值范围：[0, +∞) 原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
globalX	number	相对于应用窗口左上角的x轴坐标，单位为vp。取值范围：[0, +∞) 原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
globalY	number	相对于应用窗口左上角的y轴坐标，单位为vp。取值范围：[0, +∞) 原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
localX	number	相对于当前组件元素原始区域左上角的x轴坐标，单位为vp。取值范围：[0, +∞) 原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
localY	number	相对于当前组件元素原始区域左上角的y轴坐标，单位为vp。取值范围：[0, +∞) 原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
displayX¹²⁺	number	相对于屏幕左上角的x轴坐标，单位为vp。取值范围：[0, +∞) 原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
displayY¹²⁺	number	相对于屏幕左上角的y轴坐标，单位为vp。取值范围：[0, +∞) 原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
hand¹⁵⁺	InteractionHand	表示事件是由左手点击还是右手点击触发。原子化服务API：从API version 15开始，该接口支持在原子化服务中使用。

SourceTool枚举说明⁹⁺

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称	描述
Unknown	未知输入源。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
Finger	手指输入。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
Pen	手写笔输入。原子化服务API：从API version 11开始，该接口支持在原子化服务中使用。
MOUSE¹²⁺	鼠标输入。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
TOUCHPAD¹²⁺	触控板输入。触控板单指输入被视为鼠标输入操作。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。
JOYSTICK¹²⁺	手柄输入。原子化服务API：从API version 12开始，该接口支持在原子化服务中使用。

InteractionHand枚举说明¹⁵⁺

定义事件是由左手点击还是右手点击触发。

原子化服务API： 从API version 15开始，该接口支持在原子化服务中使用。

系统能力： SystemCapability.ArkUI.ArkUI.Full

名称	描述
NONE	未知。
LEFT	左手。
RIGHT	右手。

示例

示例1(父组件优先识别手势和父子组件同时触发手势)

该示例通过配置priorityGesture和parallelGesture分别实现了父组件优先识别手势和父子组件同时触发手势。

// xxx.ets
@Entry
@Component
struct GestureSettingsExample {
  @State priorityTestValue: string = ''
  @State parallelTestValue: string = ''

  build() {
    Column() {
      Column() {
        Text('TapGesture:' + this.priorityTestValue).fontSize(28)
          .gesture(
            TapGesture()
              .onAction((event: GestureEvent) => {
                this.priorityTestValue += '\nText'
              }))
      }
      .height(200)
      .width(250)
      .padding(20)
      .margin(20)
      .border({ width: 3 })
      // 设置为priorityGesture时，点击文本会忽略Text组件的TapGesture手势事件，优先识别父组件Column的TapGesture手势事件
      .priorityGesture(
        TapGesture()
          .onAction((event: GestureEvent) => {
            this.priorityTestValue += '\nColumn'
          }), GestureMask.IgnoreInternal)

      Column() {
        Text('TapGesture:' + this.parallelTestValue).fontSize(28)
          .gesture(
            TapGesture()
              .onAction((event: GestureEvent) => {
                this.parallelTestValue += '\nText'
              }))
      }
      .height(200)
      .width(250)
      .padding(20)
      .margin(20)
      .border({ width: 3 })
      // 设置为parallelGesture时，点击文本会同时触发子组件Text与父组件Column的TapGesture手势事件
      .parallelGesture(
        TapGesture()
          .onAction((event: GestureEvent) => {
            this.parallelTestValue += '\nColumn'
          }), GestureMask.Normal)
    }
  }
}

zh-cn_image_0000001210195016

示例2（实时监测参与滑动手势的有效触点数量）

该示例通过配置fingerInfos实时监测参与滑动手势的有效触点数量

// xxx.ets
@Entry
@Component

struct PanGestureWithFingerCount {
  @State offsetX: number = 0
  @State offsetY: number = 0
  @State positionX: number = 0
  @State positionY: number = 0
  @State fingerCount: number = 0  //用于记录参与手势的触点数量

  private panOption: PanGestureOptions = new PanGestureOptions({
    direction: PanDirection.All,
    fingers: 1
  })

  build() {
    Column() {
      // 显示当前有效触点数量
      Text(`触点数量: ${this.fingerCount}`)
        .fontSize(20)
        .margin(10)

      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')
            this.fingerCount = event.fingerInfos?.length||0  // 记录触点数量
          })
          .onActionUpdate((event: GestureEvent) => {
            if (event) {
              console.log('fingerInfos',JSON.stringify(event.fingerInfos))
              this.offsetX = this.positionX + event.offsetX
              this.offsetY = this.positionY + event.offsetY
              this.fingerCount = event.fingerInfos?.length||0  // 更新触点数量,记录下参与当前手势的有效触点的数量
            }
          })
          .onActionEnd((event: GestureEvent) => {
            this.positionX = this.offsetX
            this.positionY = this.offsetY
            this.fingerCount = 0  // 触点离开触摸区域后归零
            console.info('Pan end')
          })
          .onActionCancel(() => {
            this.fingerCount = 0  // 手势取消后归零
          })
      )

      Button('切换为双指滑动')
        .onClick(() => {
          this.panOption.setFingers(2)
        })
    }
  }
}