ts-basic-gestures-pangesture.md

# PanGesture

**PanGesture** is used to trigger a pan gesture, which requires a minimum 5 vp movement distance of a finger on the screen.

>  **NOTE**
>
>  This gesture is supported since API version 7. Updates will be marked with a superscript to indicate their earliest API version.


## Required Permissions

None


## APIs

PanGesture(options?: { fingers?: number, direction?: PanDirection, distance?: number } | [PanGestureOptions](#pangestureoptions))

- Parameters
  | Name| Type| Mandatory| Default Value| Description|
  | -------- | -------- | -------- | -------- | -------- |
  | fingers | number | No| 1 | Minimum number of fingers to trigger a pan gesture. The value ranges from 1 to 10.|
  | direction | PanDirection | No| All | Pan direction. The enumerated value supports the AND (&) and OR (\|)|operations.|
  | distance | number | No| 5.0 | Minimum pan distance to trigger the gesture, in vp.<br>**NOTE**<br>If a pan gesture and tab swipe occur at the same time, set **distance** to **1** so that the gesture can be more easily recognized.|

- PanDirection enums
  | Name| Description|
  | -------- | -------- |
  | All | All directions.|
  | Horizontal | Horizontal panning.|
  | Vertical | Vertical panning.|
  | Left | Panning to the left.|
  | Right | Panning to the right.|
  | Up | Panning up.|
  | Down | Panning down.|
  | None | Panning disabled.|


### PanGestureOptions

The attributes of the pan gesture recognizer can be dynamically modified using the **PanGestureOptions** API. This avoids modifying attributes through state variables, which will cause the UI to be refreshed.

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

- Parameters
  
For details, see **PanGesture**.
  
- APIs
  | Name| Description|
  | -------- | -------- |
  | setDirection(value: PanDirection) | Sets the direction.|
  | setDistance(value: number) | Sets the distance.|
  | setFingers(value: number) | Sets the number of fingers.|


## Events

| Name| Description|
| -------- | -------- |
| onActionStart(callback: (event?: GestureEvent) =&gt; void) | Callback invoked when a pan gesture is recognized.|
| onActionUpdate(callback: (event?: GestureEvent) =&gt; void) | Callback invoked when the pan gesture status is updated.|
| onActionEnd(callback: (event?: GestureEvent) =&gt; void) | Callback invoked when the finger used for a pan gesture is lift.|
| onActionCancel(callback: () =&gt; void) | Callback invoked when a tap cancellation event is received after a pan gesture is recognized.|

- GestureEvent attributes related to the pan gesture
  | Name| Type| Description|
  | -------- | -------- | -------- |
  | offsetX | number | Offset of the gesture event, in vp.|
  | offsetY | number | Offset of the gesture event, in vp.|


## Example

```ts
// 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')
        })
    )
  }
}
```

![en-us_image_0000001256978371](figures/en-us_image_0000001256978371.gif)