• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# RotationGesture
2
3**RotationGesture** is used to trigger a rotation gesture, which requires two to five fingers with a minimum 1-degree rotation angle.
4
5>  **NOTE**
6>
7>  This gesture is supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version.
8
9
10## APIs
11
12RotationGesture(value?: { fingers?: number, angle?: number })
13
14**Parameters**
15
16| Name| Type| Mandatory| Description|
17| -------- | -------- | -------- | -------- |
18| fingers | number | No| Minimum number of fingers to trigger a rotation. The value ranges from 2 to 5.<br>Default value: **2**|
19| angle | number | No| Minimum degree that can trigger the rotation gesture.<br>Default value: **1**|
20
21
22## Events
23
24| Parameter| Description|
25| -------- | -------- |
26| onActionStart(event:(event?: [GestureEvent](ts-gesture-settings.md#gestureevent)) =&gt; void) | Triggered when a rotation gesture is recognized.|
27| onActionUpdate(event:(event?: [GestureEvent](ts-gesture-settings.md#gestureevent)) =&gt; void) | Triggered when the user moves the finger in a rotation gesture on the screen.|
28| onActionEnd(event:(event?: [GestureEvent](ts-gesture-settings.md#gestureevent)) =&gt; void) | Triggered when the finger used for the rotation gesture is lift.|
29| onActionCancel(event: () =&gt; void) | Triggered when a tap cancellation event is received after the rotation gesture is recognized.|
30
31
32## Example
33
34```ts
35// xxx.ets
36@Entry
37@Component
38struct RotationGestureExample {
39  @State angle: number = 0
40  @State rotateValue: number = 0
41
42  build() {
43    Column() {
44      Column() {
45        Text('RotationGesture angle:' + this.angle)
46      }
47      .height(200)
48      .width(300)
49      .padding(20)
50      .border({ width: 3 })
51      .margin(80)
52      .rotate({ angle: this.angle })
53      // The gesture event is triggered by rotating with two fingers.
54      .gesture(
55      RotationGesture()
56        .onActionStart((event: GestureEvent) => {
57          console.info('Rotation start')
58        })
59        .onActionUpdate((event: GestureEvent) => {
60          this.angle = this.rotateValue + event.angle
61        })
62        .onActionEnd(() => {
63          this.rotateValue = this.angle
64          console.info('Rotation end')
65        })
66      )
67    }.width('100%')
68  }
69}
70```
71
72 ![en-us_image_0000001174264372](figures/en-us_image_0000001174264372.png)
73