1e41f4b71Sopenharmony_ci# Bound Gesture Configuration
2e41f4b71Sopenharmony_ci
3e41f4b71Sopenharmony_ciYou can set the gestures that are bound to a component. Specifically, you can add or remove gestures by calling the APIs of the **UIGestureEvent** object.
4e41f4b71Sopenharmony_ci
5e41f4b71Sopenharmony_ci>**NOTE**
6e41f4b71Sopenharmony_ci>
7e41f4b71Sopenharmony_ci>The initial APIs of this module are supported since API version 12. Newly added APIs will be marked with a superscript to indicate their earliest API version.
8e41f4b71Sopenharmony_ci
9e41f4b71Sopenharmony_ci## UIGestureEvent
10e41f4b71Sopenharmony_ci
11e41f4b71Sopenharmony_ciProvides APIs for configuring gestures bound to a component.
12e41f4b71Sopenharmony_ci
13e41f4b71Sopenharmony_ci### addGesture
14e41f4b71Sopenharmony_ci
15e41f4b71Sopenharmony_ciaddGesture(gesture: GestureHandler\<T>, priority?: GesturePriority, mask?: GestureMask): void
16e41f4b71Sopenharmony_ci
17e41f4b71Sopenharmony_ciAdds a gesture.
18e41f4b71Sopenharmony_ci
19e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
20e41f4b71Sopenharmony_ci
21e41f4b71Sopenharmony_ci**Parameters**
22e41f4b71Sopenharmony_ci
23e41f4b71Sopenharmony_ci| Name| Type  | Mandatory| Description                      |
24e41f4b71Sopenharmony_ci| ------ | ------ | ---- | -------------------------- |
25e41f4b71Sopenharmony_ci| gesture  |  [GestureHandler\<T>](#gesturehandlert) | Yes  | Gesture handler object.|
26e41f4b71Sopenharmony_ci| priority  |  [GesturePriority](#gesturepriority) | No  | Priority of the bound gesture.|
27e41f4b71Sopenharmony_ci| mask  |  [GestureMask](./ts-gesture-settings.md#gesturemask) | No  | Mask for gesture events.|
28e41f4b71Sopenharmony_ci
29e41f4b71Sopenharmony_ci### addParallelGesture
30e41f4b71Sopenharmony_ci
31e41f4b71Sopenharmony_ciaddParallelGesture(gesture: GestureHandler\<T>, mask?: GestureMask): void
32e41f4b71Sopenharmony_ci
33e41f4b71Sopenharmony_ciAdds a gesture that can be recognized at once by the component and its child component.
34e41f4b71Sopenharmony_ci
35e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
36e41f4b71Sopenharmony_ci
37e41f4b71Sopenharmony_ci**Parameters**
38e41f4b71Sopenharmony_ci
39e41f4b71Sopenharmony_ci| Name| Type  | Mandatory| Description                      |
40e41f4b71Sopenharmony_ci| ------ | ------ | ---- | -------------------------- |
41e41f4b71Sopenharmony_ci| gesture  |  [GestureHandler\<T>](#gesturehandlert) | Yes  | Gesture handler object.|
42e41f4b71Sopenharmony_ci| mask  |  [GestureMask](./ts-gesture-settings.md#gesturemask) | No  | Mask for gesture events.|
43e41f4b71Sopenharmony_ci
44e41f4b71Sopenharmony_ci### removeGestureByTag
45e41f4b71Sopenharmony_ci
46e41f4b71Sopenharmony_ciremoveGestureByTag(tag: string): void
47e41f4b71Sopenharmony_ci
48e41f4b71Sopenharmony_ciRemove a gesture from a component that has been bound with a specific tag through a modifier.
49e41f4b71Sopenharmony_ci
50e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
51e41f4b71Sopenharmony_ci
52e41f4b71Sopenharmony_ci**Parameters**
53e41f4b71Sopenharmony_ci
54e41f4b71Sopenharmony_ci| Name| Type  | Mandatory| Description                      |
55e41f4b71Sopenharmony_ci| ------ | ------ | ---- | -------------------------- |
56e41f4b71Sopenharmony_ci| tag  |  string | Yes  | Gesture processor flag.|
57e41f4b71Sopenharmony_ci
58e41f4b71Sopenharmony_ci### clearGestures
59e41f4b71Sopenharmony_ci
60e41f4b71Sopenharmony_ciclearGestures(): void
61e41f4b71Sopenharmony_ci
62e41f4b71Sopenharmony_ciClears all gestures that have been bound to the component through a modifier.
63e41f4b71Sopenharmony_ci
64e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
65e41f4b71Sopenharmony_ci
66e41f4b71Sopenharmony_ci## GestureHandler\<T>
67e41f4b71Sopenharmony_ci
68e41f4b71Sopenharmony_ciDefines the basic type of the gesture handler.
69e41f4b71Sopenharmony_ci
70e41f4b71Sopenharmony_ci### tag
71e41f4b71Sopenharmony_ci
72e41f4b71Sopenharmony_citag(tag: string): T
73e41f4b71Sopenharmony_ci
74e41f4b71Sopenharmony_ciSets the tag for the gesture handler.
75e41f4b71Sopenharmony_ci
76e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
77e41f4b71Sopenharmony_ci
78e41f4b71Sopenharmony_ci**Parameters**
79e41f4b71Sopenharmony_ci
80e41f4b71Sopenharmony_ci| Name| Type| Mandatory|Description                                       |
81e41f4b71Sopenharmony_ci| ----  | ------  | ------|---------------------------------- |
82e41f4b71Sopenharmony_ci| tag   | string  | Yes|Tag of the gesture handler.|
83e41f4b71Sopenharmony_ci
84e41f4b71Sopenharmony_ci## TapGestureHandler
85e41f4b71Sopenharmony_ci
86e41f4b71Sopenharmony_ciDefines a type of gesture handler object for tap gestures.
87e41f4b71Sopenharmony_ci
88e41f4b71Sopenharmony_ci### constructor
89e41f4b71Sopenharmony_ci
90e41f4b71Sopenharmony_ciconstructor(options?: TapGestureHandlerOptions)
91e41f4b71Sopenharmony_ci
92e41f4b71Sopenharmony_ciA constructor used to create a **TapGestureHandler** object.
93e41f4b71Sopenharmony_ci
94e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
95e41f4b71Sopenharmony_ci
96e41f4b71Sopenharmony_ci**Parameters**
97e41f4b71Sopenharmony_ci
98e41f4b71Sopenharmony_ci| Name | Type                                                        | Mandatory| Description              |
99e41f4b71Sopenharmony_ci| ------- | ------------------------------------------------------------ | ---- | ------------------ |
100e41f4b71Sopenharmony_ci| options | [TapGestureHandlerOptions](#tapgesturehandleroptions) | No  | Parameters of the tap gesture handler.|
101e41f4b71Sopenharmony_ci
102e41f4b71Sopenharmony_ci### onAction
103e41f4b71Sopenharmony_ci
104e41f4b71Sopenharmony_cionAction(event: Callback\<GestureEvent>): TapGestureHandler
105e41f4b71Sopenharmony_ci
106e41f4b71Sopenharmony_ciInvoked when a tap gesture is recognized.
107e41f4b71Sopenharmony_ci
108e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
109e41f4b71Sopenharmony_ci
110e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
111e41f4b71Sopenharmony_ci
112e41f4b71Sopenharmony_ci**Parameters**
113e41f4b71Sopenharmony_ci
114e41f4b71Sopenharmony_ci| Name| Type                             | Mandatory| Description                |
115e41f4b71Sopenharmony_ci| ------ | --------------------------------- | ---- | -------------------- |
116e41f4b71Sopenharmony_ci| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent)> | Yes| Callback invoked when a tap gesture is recognized.|
117e41f4b71Sopenharmony_ci
118e41f4b71Sopenharmony_ci**Return value**
119e41f4b71Sopenharmony_ci
120e41f4b71Sopenharmony_ci| Type| Description|
121e41f4b71Sopenharmony_ci| -------- | -------- |
122e41f4b71Sopenharmony_ci| TapGestureHandler | Tap gesture handler object.|
123e41f4b71Sopenharmony_ci
124e41f4b71Sopenharmony_ci## TapGestureHandlerOptions
125e41f4b71Sopenharmony_ci
126e41f4b71Sopenharmony_ciProvides the parameters of the tap gesture handler.
127e41f4b71Sopenharmony_ci
128e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
129e41f4b71Sopenharmony_ci
130e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
131e41f4b71Sopenharmony_ci
132e41f4b71Sopenharmony_ci| Attributes        | Type                                  | Mandatory| Description                |
133e41f4b71Sopenharmony_ci| ------------ | -------------------------------------- | ---- | -------------------- |
134e41f4b71Sopenharmony_ci| count | number | No| Number of consecutive taps. If the value is less than 1 or is not set, the default value is used.<br>Default value: **1**<br>**NOTE**<br>1. If multi-tap is configured, the timeout interval between a lift and the next tap is 300 ms.<br>2. If the distance between the last tapped position and the current tapped position exceeds 60 vp, gesture recognition fails.|
135e41f4b71Sopenharmony_ci| fingers | number | No| Number of fingers required to trigger a tap. The value ranges from 1 to 10. If the value is less than 1 or is not set, the default value is used.<br>Default value: **1**<br>**NOTE**<br>1. If the value is greater than 1, the tap gesture will fail to be recognized when the number of fingers pressing the screen within 300 ms of the first finger's being pressed is less than the required number, or when the number of fingers lifted from the screen within 300 ms of the first finger's being lifted is less than the required number.<br>2. When the number of fingers touching the screen exceeds the set value, the gesture can be recognized.|
136e41f4b71Sopenharmony_ci
137e41f4b71Sopenharmony_ci## LongPressGestureHandler
138e41f4b71Sopenharmony_ci
139e41f4b71Sopenharmony_ciDefines a type of gesture handler object for long press gestures.
140e41f4b71Sopenharmony_ci
141e41f4b71Sopenharmony_ci### constructor
142e41f4b71Sopenharmony_ci
143e41f4b71Sopenharmony_ciconstructor(options?: LongPressGestureHandlerOptions)
144e41f4b71Sopenharmony_ci
145e41f4b71Sopenharmony_ciA constructor used to create a **LongPressGestureHandler** object.
146e41f4b71Sopenharmony_ci
147e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
148e41f4b71Sopenharmony_ci
149e41f4b71Sopenharmony_ci**Parameters**
150e41f4b71Sopenharmony_ci
151e41f4b71Sopenharmony_ci
152e41f4b71Sopenharmony_ci| Name | Type                                                        | Mandatory| Description              |
153e41f4b71Sopenharmony_ci| ------- | ------------------------------------------------------------ | ---- | ------------------ |
154e41f4b71Sopenharmony_ci| options | [LongPressGestureHandlerOptions](#longpressgesturehandleroptions) | No  | Parameters of the long press gesture handler.|
155e41f4b71Sopenharmony_ci
156e41f4b71Sopenharmony_ci### onAction
157e41f4b71Sopenharmony_ci
158e41f4b71Sopenharmony_cionAction(event: Callback\<GestureEvent>): LongPressGestureHandler
159e41f4b71Sopenharmony_ci
160e41f4b71Sopenharmony_ciInvoked when a long press gesture is recognized.
161e41f4b71Sopenharmony_ci
162e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
163e41f4b71Sopenharmony_ci
164e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
165e41f4b71Sopenharmony_ci
166e41f4b71Sopenharmony_ci**Parameters**
167e41f4b71Sopenharmony_ci
168e41f4b71Sopenharmony_ci| Name| Type                             | Mandatory| Description                |
169e41f4b71Sopenharmony_ci| ------ | --------------------------------- | ---- | -------------------- |
170e41f4b71Sopenharmony_ci| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent)> | Yes| Callback invoked when a long press gesture is recognized.|
171e41f4b71Sopenharmony_ci
172e41f4b71Sopenharmony_ci**Return value**
173e41f4b71Sopenharmony_ci
174e41f4b71Sopenharmony_ci| Type| Description|
175e41f4b71Sopenharmony_ci| -------- | -------- |
176e41f4b71Sopenharmony_ci| LongPressGestureHandler | Long press gesture handler object.|
177e41f4b71Sopenharmony_ci
178e41f4b71Sopenharmony_ci### onActionEnd
179e41f4b71Sopenharmony_ci
180e41f4b71Sopenharmony_cionActionEnd(event: Callback\<GestureEvent>): LongPressGestureHandler
181e41f4b71Sopenharmony_ci
182e41f4b71Sopenharmony_ciInvoked when the last finger is lifted after the long press gesture is recognized.
183e41f4b71Sopenharmony_ci
184e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
185e41f4b71Sopenharmony_ci
186e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
187e41f4b71Sopenharmony_ci
188e41f4b71Sopenharmony_ci**Parameters**
189e41f4b71Sopenharmony_ci
190e41f4b71Sopenharmony_ci| Name| Type                             | Mandatory| Description                |
191e41f4b71Sopenharmony_ci| ------ | --------------------------------- | ---- | -------------------- |
192e41f4b71Sopenharmony_ci| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent)> | Yes| Callback invoked when the last finger is lifted after the long press gesture is recognized.|
193e41f4b71Sopenharmony_ci
194e41f4b71Sopenharmony_ci**Return value**
195e41f4b71Sopenharmony_ci
196e41f4b71Sopenharmony_ci| Type| Description|
197e41f4b71Sopenharmony_ci| -------- | -------- |
198e41f4b71Sopenharmony_ci| LongPressGestureHandler | Long press gesture handler object.|
199e41f4b71Sopenharmony_ci
200e41f4b71Sopenharmony_ci### onActionCancel
201e41f4b71Sopenharmony_ci
202e41f4b71Sopenharmony_cionActionCancel(event: Callback\<void>): LongPressGestureHandler
203e41f4b71Sopenharmony_ci
204e41f4b71Sopenharmony_ciInvoked when a tap cancellation event is received after a long press gesture is recognized.
205e41f4b71Sopenharmony_ci
206e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
207e41f4b71Sopenharmony_ci
208e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
209e41f4b71Sopenharmony_ci
210e41f4b71Sopenharmony_ci**Parameters**
211e41f4b71Sopenharmony_ci
212e41f4b71Sopenharmony_ci| Name| Type                             | Mandatory| Description                |
213e41f4b71Sopenharmony_ci| ------ | --------------------------------- | ---- | -------------------- |
214e41f4b71Sopenharmony_ci| event  | [Callback](./ts-types.md#callback12)\<void> | Yes| Callback invoked when a tap cancellation event is received after a long press gesture is recognized.|
215e41f4b71Sopenharmony_ci
216e41f4b71Sopenharmony_ci**Return value**
217e41f4b71Sopenharmony_ci
218e41f4b71Sopenharmony_ci| Type| Description|
219e41f4b71Sopenharmony_ci| -------- | -------- |
220e41f4b71Sopenharmony_ci| LongPressGestureHandler | Long press gesture handler object.|
221e41f4b71Sopenharmony_ci
222e41f4b71Sopenharmony_ci## LongPressGestureHandlerOptions
223e41f4b71Sopenharmony_ci
224e41f4b71Sopenharmony_ciProvides the parameters of the long press gesture handler.
225e41f4b71Sopenharmony_ci
226e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
227e41f4b71Sopenharmony_ci
228e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
229e41f4b71Sopenharmony_ci
230e41f4b71Sopenharmony_ci| Attributes        | Type                                  | Mandatory| Description                |
231e41f4b71Sopenharmony_ci| ------------ | -------------------------------------- | ---- | -------------------- |
232e41f4b71Sopenharmony_ci| fingers | number | No| Minimum number of fingers to trigger a long press gesture. The value ranges from 1 to 10.<br>Default value: **1**<br> **NOTE**<br>If a finger moves more than 15 px after being pressed, the gesture recognition fails.|
233e41f4b71Sopenharmony_ci| repeat | boolean | No| Whether to continuously trigger the event callback.<br>Default value: **false**|
234e41f4b71Sopenharmony_ci| duration | number | No| Minimum hold-down time, in ms.<br>Default value: **500**<br>**NOTE**<br>If the value is less than or equal to 0, the default value <b>500</b> is used.|
235e41f4b71Sopenharmony_ci
236e41f4b71Sopenharmony_ci## PanGestureHandler
237e41f4b71Sopenharmony_ci
238e41f4b71Sopenharmony_ciDefines a type of gesture handler object for pan gestures.
239e41f4b71Sopenharmony_ci
240e41f4b71Sopenharmony_ci### constructor
241e41f4b71Sopenharmony_ci
242e41f4b71Sopenharmony_ciconstructor(options?: PanGestureHandlerOptions)
243e41f4b71Sopenharmony_ci
244e41f4b71Sopenharmony_ciA constructor used to create a **PanGestureHandler** object.
245e41f4b71Sopenharmony_ci
246e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
247e41f4b71Sopenharmony_ci
248e41f4b71Sopenharmony_ci**Parameters**
249e41f4b71Sopenharmony_ci
250e41f4b71Sopenharmony_ci
251e41f4b71Sopenharmony_ci| Name | Type                                                        | Mandatory| Description              |
252e41f4b71Sopenharmony_ci| ------- | ------------------------------------------------------------ | ---- | ------------------ |
253e41f4b71Sopenharmony_ci| options | [PanGestureHandlerOptions](#pangesturehandleroptions) | No  | Parameters of the pan gesture handler.|
254e41f4b71Sopenharmony_ci
255e41f4b71Sopenharmony_ci### onActionStart
256e41f4b71Sopenharmony_ci
257e41f4b71Sopenharmony_cionActionStart(event: Callback\<GestureEvent>): PanGestureHandler
258e41f4b71Sopenharmony_ci
259e41f4b71Sopenharmony_ciInvoked when a pan gesture is recognized.
260e41f4b71Sopenharmony_ci
261e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
262e41f4b71Sopenharmony_ci
263e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
264e41f4b71Sopenharmony_ci
265e41f4b71Sopenharmony_ci**Parameters**
266e41f4b71Sopenharmony_ci
267e41f4b71Sopenharmony_ci| Name| Type                             | Mandatory| Description                |
268e41f4b71Sopenharmony_ci| ------ | --------------------------------- | ---- | -------------------- |
269e41f4b71Sopenharmony_ci| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent)> | Yes| Callback invoked when a pan gesture is recognized.|
270e41f4b71Sopenharmony_ci
271e41f4b71Sopenharmony_ci**Return value**
272e41f4b71Sopenharmony_ci
273e41f4b71Sopenharmony_ci| Type| Description|
274e41f4b71Sopenharmony_ci| -------- | -------- |
275e41f4b71Sopenharmony_ci| PanGestureHandler | Pan gesture handler object.|
276e41f4b71Sopenharmony_ci
277e41f4b71Sopenharmony_ci### onActionUpdate
278e41f4b71Sopenharmony_ci
279e41f4b71Sopenharmony_cionActionUpdate(event: Callback\<GestureEvent>): PanGestureHandler
280e41f4b71Sopenharmony_ci
281e41f4b71Sopenharmony_ciInvoked during the movement of a pan gesture.
282e41f4b71Sopenharmony_ci
283e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
284e41f4b71Sopenharmony_ci
285e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
286e41f4b71Sopenharmony_ci
287e41f4b71Sopenharmony_ci**Parameters**
288e41f4b71Sopenharmony_ci
289e41f4b71Sopenharmony_ci| Name| Type                             | Mandatory| Description                |
290e41f4b71Sopenharmony_ci| ------ | --------------------------------- | ---- | -------------------- |
291e41f4b71Sopenharmony_ci| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent)> | Yes| Callback invoked during the movement of a pan gesture.<br>If **fingerList** contains multiple fingers, this callback updates the location information of only one finger each time.|
292e41f4b71Sopenharmony_ci
293e41f4b71Sopenharmony_ci**Return value**
294e41f4b71Sopenharmony_ci
295e41f4b71Sopenharmony_ci| Type| Description|
296e41f4b71Sopenharmony_ci| -------- | -------- |
297e41f4b71Sopenharmony_ci| PanGestureHandler | Pan gesture handler object.|
298e41f4b71Sopenharmony_ci
299e41f4b71Sopenharmony_ci### onActionEnd
300e41f4b71Sopenharmony_ci
301e41f4b71Sopenharmony_cionActionEnd(event: Callback\<GestureEvent>): PanGestureHandler
302e41f4b71Sopenharmony_ci
303e41f4b71Sopenharmony_ciInvoked when the finger used for a pan gesture is lifted.
304e41f4b71Sopenharmony_ci
305e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
306e41f4b71Sopenharmony_ci
307e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
308e41f4b71Sopenharmony_ci
309e41f4b71Sopenharmony_ci**Parameters**
310e41f4b71Sopenharmony_ci
311e41f4b71Sopenharmony_ci| Name| Type                             | Mandatory| Description                |
312e41f4b71Sopenharmony_ci| ------ | --------------------------------- | ---- | -------------------- |
313e41f4b71Sopenharmony_ci| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent)> | Yes| Callback invoked when the finger used for a pan gesture is lifted.|
314e41f4b71Sopenharmony_ci
315e41f4b71Sopenharmony_ci**Return value**
316e41f4b71Sopenharmony_ci
317e41f4b71Sopenharmony_ci| Type| Description|
318e41f4b71Sopenharmony_ci| -------- | -------- |
319e41f4b71Sopenharmony_ci| PanGestureHandler | Pan gesture handler object.|
320e41f4b71Sopenharmony_ci
321e41f4b71Sopenharmony_ci### onActionCancel
322e41f4b71Sopenharmony_ci
323e41f4b71Sopenharmony_cionActionCancel(event: Callback\<void>): PanGestureHandler
324e41f4b71Sopenharmony_ci
325e41f4b71Sopenharmony_ciInvoked when a tap cancellation event is received after a pan gesture is recognized.
326e41f4b71Sopenharmony_ci
327e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
328e41f4b71Sopenharmony_ci
329e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
330e41f4b71Sopenharmony_ci
331e41f4b71Sopenharmony_ci**Parameters**
332e41f4b71Sopenharmony_ci
333e41f4b71Sopenharmony_ci| Name| Type                             | Mandatory| Description                |
334e41f4b71Sopenharmony_ci| ------ | --------------------------------- | ---- | -------------------- |
335e41f4b71Sopenharmony_ci| event  | [Callback](./ts-types.md#callback12)\<void> | Yes| Callback invoked when a tap cancellation event is received after a pan gesture is recognized.|
336e41f4b71Sopenharmony_ci
337e41f4b71Sopenharmony_ci**Return value**
338e41f4b71Sopenharmony_ci
339e41f4b71Sopenharmony_ci| Type| Description|
340e41f4b71Sopenharmony_ci| -------- | -------- |
341e41f4b71Sopenharmony_ci| PanGestureHandler | Pan gesture handler object.|
342e41f4b71Sopenharmony_ci
343e41f4b71Sopenharmony_ci## PanGestureHandlerOptions
344e41f4b71Sopenharmony_ci
345e41f4b71Sopenharmony_ciProvides the parameters of the pan gesture handler.
346e41f4b71Sopenharmony_ci
347e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
348e41f4b71Sopenharmony_ci
349e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
350e41f4b71Sopenharmony_ci
351e41f4b71Sopenharmony_ci| Attributes        | Type                                  | Mandatory| Description                |
352e41f4b71Sopenharmony_ci| ------------ | -------------------------------------- | ---- | -------------------- |
353e41f4b71Sopenharmony_ci| fingers | number | No| Minimum number of fingers to trigger a pan gesture. The value ranges from 1 to 10.<br>Default value: **1**<br>Value range: [1, 10]<br>**NOTE**<br>If the value is less than 1 or is not set, the default value is used.|
354e41f4b71Sopenharmony_ci| direction | [PanDirection](./ts-basic-gestures-pangesture.md#pandirection) | No| Pan direction. The value supports the AND (&amp;) and OR (\|) operations.<br>Default value: **PanDirection.All**|
355e41f4b71Sopenharmony_ci| distance | number | No| Minimum pan distance to trigger the gesture, in vp.<br>Default value: **5**<br>**NOTE**<br>If a pan gesture and a [tab](ts-container-tabs.md) swipe occur at the same time, set **distance** to **1** so that the gesture can be more easily recognized.<br>If the value specified is less than **0**, the default value **5** is used.|
356e41f4b71Sopenharmony_ci
357e41f4b71Sopenharmony_ci## SwipeGestureHandler
358e41f4b71Sopenharmony_ci
359e41f4b71Sopenharmony_ciDefines a type of gesture handler object for swipe gestures.
360e41f4b71Sopenharmony_ci
361e41f4b71Sopenharmony_ci### constructor
362e41f4b71Sopenharmony_ci
363e41f4b71Sopenharmony_ciconstructor(options?: SwipeGestureHandlerOptions)
364e41f4b71Sopenharmony_ci
365e41f4b71Sopenharmony_ciA constructor used to create a **SwipeGestureHandler** object.
366e41f4b71Sopenharmony_ci
367e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
368e41f4b71Sopenharmony_ci
369e41f4b71Sopenharmony_ci**Parameters**
370e41f4b71Sopenharmony_ci
371e41f4b71Sopenharmony_ci| Name | Type                                                        | Mandatory| Description              |
372e41f4b71Sopenharmony_ci| ------- | ------------------------------------------------------------ | ---- | ------------------ |
373e41f4b71Sopenharmony_ci| options | [SwipeGestureHandlerOptions](#swipegesturehandleroptions) | No  | Parameters of the swipe gesture handler.|
374e41f4b71Sopenharmony_ci
375e41f4b71Sopenharmony_ci### onAction
376e41f4b71Sopenharmony_ci
377e41f4b71Sopenharmony_cionAction(event: Callback\<GestureEvent>): SwipeGestureHandlerOptions
378e41f4b71Sopenharmony_ci
379e41f4b71Sopenharmony_ciInvoked when a swipe gesture is recognized.
380e41f4b71Sopenharmony_ci
381e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
382e41f4b71Sopenharmony_ci
383e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
384e41f4b71Sopenharmony_ci
385e41f4b71Sopenharmony_ci**Parameters**
386e41f4b71Sopenharmony_ci
387e41f4b71Sopenharmony_ci| Name| Type                             | Mandatory| Description                |
388e41f4b71Sopenharmony_ci| ------ | --------------------------------- | ---- | -------------------- |
389e41f4b71Sopenharmony_ci| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent)> | Yes| Callback invoked when a swipe gesture is recognized.|
390e41f4b71Sopenharmony_ci
391e41f4b71Sopenharmony_ci**Return value**
392e41f4b71Sopenharmony_ci
393e41f4b71Sopenharmony_ci| Type| Description|
394e41f4b71Sopenharmony_ci| -------- | -------- |
395e41f4b71Sopenharmony_ci| SwipeGestureHandler | Swipe gesture handler object.|
396e41f4b71Sopenharmony_ci
397e41f4b71Sopenharmony_ci## SwipeGestureHandlerOptions
398e41f4b71Sopenharmony_ci
399e41f4b71Sopenharmony_ciProvides the parameters of the swipe gesture handler.
400e41f4b71Sopenharmony_ci
401e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
402e41f4b71Sopenharmony_ci
403e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
404e41f4b71Sopenharmony_ci
405e41f4b71Sopenharmony_ci| Attributes        | Type                                  | Mandatory| Description                |
406e41f4b71Sopenharmony_ci| ------------ | -------------------------------------- | ---- | -------------------- |
407e41f4b71Sopenharmony_ci| fingers | number | No| Minimum number of fingers to trigger a swipe gesture. The value ranges from 1 to 10.<br>Default value: **1**|
408e41f4b71Sopenharmony_ci| direction | [SwipeDirection](./ts-basic-gestures-swipegesture.md#swipedirection) | No| Swipe direction.<br>Default value: **SwipeDirection.All**|
409e41f4b71Sopenharmony_ci| speed | number | No| Minimum speed of the swipe gesture.<br>Default value: 100 vp/s<br>**NOTE**<br>If the value is less than or equal to 0, it will be converted to the default value.|
410e41f4b71Sopenharmony_ci
411e41f4b71Sopenharmony_ci## PinchGestureHandler
412e41f4b71Sopenharmony_ci
413e41f4b71Sopenharmony_ciDefines a type of gesture handler object for pinch gestures.
414e41f4b71Sopenharmony_ci
415e41f4b71Sopenharmony_ci### constructor
416e41f4b71Sopenharmony_ci
417e41f4b71Sopenharmony_ciconstructor(options?: PinchGestureHandlerOptions)
418e41f4b71Sopenharmony_ci
419e41f4b71Sopenharmony_ciA constructor used to create a **PinchGestureHandler** object.
420e41f4b71Sopenharmony_ci
421e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
422e41f4b71Sopenharmony_ci
423e41f4b71Sopenharmony_ci**Parameters**
424e41f4b71Sopenharmony_ci
425e41f4b71Sopenharmony_ci
426e41f4b71Sopenharmony_ci| Name | Type                                                        | Mandatory| Description              |
427e41f4b71Sopenharmony_ci| ------- | ------------------------------------------------------------ | ---- | ------------------ |
428e41f4b71Sopenharmony_ci| options | [PinchGestureHandlerOptions](#pinchgesturehandleroptions) | No  | Parameters of the pinch gesture handler.|
429e41f4b71Sopenharmony_ci
430e41f4b71Sopenharmony_ci### onActionStart
431e41f4b71Sopenharmony_ci
432e41f4b71Sopenharmony_cionActionStart(event: Callback\<GestureEvent>): PinchGestureHandler
433e41f4b71Sopenharmony_ci
434e41f4b71Sopenharmony_ciInvoked when a pinch gesture is recognized.
435e41f4b71Sopenharmony_ci
436e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
437e41f4b71Sopenharmony_ci
438e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
439e41f4b71Sopenharmony_ci
440e41f4b71Sopenharmony_ci**Parameters**
441e41f4b71Sopenharmony_ci
442e41f4b71Sopenharmony_ci| Name| Type                             | Mandatory| Description                |
443e41f4b71Sopenharmony_ci| ------ | --------------------------------- | ---- | -------------------- |
444e41f4b71Sopenharmony_ci| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent)> | Yes| Callback invoked when a pinch gesture is recognized.|
445e41f4b71Sopenharmony_ci
446e41f4b71Sopenharmony_ci**Return value**
447e41f4b71Sopenharmony_ci
448e41f4b71Sopenharmony_ci| Type| Description|
449e41f4b71Sopenharmony_ci| -------- | -------- |
450e41f4b71Sopenharmony_ci| PinchGestureHandler | Pinch gesture handler object.|
451e41f4b71Sopenharmony_ci
452e41f4b71Sopenharmony_ci### onActionUpdate
453e41f4b71Sopenharmony_ci
454e41f4b71Sopenharmony_cionActionUpdate(event: Callback\<GestureEvent>): PinchGestureHandler
455e41f4b71Sopenharmony_ci
456e41f4b71Sopenharmony_ciInvoked during the movement of a pinch gesture.
457e41f4b71Sopenharmony_ci
458e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
459e41f4b71Sopenharmony_ci
460e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
461e41f4b71Sopenharmony_ci
462e41f4b71Sopenharmony_ci**Parameters**
463e41f4b71Sopenharmony_ci
464e41f4b71Sopenharmony_ci| Name| Type                             | Mandatory| Description                |
465e41f4b71Sopenharmony_ci| ------ | --------------------------------- | ---- | -------------------- |
466e41f4b71Sopenharmony_ci| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent)> | Yes| Callback invoked during the movement of a pinch gesture.|
467e41f4b71Sopenharmony_ci
468e41f4b71Sopenharmony_ci**Return value**
469e41f4b71Sopenharmony_ci
470e41f4b71Sopenharmony_ci| Type| Description|
471e41f4b71Sopenharmony_ci| -------- | -------- |
472e41f4b71Sopenharmony_ci| PinchGestureHandler | Pinch gesture handler object.|
473e41f4b71Sopenharmony_ci
474e41f4b71Sopenharmony_ci### onActionEnd
475e41f4b71Sopenharmony_ci
476e41f4b71Sopenharmony_cionActionEnd(event: Callback\<GestureEvent>): PinchGestureHandler
477e41f4b71Sopenharmony_ci
478e41f4b71Sopenharmony_ciInvoked when the finger used for a pinch gesture is lifted.
479e41f4b71Sopenharmony_ci
480e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
481e41f4b71Sopenharmony_ci
482e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
483e41f4b71Sopenharmony_ci
484e41f4b71Sopenharmony_ci**Parameters**
485e41f4b71Sopenharmony_ci
486e41f4b71Sopenharmony_ci| Name| Type                             | Mandatory| Description                |
487e41f4b71Sopenharmony_ci| ------ | --------------------------------- | ---- | -------------------- |
488e41f4b71Sopenharmony_ci| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent)> | Yes| Callback invoked when the finger used for a pinch gesture is lifted.|
489e41f4b71Sopenharmony_ci
490e41f4b71Sopenharmony_ci**Return value**
491e41f4b71Sopenharmony_ci
492e41f4b71Sopenharmony_ci| Type| Description|
493e41f4b71Sopenharmony_ci| -------- | -------- |
494e41f4b71Sopenharmony_ci| PinchGestureHandler | Pinch gesture handler object.|
495e41f4b71Sopenharmony_ci
496e41f4b71Sopenharmony_ci### onActionCancel
497e41f4b71Sopenharmony_ci
498e41f4b71Sopenharmony_cionActionCancel(event: Callback\<void>): PinchGestureHandler
499e41f4b71Sopenharmony_ci
500e41f4b71Sopenharmony_ciInvoked when a tap cancellation event is received after a pinch gesture is recognized.
501e41f4b71Sopenharmony_ci
502e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
503e41f4b71Sopenharmony_ci
504e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
505e41f4b71Sopenharmony_ci
506e41f4b71Sopenharmony_ci**Parameters**
507e41f4b71Sopenharmony_ci
508e41f4b71Sopenharmony_ci| Name| Type                             | Mandatory| Description                |
509e41f4b71Sopenharmony_ci| ------ | --------------------------------- | ---- | -------------------- |
510e41f4b71Sopenharmony_ci| event  | [Callback](./ts-types.md#callback12)\<void> | Yes| Callback invoked when a tap cancellation event is received after a pinch gesture is recognized.|
511e41f4b71Sopenharmony_ci
512e41f4b71Sopenharmony_ci**Return value**
513e41f4b71Sopenharmony_ci
514e41f4b71Sopenharmony_ci| Type| Description|
515e41f4b71Sopenharmony_ci| -------- | -------- |
516e41f4b71Sopenharmony_ci| PinchGestureHandler | Pan gesture handler object.|
517e41f4b71Sopenharmony_ci
518e41f4b71Sopenharmony_ci## PinchGestureHandlerOptions
519e41f4b71Sopenharmony_ci
520e41f4b71Sopenharmony_ciProvides the parameters of the pinch gesture handler.
521e41f4b71Sopenharmony_ci
522e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
523e41f4b71Sopenharmony_ci
524e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
525e41f4b71Sopenharmony_ci
526e41f4b71Sopenharmony_ci| Attributes        | Type                                  | Mandatory| Description                |
527e41f4b71Sopenharmony_ci| ------------ | -------------------------------------- | ---- | -------------------- |
528e41f4b71Sopenharmony_ci| fingers | number | No| Minimum number of fingers to trigger a pinch. The value ranges from 2 to 5.<br>Default value: **2**<br>While more fingers than the minimum number can be pressed to trigger the gesture, only the first fingers of the minimum number participate in gesture calculation.|
529e41f4b71Sopenharmony_ci| distance | number | No| Minimum recognition distance, in vp.<br>Default value: **5**<br>**NOTE**<br> If the value is less than or equal to 0, it will be converted to the default value.|
530e41f4b71Sopenharmony_ci
531e41f4b71Sopenharmony_ci## RotationGestureHandler
532e41f4b71Sopenharmony_ci
533e41f4b71Sopenharmony_ciDefines a type of gesture handler object for rotation gestures.
534e41f4b71Sopenharmony_ci
535e41f4b71Sopenharmony_ci### constructor
536e41f4b71Sopenharmony_ci
537e41f4b71Sopenharmony_ciconstructor(options?: RotationGestureHandlerOptions)
538e41f4b71Sopenharmony_ci
539e41f4b71Sopenharmony_ciA constructor used to create a **RotationGestureHandler** object.
540e41f4b71Sopenharmony_ci
541e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
542e41f4b71Sopenharmony_ci
543e41f4b71Sopenharmony_ci**Parameters**
544e41f4b71Sopenharmony_ci
545e41f4b71Sopenharmony_ci
546e41f4b71Sopenharmony_ci| Name | Type                                                        | Mandatory| Description              |
547e41f4b71Sopenharmony_ci| ------- | ------------------------------------------------------------ | ---- | ------------------ |
548e41f4b71Sopenharmony_ci| options | [RotationGestureHandlerOptions](#rotationgesturehandleroptions) | No  | Parameters of the rotation gesture handler.|
549e41f4b71Sopenharmony_ci
550e41f4b71Sopenharmony_ci### onActionStart
551e41f4b71Sopenharmony_ci
552e41f4b71Sopenharmony_cionActionStart(event: Callback\<GestureEvent>): RotationGestureHandler
553e41f4b71Sopenharmony_ci
554e41f4b71Sopenharmony_ciInvoked when a rotation gesture is recognized.
555e41f4b71Sopenharmony_ci
556e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
557e41f4b71Sopenharmony_ci
558e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
559e41f4b71Sopenharmony_ci
560e41f4b71Sopenharmony_ci**Parameters**
561e41f4b71Sopenharmony_ci
562e41f4b71Sopenharmony_ci| Name| Type                             | Mandatory| Description                |
563e41f4b71Sopenharmony_ci| ------ | --------------------------------- | ---- | -------------------- |
564e41f4b71Sopenharmony_ci| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent)> | Yes| Callback invoked when a rotation gesture is recognized.|
565e41f4b71Sopenharmony_ci
566e41f4b71Sopenharmony_ci**Return value**
567e41f4b71Sopenharmony_ci
568e41f4b71Sopenharmony_ci| Type| Description|
569e41f4b71Sopenharmony_ci| -------- | -------- |
570e41f4b71Sopenharmony_ci| RotationGestureHandler | Pan gesture handler object.|
571e41f4b71Sopenharmony_ci
572e41f4b71Sopenharmony_ci### onActionUpdate
573e41f4b71Sopenharmony_ci
574e41f4b71Sopenharmony_cionActionUpdate(event: Callback\<GestureEvent>): RotationGestureHandler
575e41f4b71Sopenharmony_ci
576e41f4b71Sopenharmony_ciInvoked during the movement of the rotation gesture.
577e41f4b71Sopenharmony_ci
578e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
579e41f4b71Sopenharmony_ci
580e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
581e41f4b71Sopenharmony_ci
582e41f4b71Sopenharmony_ci**Parameters**
583e41f4b71Sopenharmony_ci
584e41f4b71Sopenharmony_ci| Name| Type                             | Mandatory| Description                |
585e41f4b71Sopenharmony_ci| ------ | --------------------------------- | ---- | -------------------- |
586e41f4b71Sopenharmony_ci| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent)> | Yes| Callback invoked during the movement of the rotation gesture.|
587e41f4b71Sopenharmony_ci
588e41f4b71Sopenharmony_ci**Return value**
589e41f4b71Sopenharmony_ci
590e41f4b71Sopenharmony_ci| Type| Description|
591e41f4b71Sopenharmony_ci| -------- | -------- |
592e41f4b71Sopenharmony_ci| RotationGestureHandler | Pan gesture handler object.|
593e41f4b71Sopenharmony_ci
594e41f4b71Sopenharmony_ci### onActionEnd
595e41f4b71Sopenharmony_ci
596e41f4b71Sopenharmony_cionActionEnd(event: Callback\<GestureEvent>): RotationGestureHandler
597e41f4b71Sopenharmony_ci
598e41f4b71Sopenharmony_ciInvoked when the finger used for the rotation gesture is lifted.
599e41f4b71Sopenharmony_ci
600e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
601e41f4b71Sopenharmony_ci
602e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
603e41f4b71Sopenharmony_ci
604e41f4b71Sopenharmony_ci**Parameters**
605e41f4b71Sopenharmony_ci
606e41f4b71Sopenharmony_ci| Name| Type                             | Mandatory| Description                |
607e41f4b71Sopenharmony_ci| ------ | --------------------------------- | ---- | -------------------- |
608e41f4b71Sopenharmony_ci| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent)> | Yes| Callback invoked when the finger used for the rotation gesture is lifted.|
609e41f4b71Sopenharmony_ci
610e41f4b71Sopenharmony_ci**Return value**
611e41f4b71Sopenharmony_ci
612e41f4b71Sopenharmony_ci| Type| Description|
613e41f4b71Sopenharmony_ci| -------- | -------- |
614e41f4b71Sopenharmony_ci| RotationGestureHandler | Rotation gesture handler object.|
615e41f4b71Sopenharmony_ci
616e41f4b71Sopenharmony_ci### onActionCancel
617e41f4b71Sopenharmony_ci
618e41f4b71Sopenharmony_cionActionCancel(event: Callback\<void>): RotationGestureHandler
619e41f4b71Sopenharmony_ci
620e41f4b71Sopenharmony_ciInvoked when a tap cancellation event is received after the rotation gesture is recognized.
621e41f4b71Sopenharmony_ci
622e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
623e41f4b71Sopenharmony_ci
624e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
625e41f4b71Sopenharmony_ci
626e41f4b71Sopenharmony_ci**Parameters**
627e41f4b71Sopenharmony_ci
628e41f4b71Sopenharmony_ci| Name| Type                             | Mandatory| Description                |
629e41f4b71Sopenharmony_ci| ------ | --------------------------------- | ---- | -------------------- |
630e41f4b71Sopenharmony_ci| event  | [Callback](./ts-types.md#callback12)\<void> | Yes| Callback invoked when a tap cancellation event is received after the rotation gesture is recognized.|
631e41f4b71Sopenharmony_ci
632e41f4b71Sopenharmony_ci**Return value**
633e41f4b71Sopenharmony_ci
634e41f4b71Sopenharmony_ci| Type| Description|
635e41f4b71Sopenharmony_ci| -------- | -------- |
636e41f4b71Sopenharmony_ci| RotationGestureHandler | Pan gesture handler object.|
637e41f4b71Sopenharmony_ci
638e41f4b71Sopenharmony_ci## RotationGestureHandlerOptions
639e41f4b71Sopenharmony_ci
640e41f4b71Sopenharmony_ciProvides the parameters of the rotation gesture handler.
641e41f4b71Sopenharmony_ci
642e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
643e41f4b71Sopenharmony_ci
644e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
645e41f4b71Sopenharmony_ci
646e41f4b71Sopenharmony_ci| Attributes        | Type                                  | Mandatory| Description                |
647e41f4b71Sopenharmony_ci| ------------ | -------------------------------------- | ---- | -------------------- |
648e41f4b71Sopenharmony_ci| fingers | number | No| Minimum number of fingers to trigger a rotation. The value ranges from 2 to 5.<br>Default value: **2**<br>While more fingers than the minimum number can be pressed to trigger the gesture, only the first two fingers participate in gesture calculation.|
649e41f4b71Sopenharmony_ci| angle | number | No| Minimum degree that can trigger the rotation gesture.<br>Default value: **1**<br>**NOTE**<br>If the value is less than or equal to 0 or greater than 360, it will be converted to the default value.|
650e41f4b71Sopenharmony_ci
651e41f4b71Sopenharmony_ci## GestureGroupHandler
652e41f4b71Sopenharmony_ci
653e41f4b71Sopenharmony_ciDefines a type of gesture handler object for gesture groups.
654e41f4b71Sopenharmony_ci
655e41f4b71Sopenharmony_ci### constructor
656e41f4b71Sopenharmony_ci
657e41f4b71Sopenharmony_ciconstructor(options?: GestureGroupGestureHandlerOptions)
658e41f4b71Sopenharmony_ci
659e41f4b71Sopenharmony_ciA constructor used to create a **GestureGroupHandler** object.
660e41f4b71Sopenharmony_ci
661e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
662e41f4b71Sopenharmony_ci
663e41f4b71Sopenharmony_ci**Parameters**
664e41f4b71Sopenharmony_ci
665e41f4b71Sopenharmony_ci| Name | Type                                                        | Mandatory| Description              |
666e41f4b71Sopenharmony_ci| ------- | ------------------------------------------------------------ | ---- | ------------------ |
667e41f4b71Sopenharmony_ci| options | [GestureGroupGestureHandlerOptions](#gesturegroupgesturehandleroptions) | No  | Parameters of the gesture group handler.|
668e41f4b71Sopenharmony_ci
669e41f4b71Sopenharmony_ci### onCancel
670e41f4b71Sopenharmony_ci
671e41f4b71Sopenharmony_cionCancel(event: Callback\<void>): GestureGroupHandler
672e41f4b71Sopenharmony_ci
673e41f4b71Sopenharmony_ciInvoked when a cancellation event is received after the gesture group in sequential gesture recognition (**GestureMode.Sequence**) is recognized.
674e41f4b71Sopenharmony_ci
675e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
676e41f4b71Sopenharmony_ci
677e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
678e41f4b71Sopenharmony_ci
679e41f4b71Sopenharmony_ci**Parameters**
680e41f4b71Sopenharmony_ci
681e41f4b71Sopenharmony_ci| Name| Type                             | Mandatory| Description                |
682e41f4b71Sopenharmony_ci| ------ | --------------------------------- | ---- | -------------------- |
683e41f4b71Sopenharmony_ci| event  | [Callback](./ts-types.md#callback12)\<void> | Yes| Callback invoked when a cancellation event is received after the gesture group in sequential gesture recognition **GestureMode.Sequence**) is recognized.|
684e41f4b71Sopenharmony_ci
685e41f4b71Sopenharmony_ci**Return value**
686e41f4b71Sopenharmony_ci
687e41f4b71Sopenharmony_ci| Type| Description|
688e41f4b71Sopenharmony_ci| -------- | -------- |
689e41f4b71Sopenharmony_ci| GestureGroupHandler | Gesture group handler object.|
690e41f4b71Sopenharmony_ci
691e41f4b71Sopenharmony_ci## GestureGroupGestureHandlerOptions
692e41f4b71Sopenharmony_ci
693e41f4b71Sopenharmony_ciProvides the parameters of the gesture group handler.
694e41f4b71Sopenharmony_ci
695e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
696e41f4b71Sopenharmony_ci
697e41f4b71Sopenharmony_ci**System capability**: SystemCapability.ArkUI.ArkUI.Full
698e41f4b71Sopenharmony_ci
699e41f4b71Sopenharmony_ci| Attributes        | Type                                  | Mandatory| Description                |
700e41f4b71Sopenharmony_ci| ------------ | -------------------------------------- | ---- | -------------------- |
701e41f4b71Sopenharmony_ci| mode    | [GestureMode](./ts-combined-gestures.md#gesturemode)                          | Yes  | Recognition mode of combined gestures.<br>Default value: **GestureMode.Sequence**     |
702e41f4b71Sopenharmony_ci| gestures | [GestureHandler](#gesturehandlert)\<[TapGestureHandler](#tapgesturehandler) \| [LongPressGestureHandler](#longpressgesturehandler) \| [PanGestureHandler](#pangesturehandler) \| [SwipeGestureHandler](#swipegesturehandler) \| [PinchGestureHandler](#pinchgesturehandler) \| [RotationGestureHandler](#rotationgesturehandler) \| [GestureGroupHandler](#gesturegrouphandler)>[] | Yes  | Gestures that need to be included in the gesture group.<br>**NOTE**<br>To add both tap and double-tap gestures for a component, add two TapGestures, with the tap gesture added after the double-tap gesture.|
703e41f4b71Sopenharmony_ci
704e41f4b71Sopenharmony_ci## GesturePriority
705e41f4b71Sopenharmony_ci
706e41f4b71Sopenharmony_ci**Atomic service API**: This API can be used in atomic services since API version 12.
707e41f4b71Sopenharmony_ci
708e41f4b71Sopenharmony_ci| Name| Description|
709e41f4b71Sopenharmony_ci| -------- | -------- |
710e41f4b71Sopenharmony_ci| NORMAL | Normal priority.|
711e41f4b71Sopenharmony_ci| PRIORITY | High priority.|
712e41f4b71Sopenharmony_ci
713e41f4b71Sopenharmony_ci## Example
714e41f4b71Sopenharmony_ci
715e41f4b71Sopenharmony_ciFor details, see [Gesture Modifier](./ts-universal-attributes-gesture-modifier.md).
716