1# SwipeGesture
2
3用于触发滑动事件，滑动速度大于100vp/s时可识别成功。
4
5>  **说明：**
6>
7>  从API Version 8开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。
8
9
10## 接口
11
12SwipeGesture(value?: { fingers?: number, direction?: SwipeDirection, speed?: number })
13
14**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
15
16**参数：**
17
18| 参数名称 | 参数类型 | 必填 | 参数描述 |
19| -------- | -------- | -------- | -------- |
20| fingers | number | 否 | 触发滑动的最少手指数，默认为1，最小为1指，最大为10指。<br/>默认值：1 |
21| direction | [SwipeDirection](#swipedirection枚举说明) | 否 | 触发滑动手势的滑动方向。<br/>默认值：SwipeDirection.All |
22| speed | number | 否 | 识别滑动的最小速度。<br/>默认值：100VP/s <br/>**说明：** <br/>当滑动速度的值小于等于0时，会被转化为默认值。 |
23
24## SwipeDirection枚举说明
25
26**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。
27
28| 名称 | 描述 |
29| -------- | -------- |
30| All | 所有方向。 |
31| Horizontal | 水平方向，手指滑动方向与x轴夹角小于45度时触发。 |
32| Vertical | 竖直方向，手指滑动方向与y轴夹角小于45度时触发。 |
33| None | 任何方向均不可触发。 |
34
35
36## 事件
37
38| 名称 | 功能描述 |
39| -------- | -------- |
40| onAction(event:(event:&nbsp;[GestureEvent](ts-gesture-settings.md#gestureevent对象说明))&nbsp;=&gt;&nbsp;void) | Swipe手势识别成功回调。 <br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。|
41
42## 属性
43
44| 名称 | 类型    |描述                                        |
45| ----  | ------  | ---------------------------------------- |
46| tag<sup>11+</sup>   | string  | 设置Swipe手势标志，用于自定义手势判定时区分绑定的手势。<br/>**原子化服务API：** 从API version 11开始，该接口支持在原子化服务中使用。|
47| allowedTypes<sup>14+</sup> | Array\<[SourceTool](ts-gesture-settings.md#sourcetool枚举说明9)> | 设置Swipe手势支持的事件输入源。<br/>**原子化服务API：** 从API version 14开始，该接口支持在原子化服务中使用。 |
48
49## 示例
50
51该示例通过配置SwipeGesture实现了滑动手势的识别。
52
53```ts
54// xxx.ets
55@Entry
56@Component
57struct SwipeGestureExample {
58  @State rotateAngle: number = 0
59  @State speed: number = 1
60
61  build() {
62    Column() {
63      Column() {
64        Text("SwipeGesture speed\n" + this.speed)
65        Text("SwipeGesture angle\n" + this.rotateAngle)
66      }
67      .border({ width: 3 })
68      .width(300)
69      .height(200)
70      .margin(100)
71      .rotate({ angle: this.rotateAngle })
72      // 单指竖直方向滑动时触发该事件
73      .gesture(
74      SwipeGesture({ direction: SwipeDirection.Vertical })
75        .onAction((event: GestureEvent) => {
76          if (event) {
77            this.speed = event.speed
78            this.rotateAngle = event.angle
79          }
80        })
81      )
82    }.width('100%')
83  }
84}
85```
86
87 ![zh-cn_image_0000001231374559.png](figures/zh-cn_image_0000001231374559.png)