1# 设置组件绑定的手势
2
3用于设置组件绑定的手势。可以通过UIGestureEvent对象调用其接口添加或删除手势。
4
5>**说明:**
6>
7>本模块首批接口从API version 12开始支持,后续版本的新增接口,采用上角标单独标记接口的起始版本。
8
9## UIGestureEvent
10
11用于设置组件绑定的手势。
12
13### addGesture
14
15addGesture(gesture: GestureHandler\<T>, priority?: GesturePriority, mask?: GestureMask): void
16
17添加手势。
18
19**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
20
21**参数:**
22
23| 参数名 | 类型   | 必填 | 说明                       |
24| ------ | ------ | ---- | -------------------------- |
25| gesture  |  [GestureHandler\<T>](#gesturehandlert) | 是   | 手势处理器对象。 |
26| priority  |  [GesturePriority](#gesturepriority枚举说明) | 否   | 绑定手势的优先级。 |
27| mask  |  [GestureMask](./ts-gesture-settings.md#gesturemask枚举说明) | 否   | 事件响应设置。 |
28
29### addParallelGesture
30
31addParallelGesture(gesture: GestureHandler\<T>, mask?: GestureMask): void
32
33绑定可与子组件手势同时触发的手势。
34
35**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
36
37**参数:**
38
39| 参数名 | 类型   | 必填 | 说明                       |
40| ------ | ------ | ---- | -------------------------- |
41| gesture  |  [GestureHandler\<T>](#gesturehandlert) | 是   | 手势处理器对象。 |
42| mask  |  [GestureMask](./ts-gesture-settings.md#gesturemask枚举说明) | 否   | 事件响应设置。 |
43
44### removeGestureByTag
45
46removeGestureByTag(tag: string): void
47
48移除该组件上通过modifier绑定的设置为指定标志的手势。
49
50**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
51
52**参数:**
53
54| 参数名 | 类型   | 必填 | 说明                       |
55| ------ | ------ | ---- | -------------------------- |
56| tag  |  string | 是   | 手势处理器标志。 |
57
58### clearGestures
59
60clearGestures(): void
61
62清除该组件上通过modifier绑定的所有手势。
63
64**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
65
66## GestureHandler\<T>
67
68手势对象的基础类型。
69
70### tag
71
72tag(tag: string): T
73
74设置手势处理器的标志。
75
76**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
77
78**参数:**
79
80| 名称 | 类型 | 必填 |描述                                        |
81| ----  | ------  | ------|---------------------------------- |
82| tag   | string  | 是 |设置手势处理器标志。|
83
84### allowedTypes<sup>14+</sup>
85
86allowedTypes(types: Array\<SourceTool>): T
87
88设置手势处理器所支持的事件输入源。
89
90**原子化服务API:** 从API version 14开始,该接口支持在原子化服务中使用。
91
92**系统能力:** SystemCapability.ArkUI.ArkUI.Full
93
94**参数:**
95
96| 名称 | 类型 | 必填 |描述                                        |
97| ----  | ------  | ------|---------------------------------- |
98| types   | Array\<[SourceTool](ts-gesture-settings.md#sourcetool枚举说明9)>  | 是 |设置手势处理器所支持的事件输入源。|
99
100## TapGestureHandler
101
102点击手势处理器对象类型。
103
104### constructor
105
106constructor(options?: TapGestureHandlerOptions)
107
108构造函数。
109
110**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
111
112**参数:**
113
114| 参数名  | 类型                                                         | 必填 | 说明               |
115| ------- | ------------------------------------------------------------ | ---- | ------------------ |
116| options | [TapGestureHandlerOptions](#tapgesturehandleroptions) | 否   | 点击手势处理器配置参数。 |
117
118### onAction
119
120onAction(event: Callback\<GestureEvent>): TapGestureHandler
121
122Tap手势识别成功回调。
123
124**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
125
126**系统能力:** SystemCapability.ArkUI.ArkUI.Full
127
128**参数:**
129
130| 参数名 | 类型                              | 必填 | 说明                 |
131| ------ | --------------------------------- | ---- | -------------------- |
132| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | Tap手势识别成功回调。 |
133
134**返回值:**
135
136| 类型 | 说明 |
137| -------- | -------- |
138| TapGestureHandler | 返回当前点击手势处理器对象。 |
139
140## TapGestureHandlerOptions
141
142点击手势处理器配置参数。
143
144**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
145
146**系统能力:** SystemCapability.ArkUI.ArkUI.Full
147
148| 属性         | 类型                                   | 必填 | 描述                 |
149| ------------ | -------------------------------------- | ---- | -------------------- |
150| count | number | 否 | 识别的连续点击次数。当设置的值小于1或不设置时,会被转化为默认值。<br/>默认值:1<br/>**说明:**<br/>1. 当配置多击时,上一次的最后一根手指抬起和下一次的第一根手指按下的超时时间为300毫秒。<br/>2. 当上次点击的位置与当前点击的位置距离超过60vp时,手势识别失败。|
151| fingers | number | 否 | 触发点击的手指数,最小为1指,&nbsp;最大为10指。当设置小于1的值或不设置时,会被转化为默认值。<br/>默认值:1<br/>**说明:**<br/>1. 当配置多指时,第一根手指按下后300毫秒内未有足够的手指数按下,手势识别失败,第一根手指抬起后300毫秒内未有足够的手指抬起,手势识别失败。<br/>2. 实际点击手指数超过配置值,手势识别成功。 |
152
153## LongPressGestureHandler
154
155长按手势处理器对象类型。
156
157### constructor
158
159constructor(options?: LongPressGestureHandlerOptions)
160
161构造函数。
162
163**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
164
165**参数:**
166
167
168| 参数名  | 类型                                                         | 必填 | 说明               |
169| ------- | ------------------------------------------------------------ | ---- | ------------------ |
170| options | [LongPressGestureHandlerOptions](#longpressgesturehandleroptions) | 否   | 长按手势处理器配置参数。 |
171
172### onAction
173
174onAction(event: Callback\<GestureEvent>): LongPressGestureHandler
175
176LongPress手势识别成功回调。
177
178**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
179
180**系统能力:** SystemCapability.ArkUI.ArkUI.Full
181
182**参数:**
183
184| 参数名 | 类型                              | 必填 | 说明                 |
185| ------ | --------------------------------- | ---- | -------------------- |
186| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | LongPress手势识别成功回调。 |
187
188**返回值:**
189
190| 类型 | 说明 |
191| -------- | -------- |
192| LongPressGestureHandler | 返回当前长按手势处理器对象。 |
193
194### onActionEnd
195
196onActionEnd(event: Callback\<GestureEvent>): LongPressGestureHandler
197
198LongPress手势识别成功,最后一根手指抬起后触发回调。
199
200**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
201
202**系统能力:** SystemCapability.ArkUI.ArkUI.Full
203
204**参数:**
205
206| 参数名 | 类型                              | 必填 | 说明                 |
207| ------ | --------------------------------- | ---- | -------------------- |
208| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | LongPress手势识别成功,最后一根手指抬起后触发回调。 |
209
210**返回值:**
211
212| 类型 | 说明 |
213| -------- | -------- |
214| LongPressGestureHandler | 返回当前长按手势处理器对象。 |
215
216### onActionCancel
217
218onActionCancel(event: Callback\<void>): LongPressGestureHandler
219
220LongPress手势识别成功,接收到触摸取消事件触发回调。
221
222**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
223
224**系统能力:** SystemCapability.ArkUI.ArkUI.Full
225
226**参数:**
227
228| 参数名 | 类型                              | 必填 | 说明                 |
229| ------ | --------------------------------- | ---- | -------------------- |
230| event  | [Callback](./ts-types.md#callback12)\<void> | 是 | LongPress手势识别成功,接收到触摸取消事件触发回调。 |
231
232**返回值:**
233
234| 类型 | 说明 |
235| -------- | -------- |
236| LongPressGestureHandler | 返回当前长按手势处理器对象。 |
237
238## LongPressGestureHandlerOptions
239
240长按手势处理器配置参数。
241
242**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
243
244**系统能力:** SystemCapability.ArkUI.ArkUI.Full
245
246| 属性         | 类型                                   | 必填 | 描述                 |
247| ------------ | -------------------------------------- | ---- | -------------------- |
248| fingers | number | 否 | 触发长按的最少手指数,最小为1指,&nbsp;最大取值为10指。<br/>默认值:1 <br/> **说明:** <br/>手指按下后若发生超过15px的移动,则判定当前长按手势识别失败。|
249| repeat | boolean | 否 | 是否连续触发事件回调。<br/>默认值:false |
250| duration | number | 否 | 触发长按的最短时间,单位为毫秒(ms)。<br/>默认值:500 <br/>**说明:** <br/>设置小于等于0时,按照默认值500处理。|
251
252## PanGestureHandler
253
254拖动手势处理器对象类型。
255
256### constructor
257
258constructor(options?: PanGestureHandlerOptions)
259
260构造函数。
261
262**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
263
264**参数:**
265
266
267| 参数名  | 类型                                                         | 必填 | 说明               |
268| ------- | ------------------------------------------------------------ | ---- | ------------------ |
269| options | [PanGestureHandlerOptions](#pangesturehandleroptions) | 否   | 拖动手势处理器配置参数。 |
270
271### onActionStart
272
273onActionStart(event: Callback\<GestureEvent>): PanGestureHandler
274
275Pan手势识别成功回调。
276
277**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
278
279**系统能力:** SystemCapability.ArkUI.ArkUI.Full
280
281**参数:**
282
283| 参数名 | 类型                              | 必填 | 说明                 |
284| ------ | --------------------------------- | ---- | -------------------- |
285| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | Pan手势识别成功回调。 |
286
287**返回值:**
288
289| 类型 | 说明 |
290| -------- | -------- |
291| PanGestureHandler | 返回当前拖动手势处理器对象。 |
292
293### onActionUpdate
294
295onActionUpdate(event: Callback\<GestureEvent>): PanGestureHandler
296
297Pan手势移动过程中回调。
298
299**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
300
301**系统能力:** SystemCapability.ArkUI.ArkUI.Full
302
303**参数:**
304
305| 参数名 | 类型                              | 必填 | 说明                 |
306| ------ | --------------------------------- | ---- | -------------------- |
307| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | Pan手势移动过程中回调。<br/>fingerList为多根手指时,该回调监听每次只会更新一根手指的位置信息。 |
308
309**返回值:**
310
311| 类型 | 说明 |
312| -------- | -------- |
313| PanGestureHandler | 返回当前拖动手势处理器对象。 |
314
315### onActionEnd
316
317onActionEnd(event: Callback\<GestureEvent>): PanGestureHandler
318
319Pan手势识别成功,手指抬起后触发回调。
320
321**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
322
323**系统能力:** SystemCapability.ArkUI.ArkUI.Full
324
325**参数:**
326
327| 参数名 | 类型                              | 必填 | 说明                 |
328| ------ | --------------------------------- | ---- | -------------------- |
329| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | Pan手势识别成功,手指抬起后触发回调。 |
330
331**返回值:**
332
333| 类型 | 说明 |
334| -------- | -------- |
335| PanGestureHandler | 返回当前拖动手势处理器对象。 |
336
337### onActionCancel
338
339onActionCancel(event: Callback\<void>): PanGestureHandler
340
341Pan手势识别成功,接收到触摸取消事件触发回调。
342
343**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
344
345**系统能力:** SystemCapability.ArkUI.ArkUI.Full
346
347**参数:**
348
349| 参数名 | 类型                              | 必填 | 说明                 |
350| ------ | --------------------------------- | ---- | -------------------- |
351| event  | [Callback](./ts-types.md#callback12)\<void> | 是 | Pan手势识别成功,接收到触摸取消事件触发回调。 |
352
353**返回值:**
354
355| 类型 | 说明 |
356| -------- | -------- |
357| PanGestureHandler | 返回当前拖动手势处理器对象。 |
358
359## PanGestureHandlerOptions
360
361拖动手势处理器配置参数。
362
363**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
364
365**系统能力:** SystemCapability.ArkUI.ArkUI.Full
366
367| 属性         | 类型                                   | 必填 | 描述                 |
368| ------------ | -------------------------------------- | ---- | -------------------- |
369| fingers | number | 否 | 用于指定触发拖动的最少手指数,最小为1指,&nbsp;最大取值为10指。<br/>默认值:1<br/>取值范围:[1,10]<br/>**说明:** <br/>当设置的值小于1或不设置时,会被转化为默认值。 |
370| direction | [PanDirection](./ts-basic-gestures-pangesture.md#pandirection枚举说明) | 否 | 用于指定触发拖动的手势方向,此枚举值支持逻辑与(&amp;)和逻辑或(\|)运算。<br/>默认值:PanDirection.All |
371| distance | number | 否 | 用于指定触发拖动手势事件的最小拖动距离,单位为vp。<br/>默认值:5<br/>**说明:**<br/>[Tabs组件](ts-container-tabs.md)滑动与该拖动手势事件同时存在时,可将distance值设为1,使拖动更灵敏,避免造成事件错乱。<br/>当设定的值小于0时,按默认值5处理。 |
372
373## SwipeGestureHandler
374
375滑动手势处理器对象类型。
376
377### constructor
378
379constructor(options?: SwipeGestureHandlerOptions)
380
381构造函数。
382
383**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
384
385**参数:**
386
387| 参数名  | 类型                                                         | 必填 | 说明               |
388| ------- | ------------------------------------------------------------ | ---- | ------------------ |
389| options | [SwipeGestureHandlerOptions](#swipegesturehandleroptions) | 否   | 滑动手势处理器配置参数。 |
390
391### onAction
392
393onAction(event: Callback\<GestureEvent>): SwipeGestureHandlerOptions
394
395Swipe手势识别成功回调。
396
397**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
398
399**系统能力:** SystemCapability.ArkUI.ArkUI.Full
400
401**参数:**
402
403| 参数名 | 类型                              | 必填 | 说明                 |
404| ------ | --------------------------------- | ---- | -------------------- |
405| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | Swipe手势识别成功回调。 |
406
407**返回值:**
408
409| 类型 | 说明 |
410| -------- | -------- |
411| SwipeGestureHandler | 返回当前滑动手势处理器对象。 |
412
413## SwipeGestureHandlerOptions
414
415滑动事件处理器配置参数。
416
417**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
418
419**系统能力:** SystemCapability.ArkUI.ArkUI.Full
420
421| 属性         | 类型                                   | 必填 | 描述                 |
422| ------------ | -------------------------------------- | ---- | -------------------- |
423| fingers | number | 否 | 触发滑动的最少手指数,默认为1,最小为1指,最大为10指。<br/>默认值:1 |
424| direction | [SwipeDirection](./ts-basic-gestures-swipegesture.md#swipedirection枚举说明) | 否 | 触发滑动手势的滑动方向。<br/>默认值:SwipeDirection.All |
425| speed | number | 否 | 识别滑动的最小速度。<br/>默认值:100VP/s <br/>**说明:** <br/>当滑动速度的值小于等于0时,会被转化为默认值。 |
426
427## PinchGestureHandler
428
429捏合手势处理器对象类型。
430
431### constructor
432
433constructor(options?: PinchGestureHandlerOptions)
434
435构造函数。
436
437**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
438
439**参数:**
440
441
442| 参数名  | 类型                                                         | 必填 | 说明               |
443| ------- | ------------------------------------------------------------ | ---- | ------------------ |
444| options | [PinchGestureHandlerOptions](#pinchgesturehandleroptions) | 否   | 捏合手势处理器配置参数。 |
445
446### onActionStart
447
448onActionStart(event: Callback\<GestureEvent>): PinchGestureHandler
449
450Pinch手势识别成功回调。
451
452**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
453
454**系统能力:** SystemCapability.ArkUI.ArkUI.Full
455
456**参数:**
457
458| 参数名 | 类型                              | 必填 | 说明                 |
459| ------ | --------------------------------- | ---- | -------------------- |
460| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | Pinch手势识别成功回调。 |
461
462**返回值:**
463
464| 类型 | 说明 |
465| -------- | -------- |
466| PinchGestureHandler | 返回当前拖动手势处理器对象。 |
467
468### onActionUpdate
469
470onActionUpdate(event: Callback\<GestureEvent>): PinchGestureHandler
471
472Pinch手势移动过程中回调。
473
474**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
475
476**系统能力:** SystemCapability.ArkUI.ArkUI.Full
477
478**参数:**
479
480| 参数名 | 类型                              | 必填 | 说明                 |
481| ------ | --------------------------------- | ---- | -------------------- |
482| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | Pinch手势移动过程中回调。 |
483
484**返回值:**
485
486| 类型 | 说明 |
487| -------- | -------- |
488| PinchGestureHandler | 返回当前拖动手势处理器对象。 |
489
490### onActionEnd
491
492onActionEnd(event: Callback\<GestureEvent>): PinchGestureHandler
493
494Pinch手势识别成功,手指抬起后触发回调。
495
496**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
497
498**系统能力:** SystemCapability.ArkUI.ArkUI.Full
499
500**参数:**
501
502| 参数名 | 类型                              | 必填 | 说明                 |
503| ------ | --------------------------------- | ---- | -------------------- |
504| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | Pinch手势识别成功,手指抬起后触发回调。 |
505
506**返回值:**
507
508| 类型 | 说明 |
509| -------- | -------- |
510| PinchGestureHandler | 返回当前拖动手势处理器对象。 |
511
512### onActionCancel
513
514onActionCancel(event: Callback\<void>): PinchGestureHandler
515
516Pinch手势识别成功,接收到触摸取消事件触发回调。
517
518**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
519
520**系统能力:** SystemCapability.ArkUI.ArkUI.Full
521
522**参数:**
523
524| 参数名 | 类型                              | 必填 | 说明                 |
525| ------ | --------------------------------- | ---- | -------------------- |
526| event  | [Callback](./ts-types.md#callback12)\<void> | 是 | Pinch手势识别成功,接收到触摸取消事件触发回调。 |
527
528**返回值:**
529
530| 类型 | 说明 |
531| -------- | -------- |
532| PinchGestureHandler | 返回当前拖动手势处理器对象。 |
533
534## PinchGestureHandlerOptions
535
536捏合手势处理器配置参数。
537
538**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
539
540**系统能力:** SystemCapability.ArkUI.ArkUI.Full
541
542| 属性         | 类型                                   | 必填 | 描述                 |
543| ------------ | -------------------------------------- | ---- | -------------------- |
544| fingers | number | 否 | 触发捏合的最少手指数,&nbsp;最小为2指,最大为5指。<br/>默认值:2 <br/>触发手势手指可以多于fingers数目,但只有先落下的与fingers相同数目的手指参与手势计算。 |
545| distance | number | 否 | 最小识别距离,单位为vp。<br/>默认值:5 <br/>**说明:** <br/> 当识别距离的值小于等于0时,会被转化为默认值。|
546
547## RotationGestureHandler
548
549旋转手势处理器对象类型。
550
551### constructor
552
553constructor(options?: RotationGestureHandlerOptions)
554
555构造函数。
556
557**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
558
559**参数:**
560
561
562| 参数名  | 类型                                                         | 必填 | 说明               |
563| ------- | ------------------------------------------------------------ | ---- | ------------------ |
564| options | [RotationGestureHandlerOptions](#rotationgesturehandleroptions) | 否   | 旋转手势处理器配置参数。 |
565
566### onActionStart
567
568onActionStart(event: Callback\<GestureEvent>): RotationGestureHandler
569
570Rotation手势识别成功回调。
571
572**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
573
574**系统能力:** SystemCapability.ArkUI.ArkUI.Full
575
576**参数:**
577
578| 参数名 | 类型                              | 必填 | 说明                 |
579| ------ | --------------------------------- | ---- | -------------------- |
580| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | Rotation手势识别成功回调。 |
581
582**返回值:**
583
584| 类型 | 说明 |
585| -------- | -------- |
586| RotationGestureHandler | 返回当前拖动手势处理器对象。 |
587
588### onActionUpdate
589
590onActionUpdate(event: Callback\<GestureEvent>): RotationGestureHandler
591
592Rotation手势移动过程中回调。
593
594**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
595
596**系统能力:** SystemCapability.ArkUI.ArkUI.Full
597
598**参数:**
599
600| 参数名 | 类型                              | 必填 | 说明                 |
601| ------ | --------------------------------- | ---- | -------------------- |
602| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | Rotation手势移动过程中回调。 |
603
604**返回值:**
605
606| 类型 | 说明 |
607| -------- | -------- |
608| RotationGestureHandler | 返回当前拖动手势处理器对象。 |
609
610### onActionEnd
611
612onActionEnd(event: Callback\<GestureEvent>): RotationGestureHandler
613
614Rotation手势识别成功,手指抬起后触发回调。
615
616**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
617
618**系统能力:** SystemCapability.ArkUI.ArkUI.Full
619
620**参数:**
621
622| 参数名 | 类型                              | 必填 | 说明                 |
623| ------ | --------------------------------- | ---- | -------------------- |
624| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | Rotation手势识别成功,手指抬起后触发回调。 |
625
626**返回值:**
627
628| 类型 | 说明 |
629| -------- | -------- |
630| RotationGestureHandler | 返回当前拖动手势处理器对象。 |
631
632### onActionCancel
633
634onActionCancel(event: Callback\<void>): RotationGestureHandler
635
636Rotation手势识别成功,接收到触摸取消事件触发回调。
637
638**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
639
640**系统能力:** SystemCapability.ArkUI.ArkUI.Full
641
642**参数:**
643
644| 参数名 | 类型                              | 必填 | 说明                 |
645| ------ | --------------------------------- | ---- | -------------------- |
646| event  | [Callback](./ts-types.md#callback12)\<void> | 是 | Rotation手势识别成功,接收到触摸取消事件触发回调。 |
647
648**返回值:**
649
650| 类型 | 说明 |
651| -------- | -------- |
652| RotationGestureHandler | 返回当前拖动手势处理器对象。 |
653
654## RotationGestureHandlerOptions
655
656旋转手势处理器配置参数。
657
658**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
659
660**系统能力:** SystemCapability.ArkUI.ArkUI.Full
661
662| 属性         | 类型                                   | 必填 | 描述                 |
663| ------------ | -------------------------------------- | ---- | -------------------- |
664| fingers | number | 否 | 触发旋转的最少手指数,&nbsp;最小为2指,最大为5指。<br/>默认值:2 <br/>触发手势手指可以多于fingers数目,但只有先落下的两指参与手势计算。|
665| angle | number | 否 | 触发旋转手势的最小改变度数,单位为deg。<br/>默认值:1 <br/>**说明:** <br/>当改变度数的值小于等于0或大于360时,会被转化为默认值。|
666
667## GestureGroupHandler
668
669手势组处理器对象类型。
670
671### constructor
672
673constructor(options?: GestureGroupGestureHandlerOptions)
674
675构造函数。
676
677**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
678
679**参数:**
680
681| 参数名  | 类型                                                         | 必填 | 说明               |
682| ------- | ------------------------------------------------------------ | ---- | ------------------ |
683| options | [GestureGroupGestureHandlerOptions](#gesturegroupgesturehandleroptions) | 否   | 手势组处理器配置参数。 |
684
685### onCancel
686
687onCancel(event: Callback\<void>): GestureGroupHandler
688
689Rotation手势识别成功,接收到触摸取消事件触发回调。
690
691**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
692
693**系统能力:** SystemCapability.ArkUI.ArkUI.Full
694
695**参数:**
696
697| 参数名 | 类型                              | 必填 | 说明                 |
698| ------ | --------------------------------- | ---- | -------------------- |
699| event  | [Callback](./ts-types.md#callback12)\<void> | 是 | 顺序组合手势(GestureMode.Sequence)取消后触发回调。 |
700
701**返回值:**
702
703| 类型 | 说明 |
704| -------- | -------- |
705| GestureGroupHandler | 返回当前手势组处理器对象。 |
706
707## GestureGroupGestureHandlerOptions
708
709手势组处理器配置参数。
710
711**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
712
713**系统能力:** SystemCapability.ArkUI.ArkUI.Full
714
715| 属性         | 类型                                   | 必填 | 描述                 |
716| ------------ | -------------------------------------- | ---- | -------------------- |
717| mode    | [GestureMode](./ts-combined-gestures.md#gesturemode枚举说明)                          | 是   | 设置组合手势识别模式。<br/>默认值:GestureMode.Sequence      |
718| gestures | [GestureHandler](#gesturehandlert)\<[TapGestureHandler](#tapgesturehandler) \| [LongPressGestureHandler](#longpressgesturehandler) \| [PanGestureHandler](#pangesturehandler) \| [SwipeGestureHandler](#swipegesturehandler) \| [PinchGestureHandler](#pinchgesturehandler) \| [RotationGestureHandler](#rotationgesturehandler) \| [GestureGroupHandler](#gesturegrouphandler)>[] | 是   | 手势组下需要包含的手势。<br/>**说明:**  <br/>当需要为一个组件同时添加单击和双击手势时,可在组合手势中添加两个TapGesture,需要双击手势在前,单击手势在后,否则不生效。 |
719
720## GesturePriority枚举说明
721
722**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
723
724| 名称 | 描述 |
725| -------- | -------- |
726| NORMAL | 普通优先级手势。 |
727| PRIORITY | 高优先级手势。|
728
729## 示例
730
731见[动态手势设置](./ts-universal-attributes-gesture-modifier.md#动态手势设置)。
732