1# PinchGesture
2
3用于触发捏合手势，触发捏合手势的最少手指为2指，最大为5指，最小识别距离为5vp。
4
5>  **说明：**
6>
7>  从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
8
9
10## 接口
11
12PinchGesture(value?: { fingers?: number, distance?: number })
13
14**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
15
16**参数：**
17
18| 参数名称 | 参数类型 | 必填 | 参数描述 |
19| -------- | -------- | -------- | -------- |
20| fingers | number | 否 | 触发捏合的最少手指数,&nbsp;最小为2指，最大为5指。<br/>默认值：2 <br/>触发手势手指可以多于fingers数目，但只有先落下的与fingers相同数目的手指参与手势计算。 |
21| distance | number | 否 | 最小识别距离，单位为vp。<br/>默认值：5 <br/>**说明：** <br/> 当识别距离的值小于等于0时，会被转化为默认值。|
22
23
24## 事件
25
26| 名称 | 功能描述 |
27| -------- | -------- |
28| onActionStart(event:(event:&nbsp;[GestureEvent](ts-gesture-settings.md#gestureevent对象说明))&nbsp;=&gt;&nbsp;void) | Pinch手势识别成功回调。 <br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。|
29| onActionUpdate(event:(event:&nbsp;[GestureEvent](ts-gesture-settings.md#gestureevent对象说明))&nbsp;=&gt;&nbsp;void) | Pinch手势移动过程中回调。 <br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。|
30| onActionEnd(event:(event:&nbsp;[GestureEvent](ts-gesture-settings.md#gestureevent对象说明))&nbsp;=&gt;&nbsp;void) | Pinch手势识别成功，手指抬起后触发回调。 <br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。|
31| onActionCancel(event:&nbsp;()&nbsp;=&gt;&nbsp;void) | Pinch手势识别成功，接收到触摸取消事件触发回调。<br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。|
32
33## 属性
34
35| 名称 | 类型    |描述                                        |
36| ----  | ------  | ---------------------------------------- |
37| tag<sup>11+</sup>   | string  | 设置Pinch手势标志，用于自定义手势判定时区分绑定的手势。<br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。|
38| allowedTypes<sup>14+</sup> | Array\<[SourceTool](ts-gesture-settings.md#sourcetool枚举说明9)> | 设置Pinch手势支持的事件输入源。<br/>**原子化服务API：** 从API version 14开始，该接口支持在原子化服务中使用。 |
39
40## 示例
41
42该示例通过配置PinchGesture实现了三指捏合手势的识别。
43
44```ts
45// xxx.ets
46@Entry
47@Component
48struct PinchGestureExample {
49  @State scaleValue: number = 1
50  @State pinchValue: number = 1
51  @State pinchX: number = 0
52  @State pinchY: number = 0
53
54  build() {
55    Column() {
56      Column() {
57        Text('PinchGesture scale:\n' + this.scaleValue)
58        Text('PinchGesture center:\n(' + this.pinchX + ',' + this.pinchY + ')')
59      }
60      .height(200)
61      .width(300)
62      .padding(20)
63      .border({ width: 3 })
64      .margin({ top: 100 })
65      .scale({ x: this.scaleValue, y: this.scaleValue, z: 1 })
66      // 三指捏合触发该手势事件
67      .gesture(
68      PinchGesture({ fingers: 3 })
69        .onActionStart((event: GestureEvent) => {
70          console.info('Pinch start')
71        })
72        .onActionUpdate((event: GestureEvent) => {
73          if (event) {
74            this.scaleValue = this.pinchValue * event.scale
75            this.pinchX = event.pinchCenterX
76            this.pinchY = event.pinchCenterY
77          }
78        })
79        .onActionEnd((event: GestureEvent) => {
80          this.pinchValue = this.scaleValue
81          console.info('Pinch end')
82        })
83      )
84    }.width('100%')
85  }
86}
87```
88
89 ![zh-cn_image_0000001174582848](figures/zh-cn_image_0000001174582848.png)
90