• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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| isFingerCountLimited<sup>15+</sup> | boolean | 否 | 是否检查触摸屏幕的手指数量。true表示检查触摸屏幕的手指数量,false表示不检查触摸屏幕的手指数量。如果触摸手指的数量不等于设置的触发点击的手指数(即上述fingers参数),那么该手势识别失败。<br>在多击事件中(上述count参数大于1),需要每一次点击的手指数都等于设置的触发点击的手指数,否则该手势识别失败。<br>默认值:false |
153
154## LongPressGestureHandler
155
156长按手势处理器对象类型。
157
158### constructor
159
160constructor(options?: LongPressGestureHandlerOptions)
161
162构造函数。
163
164**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
165
166**参数:**
167
168
169| 参数名  | 类型                                                         | 必填 | 说明               |
170| ------- | ------------------------------------------------------------ | ---- | ------------------ |
171| options | [LongPressGestureHandlerOptions](#longpressgesturehandleroptions) | 否   | 长按手势处理器配置参数。 |
172
173### onAction
174
175onAction(event: Callback\<GestureEvent>): LongPressGestureHandler
176
177LongPress手势识别成功回调。
178
179**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
180
181**系统能力:** SystemCapability.ArkUI.ArkUI.Full
182
183**参数:**
184
185| 参数名 | 类型                              | 必填 | 说明                 |
186| ------ | --------------------------------- | ---- | -------------------- |
187| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | LongPress手势识别成功回调。 |
188
189**返回值:**
190
191| 类型 | 说明 |
192| -------- | -------- |
193| LongPressGestureHandler | 返回当前长按手势处理器对象。 |
194
195### onActionEnd
196
197onActionEnd(event: Callback\<GestureEvent>): LongPressGestureHandler
198
199LongPress手势识别成功,最后一根手指抬起后触发回调。
200
201**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
202
203**系统能力:** SystemCapability.ArkUI.ArkUI.Full
204
205**参数:**
206
207| 参数名 | 类型                              | 必填 | 说明                 |
208| ------ | --------------------------------- | ---- | -------------------- |
209| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | LongPress手势识别成功,最后一根手指抬起后触发回调。 |
210
211**返回值:**
212
213| 类型 | 说明 |
214| -------- | -------- |
215| LongPressGestureHandler | 返回当前长按手势处理器对象。 |
216
217### onActionCancel
218
219onActionCancel(event: Callback\<void>): LongPressGestureHandler
220
221LongPress手势识别成功,接收到触摸取消事件触发回调。
222
223**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
224
225**系统能力:** SystemCapability.ArkUI.ArkUI.Full
226
227**参数:**
228
229| 参数名 | 类型                              | 必填 | 说明                 |
230| ------ | --------------------------------- | ---- | -------------------- |
231| event  | [Callback](./ts-types.md#callback12)\<void> | 是 | LongPress手势识别成功,接收到触摸取消事件触发回调。 |
232
233**返回值:**
234
235| 类型 | 说明 |
236| -------- | -------- |
237| LongPressGestureHandler | 返回当前长按手势处理器对象。 |
238
239## LongPressGestureHandlerOptions
240
241长按手势处理器配置参数。
242
243**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
244
245**系统能力:** SystemCapability.ArkUI.ArkUI.Full
246
247| 属性         | 类型                                   | 必填 | 描述                 |
248| ------------ | -------------------------------------- | ---- | -------------------- |
249| fingers | number | 否 | 触发长按的最少手指数,最小为1指,&nbsp;最大取值为10指。<br/>默认值:1 <br/> **说明:** <br/>手指按下后若发生超过15px的移动,则判定当前长按手势识别失败。|
250| repeat | boolean | 否 | 是否连续触发事件回调。true表示为连续触发事件回调,false表示不连续触发事件回调。<br/>默认值:false |
251| duration | number | 否 | 触发长按的最短时间,单位为毫秒(ms)。<br/>默认值:500 <br/>**说明:** <br/>取值范围:[0, +∞),设置小于等于0时,按照默认值500处理。|
252| isFingerCountLimited<sup>15+</sup> | boolean | 否 | 是否检查触摸屏幕的手指数量。true表示检查触摸屏幕的手指数量,false表示不检查触摸屏幕的手指数量。若触摸屏幕的手指的数量不等于设置的触发长按的最少手指数(即上述fingers参数),手势识别将失败。<br>对于已成功识别的手势,后续触摸屏幕的手指数变化,将不触发repeat事件(若触摸屏幕的手指数恢复到设置的触发长按的最少手指数时,可以触发[onAction](ts-basic-gestures-longpressgesture.md#事件)事件),但可以触发[onActionEnd](ts-basic-gestures-longpressgesture.md#事件)事件。<br>默认值:false |
253
254## PanGestureHandler
255
256拖动手势处理器对象类型。
257
258### constructor
259
260constructor(options?: PanGestureHandlerOptions)
261
262构造函数。
263
264**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
265
266**参数:**
267
268
269| 参数名  | 类型                                                         | 必填 | 说明               |
270| ------- | ------------------------------------------------------------ | ---- | ------------------ |
271| options | [PanGestureHandlerOptions](#pangesturehandleroptions) | 否   | 拖动手势处理器配置参数。 |
272
273### onActionStart
274
275onActionStart(event: Callback\<GestureEvent>): PanGestureHandler
276
277Pan手势识别成功回调。
278
279**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
280
281**系统能力:** SystemCapability.ArkUI.ArkUI.Full
282
283**参数:**
284
285| 参数名 | 类型                              | 必填 | 说明                 |
286| ------ | --------------------------------- | ---- | -------------------- |
287| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | Pan手势识别成功回调。 |
288
289**返回值:**
290
291| 类型 | 说明 |
292| -------- | -------- |
293| PanGestureHandler | 返回当前拖动手势处理器对象。 |
294
295### onActionUpdate
296
297onActionUpdate(event: Callback\<GestureEvent>): PanGestureHandler
298
299Pan手势移动过程中回调。
300
301**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
302
303**系统能力:** SystemCapability.ArkUI.ArkUI.Full
304
305**参数:**
306
307| 参数名 | 类型                              | 必填 | 说明                 |
308| ------ | --------------------------------- | ---- | -------------------- |
309| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | Pan手势移动过程中回调。<br/>fingerList为多根手指时,该回调监听每次只会更新一根手指的位置信息。 |
310
311**返回值:**
312
313| 类型 | 说明 |
314| -------- | -------- |
315| PanGestureHandler | 返回当前拖动手势处理器对象。 |
316
317### onActionEnd
318
319onActionEnd(event: Callback\<GestureEvent>): PanGestureHandler
320
321Pan手势识别成功,手指抬起后触发回调。
322
323**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
324
325**系统能力:** SystemCapability.ArkUI.ArkUI.Full
326
327**参数:**
328
329| 参数名 | 类型                              | 必填 | 说明                 |
330| ------ | --------------------------------- | ---- | -------------------- |
331| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | Pan手势识别成功,手指抬起后触发回调。 |
332
333**返回值:**
334
335| 类型 | 说明 |
336| -------- | -------- |
337| PanGestureHandler | 返回当前拖动手势处理器对象。 |
338
339### onActionCancel
340
341onActionCancel(event: Callback\<void>): PanGestureHandler
342
343Pan手势识别成功,接收到触摸取消事件触发回调。
344
345**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
346
347**系统能力:** SystemCapability.ArkUI.ArkUI.Full
348
349**参数:**
350
351| 参数名 | 类型                              | 必填 | 说明                 |
352| ------ | --------------------------------- | ---- | -------------------- |
353| event  | [Callback](./ts-types.md#callback12)\<void> | 是 | Pan手势识别成功,接收到触摸取消事件触发回调。 |
354
355**返回值:**
356
357| 类型 | 说明 |
358| -------- | -------- |
359| PanGestureHandler | 返回当前拖动手势处理器对象。 |
360
361## PanGestureHandlerOptions
362
363拖动手势处理器配置参数。
364
365**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
366
367**系统能力:** SystemCapability.ArkUI.ArkUI.Full
368
369| 属性         | 类型                                   | 必填 | 描述                 |
370| ------------ | -------------------------------------- | ---- | -------------------- |
371| fingers | number | 否 | 用于指定触发拖动的最少手指数,最小为1指,&nbsp;最大取值为10指。<br/>默认值:1<br/>取值范围:[1,10]<br/>**说明:** <br/>当设置的值小于1或不设置时,会被转化为默认值。 |
372| direction | [PanDirection](./ts-basic-gestures-pangesture.md#pandirection枚举说明) | 否 | 用于指定触发拖动的手势方向,此枚举值支持逻辑与(&amp;)和逻辑或(\|)运算。<br/>默认值:PanDirection.All |
373| distance | number | 否 | 用于指定触发拖动手势事件的最小拖动距离,单位为vp。<br/>默认值:5<br/>**说明:**<br/>[Tabs组件](ts-container-tabs.md)滑动与该拖动手势事件同时存在时,可将distance值设为1,使拖动更灵敏,避免造成事件错乱。<br/>取值范围:[0, +∞),当设定的值小于0时,按默认值5处理。 |
374| isFingerCountLimited<sup>15+</sup> | boolean | 否 | 是否检查触摸屏幕的手指数量。true表示检查触摸屏幕的手指数量,false表示不检查触摸屏幕的手指数量。若触摸屏幕的手指数量不等于设置的触发滑动的最少手指数(即上述fingers参数),手势将不会被识别。只有当触摸屏幕的手指数等于设置的触发滑动的最少手指数,并且滑动距离达到阈值时,手势才能被成功识别。<br>对于已成功识别的手势,后续改变触摸屏幕的手指数量不会引发[onActionUpdate](ts-basic-gestures-pangesture.md#事件)事件,但可以触发[onActionEnd](ts-basic-gestures-pangesture.md#事件)事件。<br>默认值:false |
375
376## SwipeGestureHandler
377
378滑动手势处理器对象类型。
379
380### constructor
381
382constructor(options?: SwipeGestureHandlerOptions)
383
384构造函数。
385
386**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
387
388**参数:**
389
390| 参数名  | 类型                                                         | 必填 | 说明               |
391| ------- | ------------------------------------------------------------ | ---- | ------------------ |
392| options | [SwipeGestureHandlerOptions](#swipegesturehandleroptions) | 否   | 滑动手势处理器配置参数。 |
393
394### onAction
395
396onAction(event: Callback\<GestureEvent>): SwipeGestureHandlerOptions
397
398Swipe手势识别成功回调。
399
400**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
401
402**系统能力:** SystemCapability.ArkUI.ArkUI.Full
403
404**参数:**
405
406| 参数名 | 类型                              | 必填 | 说明                 |
407| ------ | --------------------------------- | ---- | -------------------- |
408| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | Swipe手势识别成功回调。 |
409
410**返回值:**
411
412| 类型 | 说明 |
413| -------- | -------- |
414| SwipeGestureHandler | 返回当前滑动手势处理器对象。 |
415
416## SwipeGestureHandlerOptions
417
418滑动事件处理器配置参数。
419
420**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
421
422**系统能力:** SystemCapability.ArkUI.ArkUI.Full
423
424| 属性         | 类型                                   | 必填 | 描述                 |
425| ------------ | -------------------------------------- | ---- | -------------------- |
426| fingers | number | 否 | 触发滑动的最少手指数,默认为1,最小为1指,最大为10指。<br/>默认值:1 |
427| direction | [SwipeDirection](./ts-basic-gestures-swipegesture.md#swipedirection枚举说明) | 否 | 触发滑动手势的滑动方向。<br/>默认值:SwipeDirection.All |
428| speed | number | 否 | 识别滑动的最小速度。<br/>默认值:100VP/s <br/>**说明:** <br/>当滑动速度的值小于等于0时,会被转化为默认值。 |
429| isFingerCountLimited<sup>15+</sup> | boolean | 否 | 是否检查触摸屏幕的手指数量。true表示检查触摸屏幕的手指数量,false表示不检查触摸屏幕的手指数量。如果触摸手指的数量不等于设置的触发滑动的最少手指数(即上述fingers参数),手势识别将失败。<br>默认值:false |
430
431## PinchGestureHandler
432
433捏合手势处理器对象类型。
434
435### constructor
436
437constructor(options?: PinchGestureHandlerOptions)
438
439构造函数。
440
441**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
442
443**参数:**
444
445
446| 参数名  | 类型                                                         | 必填 | 说明               |
447| ------- | ------------------------------------------------------------ | ---- | ------------------ |
448| options | [PinchGestureHandlerOptions](#pinchgesturehandleroptions) | 否   | 捏合手势处理器配置参数。 |
449
450### onActionStart
451
452onActionStart(event: Callback\<GestureEvent>): PinchGestureHandler
453
454Pinch手势识别成功回调。
455
456**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
457
458**系统能力:** SystemCapability.ArkUI.ArkUI.Full
459
460**参数:**
461
462| 参数名 | 类型                              | 必填 | 说明                 |
463| ------ | --------------------------------- | ---- | -------------------- |
464| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | Pinch手势识别成功回调。 |
465
466**返回值:**
467
468| 类型 | 说明 |
469| -------- | -------- |
470| PinchGestureHandler | 返回当前拖动手势处理器对象。 |
471
472### onActionUpdate
473
474onActionUpdate(event: Callback\<GestureEvent>): PinchGestureHandler
475
476Pinch手势移动过程中回调。
477
478**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
479
480**系统能力:** SystemCapability.ArkUI.ArkUI.Full
481
482**参数:**
483
484| 参数名 | 类型                              | 必填 | 说明                 |
485| ------ | --------------------------------- | ---- | -------------------- |
486| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | Pinch手势移动过程中回调。 |
487
488**返回值:**
489
490| 类型 | 说明 |
491| -------- | -------- |
492| PinchGestureHandler | 返回当前拖动手势处理器对象。 |
493
494### onActionEnd
495
496onActionEnd(event: Callback\<GestureEvent>): PinchGestureHandler
497
498Pinch手势识别成功,手指抬起后触发回调。
499
500**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
501
502**系统能力:** SystemCapability.ArkUI.ArkUI.Full
503
504**参数:**
505
506| 参数名 | 类型                              | 必填 | 说明                 |
507| ------ | --------------------------------- | ---- | -------------------- |
508| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | Pinch手势识别成功,手指抬起后触发回调。 |
509
510**返回值:**
511
512| 类型 | 说明 |
513| -------- | -------- |
514| PinchGestureHandler | 返回当前拖动手势处理器对象。 |
515
516### onActionCancel
517
518onActionCancel(event: Callback\<void>): PinchGestureHandler
519
520Pinch手势识别成功,接收到触摸取消事件触发回调。
521
522**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
523
524**系统能力:** SystemCapability.ArkUI.ArkUI.Full
525
526**参数:**
527
528| 参数名 | 类型                              | 必填 | 说明                 |
529| ------ | --------------------------------- | ---- | -------------------- |
530| event  | [Callback](./ts-types.md#callback12)\<void> | 是 | Pinch手势识别成功,接收到触摸取消事件触发回调。 |
531
532**返回值:**
533
534| 类型 | 说明 |
535| -------- | -------- |
536| PinchGestureHandler | 返回当前拖动手势处理器对象。 |
537
538## PinchGestureHandlerOptions
539
540捏合手势处理器配置参数。
541
542**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
543
544**系统能力:** SystemCapability.ArkUI.ArkUI.Full
545
546| 属性         | 类型                                   | 必填 | 描述                 |
547| ------------ | -------------------------------------- | ---- | -------------------- |
548| fingers | number | 否 | 触发捏合的最少手指数,&nbsp;最小为2指,最大为5指。<br/>默认值:2 <br/>触发手势手指可以多于fingers数目,但只有先落下的与fingers相同数目的手指参与手势计算。 |
549| distance | number | 否 | 最小识别距离,单位为vp。<br/>默认值:5 <br/>**说明:** <br/> 当识别距离的值小于等于0时,会被转化为默认值。|
550| isFingerCountLimited<sup>15+</sup> | boolean | 否 | 是否检查触摸屏幕的手指数量。true表示检查触摸屏幕的手指数量,false表示不检查触摸屏幕的手指数量。若触摸屏幕的手指数量不等于设置的触发捏合的最少手指数(即上述fingers参数),手势将不会被识别。只有当触摸屏幕的手指数等于设置的触发捏合手势的最小手指数,并且滑动距离满足阈值要求时,手势才能被成功识别(只有先落下的两根手指参与手势计算,若抬起其中的一个,手势识别失败)。对于已经成功识别的手势,后续改变触摸屏幕的手指数量,将不会触发[onActionUpdate](ts-basic-gestures-pinchgesture.md#事件)事件,但可以触发[onActionEnd](ts-basic-gestures-pinchgesture.md#事件)事件。<br>默认值:false |
551
552## RotationGestureHandler
553
554旋转手势处理器对象类型。
555
556### constructor
557
558constructor(options?: RotationGestureHandlerOptions)
559
560构造函数。
561
562**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
563
564**参数:**
565
566
567| 参数名  | 类型                                                         | 必填 | 说明               |
568| ------- | ------------------------------------------------------------ | ---- | ------------------ |
569| options | [RotationGestureHandlerOptions](#rotationgesturehandleroptions) | 否   | 旋转手势处理器配置参数。 |
570
571### onActionStart
572
573onActionStart(event: Callback\<GestureEvent>): RotationGestureHandler
574
575Rotation手势识别成功回调。
576
577**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
578
579**系统能力:** SystemCapability.ArkUI.ArkUI.Full
580
581**参数:**
582
583| 参数名 | 类型                              | 必填 | 说明                 |
584| ------ | --------------------------------- | ---- | -------------------- |
585| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | Rotation手势识别成功回调。 |
586
587**返回值:**
588
589| 类型 | 说明 |
590| -------- | -------- |
591| RotationGestureHandler | 返回当前拖动手势处理器对象。 |
592
593### onActionUpdate
594
595onActionUpdate(event: Callback\<GestureEvent>): RotationGestureHandler
596
597Rotation手势移动过程中回调。
598
599**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
600
601**系统能力:** SystemCapability.ArkUI.ArkUI.Full
602
603**参数:**
604
605| 参数名 | 类型                              | 必填 | 说明                 |
606| ------ | --------------------------------- | ---- | -------------------- |
607| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | Rotation手势移动过程中回调。 |
608
609**返回值:**
610
611| 类型 | 说明 |
612| -------- | -------- |
613| RotationGestureHandler | 返回当前拖动手势处理器对象。 |
614
615### onActionEnd
616
617onActionEnd(event: Callback\<GestureEvent>): RotationGestureHandler
618
619Rotation手势识别成功,手指抬起后触发回调。
620
621**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
622
623**系统能力:** SystemCapability.ArkUI.ArkUI.Full
624
625**参数:**
626
627| 参数名 | 类型                              | 必填 | 说明                 |
628| ------ | --------------------------------- | ---- | -------------------- |
629| event  | [Callback](./ts-types.md#callback12)<[GestureEvent](ts-gesture-settings.md#gestureevent对象说明)> | 是 | Rotation手势识别成功,手指抬起后触发回调。 |
630
631**返回值:**
632
633| 类型 | 说明 |
634| -------- | -------- |
635| RotationGestureHandler | 返回当前拖动手势处理器对象。 |
636
637### onActionCancel
638
639onActionCancel(event: Callback\<void>): RotationGestureHandler
640
641Rotation手势识别成功,接收到触摸取消事件触发回调。
642
643**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
644
645**系统能力:** SystemCapability.ArkUI.ArkUI.Full
646
647**参数:**
648
649| 参数名 | 类型                              | 必填 | 说明                 |
650| ------ | --------------------------------- | ---- | -------------------- |
651| event  | [Callback](./ts-types.md#callback12)\<void> | 是 | Rotation手势识别成功,接收到触摸取消事件触发回调。 |
652
653**返回值:**
654
655| 类型 | 说明 |
656| -------- | -------- |
657| RotationGestureHandler | 返回当前拖动手势处理器对象。 |
658
659## RotationGestureHandlerOptions
660
661旋转手势处理器配置参数。
662
663**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
664
665**系统能力:** SystemCapability.ArkUI.ArkUI.Full
666
667| 属性         | 类型                                   | 必填 | 描述                 |
668| ------------ | -------------------------------------- | ---- | -------------------- |
669| fingers | number | 否 | 触发旋转的最少手指数,&nbsp;最小为2指,最大为5指。<br/>默认值:2 <br/>触发手势手指可以多于fingers数目,但只有先落下的两指参与手势计算。|
670| angle | number | 否 | 触发旋转手势的最小改变度数,单位为deg。<br/>默认值:1 <br/>**说明:** <br/>当改变度数的值小于等于0或大于360时,会被转化为默认值。|
671| isFingerCountLimited<sup>15+</sup> | boolean | 否 | 是否检查触摸屏幕的手指数量。true表示检查触摸屏幕的手指数量,false表示不检查触摸屏幕的手指数量。若触摸屏幕的手指数量不等于设置的触发旋转的最少手指数(即上述fingers参数),手势将不会被识别。只有当触摸屏幕的手指数等于设置的触发旋转的最少手指数,并且滑动距离达到阈值时,手势才能被成功识别(只有先落下的两根手指参与手势计算,若抬起其中的一个,手势识别失败)。<br>对于已成功识别的手势,后续改变触摸屏幕的手指数量,不会触发[onActionUpdate](ts-basic-gestures-rotationgesture.md#事件)事件,但可以触发[onActionEnd](ts-basic-gestures-rotationgesture.md#事件)事件。<br>默认值:false |
672
673## GestureGroupHandler
674
675手势组处理器对象类型。
676
677### constructor
678
679constructor(options?: GestureGroupGestureHandlerOptions)
680
681构造函数。
682
683**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
684
685**参数:**
686
687| 参数名  | 类型                                                         | 必填 | 说明               |
688| ------- | ------------------------------------------------------------ | ---- | ------------------ |
689| options | [GestureGroupGestureHandlerOptions](#gesturegroupgesturehandleroptions) | 否   | 手势组处理器配置参数。 |
690
691### onCancel
692
693onCancel(event: Callback\<void>): GestureGroupHandler
694
695Rotation手势识别成功,接收到触摸取消事件触发回调。
696
697**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
698
699**系统能力:** SystemCapability.ArkUI.ArkUI.Full
700
701**参数:**
702
703| 参数名 | 类型                              | 必填 | 说明                 |
704| ------ | --------------------------------- | ---- | -------------------- |
705| event  | [Callback](./ts-types.md#callback12)\<void> | 是 | 顺序组合手势(GestureMode.Sequence)取消后触发回调。 |
706
707**返回值:**
708
709| 类型 | 说明 |
710| -------- | -------- |
711| GestureGroupHandler | 返回当前手势组处理器对象。 |
712
713## GestureGroupGestureHandlerOptions
714
715手势组处理器配置参数。
716
717**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
718
719**系统能力:** SystemCapability.ArkUI.ArkUI.Full
720
721| 属性         | 类型                                   | 必填 | 描述                 |
722| ------------ | -------------------------------------- | ---- | -------------------- |
723| mode    | [GestureMode](./ts-combined-gestures.md#gesturemode枚举说明)                          | 是   | 设置组合手势识别模式。<br/>默认值:GestureMode.Sequence      |
724| gestures | [GestureHandler](#gesturehandlert)\<[TapGestureHandler](#tapgesturehandler) \| [LongPressGestureHandler](#longpressgesturehandler) \| [PanGestureHandler](#pangesturehandler) \| [SwipeGestureHandler](#swipegesturehandler) \| [PinchGestureHandler](#pinchgesturehandler) \| [RotationGestureHandler](#rotationgesturehandler) \| [GestureGroupHandler](#gesturegrouphandler)>[] | 是   | 手势组下需要包含的手势。<br/>**说明:**  <br/>当需要为一个组件同时添加单击和双击手势时,可在组合手势中添加两个TapGesture,需要双击手势在前,单击手势在后,否则不生效。 |
725
726## GesturePriority枚举说明
727
728**原子化服务API:** 从API version 12开始,该接口支持在原子化服务中使用。
729
730| 名称 | 描述 |
731| -------- | -------- |
732| NORMAL | 普通优先级手势。 |
733| PRIORITY | 高优先级手势。|
734
735## 示例
736
737见[动态手势设置](./ts-universal-attributes-gesture-modifier.md#动态手势设置)。
738