往期鸿蒙全套实战文章必看:(文中附带全栈鸿蒙学习资料)
- 鸿蒙开发焦点知识点,看这篇文章就够了
- 最新版!鸿蒙HarmonyOS Next应用开发实战学习门路
- 鸿蒙HarmonyOS NEXT开发技术最全学习门路指南
- 鸿蒙应用开发实战项目,看这一篇文章就够了(部门项目附源码)
设置组件绑定的手势
用于设置组件绑定的手势。可以通过UIGestureEvent对象调用其接口添加或删除手势。
说明
本模块首批接口从API version 12开始支持,后续版本的新增接口,采用上角标单独标志接口的起始版本。
UIGestureEvent
用于设置组件绑定的手势。
addGesture
addGesture(gesture: GestureHandler<T>, priority?: GesturePriority, mask?: GestureMask): void
添加手势。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
参数:
参数名类型必填说明gestureGestureHandler<T>是手势处理器对象。priorityGesturePriority否绑定手势的优先级。maskGestureMask否事故相应设置。 addParallelGesture
addParallelGesture(gesture: GestureHandler<T>, mask?: GestureMask): void
绑定可与子组件手势同时触发的手势。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
参数:
参数名类型必填说明gestureGestureHandler<T>是手势处理器对象。maskGestureMask否事故相应设置。 removeGestureByTag
removeGestureByTag(tag: string): void
移除该组件上通过modifier绑定的设置为指定标志的手势。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
参数:
参数名类型必填说明tagstring是手势处理器标志。 clearGestures
clearGestures(): void
清除该组件上通过modifier绑定的所有手势。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
GestureHandler<T>
手势对象的底子类型。
tag
tag(tag: string): T
设置手势处理器的标志。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
参数:
名称类型必填描述tagstring是设置手势处理器标志。 TapGestureHandler
点击手势处理器对象类型。
constructor
constructor(options?: TapGestureHandlerOptions)
构造函数。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
参数:
参数名类型必填说明optionsTapGestureHandlerOptions否点击手势处理器配置参数。 onAction
onAction(event: Callback<GestureEvent>): TapGestureHandler
Tap手势辨认乐成回调。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名类型必填说明eventCallback<GestureEvent>是Tap手势辨认乐成回调。 返回值:
类型说明TapGestureHandler返回当前点击手势处理器对象。 TapGestureHandlerOptions
点击手势处理器配置参数。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
属性类型必填描述countnumber否 辨认的连续点击次数。当设置的值小于1或不设置时,会被转化为默认值。
默认值:1
说明:
1. 当配置多击时,上一次的最后一根手指抬起和下一次的第一根手指按下的超时时间为300毫秒。
2. 当上次点击的位置与当前点击的位置间隔超过60vp时,手势辨认失败。
fingersnumber否 触发点击的手指数,最小为1指, 最大为10指。当设置小于1的值或不设置时,会被转化为默认值。
默认值:1
说明:
1. 当配置多指时,第一根手指按下后300毫秒内未有充足的手指数按下,手势辨认失败,第一根手指抬起后300毫秒内未有充足的手指抬起,手势辨认失败。
2. 实际点击手指数超过配置值,手势辨认乐成。
LongPressGestureHandler
长按手势处理器对象类型。
constructor
constructor(options?: LongPressGestureHandlerOptions)
构造函数。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
参数:
参数名类型必填说明optionsLongPressGestureHandlerOptions否长按手势处理器配置参数。 onAction
onAction(event: Callback<GestureEvent>): LongPressGestureHandler
LongPress手势辨认乐成回调。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名类型必填说明eventCallback<GestureEvent>是LongPress手势辨认乐成回调。 返回值:
类型说明LongPressGestureHandler返回当前长按手势处理器对象。 onActionEnd
onActionEnd(event: Callback<GestureEvent>): LongPressGestureHandler
LongPress手势辨认乐成,最后一根手指抬起后触发回调。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名类型必填说明eventCallback<GestureEvent>是LongPress手势辨认乐成,最后一根手指抬起后触发回调。 返回值:
类型说明LongPressGestureHandler返回当前长按手势处理器对象。 onActionCancel
onActionCancel(event: Callback<void>): LongPressGestureHandler
LongPress手势辨认乐成,接收到触摸取消事故触发回调。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名类型必填说明eventCallback<void>是LongPress手势辨认乐成,接收到触摸取消事故触发回调。 返回值:
类型说明LongPressGestureHandler返回当前长按手势处理器对象。 LongPressGestureHandlerOptions
长按手势处理器配置参数。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
属性类型必填描述fingersnumber否 触发长按的最少手指数,最小为1指, 最大取值为10指。
默认值:1
说明:
手指按下后若发生超过15px的移动,则判定当前长按手势辨认失败。
repeatboolean否 是否连续触发事故回调。
默认值:false
durationnumber否 触发长按的最短时间,单元为毫秒(ms)。
默认值:500
说明:
设置小于等于0时,按照默认值500处理。
PanGestureHandler
拖动手势处理器对象类型。
constructor
constructor(options?: PanGestureHandlerOptions)
构造函数。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
参数:
参数名类型必填说明optionsPanGestureHandlerOptions否拖动手势处理器配置参数。 onActionStart
onActionStart(event: Callback<GestureEvent>): PanGestureHandler
Pan手势辨认乐成回调。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名类型必填说明eventCallback<GestureEvent>是Pan手势辨认乐成回调。 返回值:
类型说明PanGestureHandler返回当前拖动手势处理器对象。 onActionUpdate
onActionUpdate(event: Callback<GestureEvent>): PanGestureHandler
Pan手势移动过程中回调。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名类型必填说明eventCallback<GestureEvent>是 Pan手势移动过程中回调。
fingerList为多根手指时,该回调监听每次只会更新一根手指的位置信息。
返回值:
类型说明PanGestureHandler返回当前拖动手势处理器对象。 onActionEnd
onActionEnd(event: Callback<GestureEvent>): PanGestureHandler
Pan手势辨认乐成,手指抬起后触发回调。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名类型必填说明eventCallback<GestureEvent>是Pan手势辨认乐成,手指抬起后触发回调。 返回值:
类型说明PanGestureHandler返回当前拖动手势处理器对象。 onActionCancel
onActionCancel(event: Callback<void>): PanGestureHandler
Pan手势辨认乐成,接收到触摸取消事故触发回调。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名类型必填说明eventCallback<void>是Pan手势辨认乐成,接收到触摸取消事故触发回调。 返回值:
类型说明PanGestureHandler返回当前拖动手势处理器对象。 PanGestureHandlerOptions
拖动手势处理器配置参数。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
属性类型必填描述fingersnumber否 用于指定触发拖动的最少手指数,最小为1指, 最大取值为10指。
默认值:1
取值范围:[1,10]
说明:
当设置的值小于1或不设置时,会被转化为默认值。
directionPanDirection否 用于指定触发拖动的手势方向,此摆列值支持逻辑与(&)和逻辑或(|)运算。
默认值:PanDirection.All
distancenumber否 用于指定触发拖动手势事故的最小拖动间隔,单元为vp。
默认值:5
说明:
Tabs组件滑动与该拖动手势事故同时存在时,可将distance值设为1,使拖动更敏捷,避免造成事故庞杂。
当设定的值小于0时,按默认值5处理。
SwipeGestureHandler
滑动手势处理器对象类型。
constructor
constructor(options?: SwipeGestureHandlerOptions)
构造函数。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
参数:
参数名类型必填说明optionsSwipeGestureHandlerOptions否滑动手势处理器配置参数。 onAction
onAction(event: Callback<GestureEvent>): SwipeGestureHandlerOptions
Swipe手势辨认乐成回调。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名类型必填说明eventCallback<GestureEvent>是Swipe手势辨认乐成回调。 返回值:
类型说明SwipeGestureHandler返回当前滑动手势处理器对象。 SwipeGestureHandlerOptions
滑动事故处理器配置参数。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
属性类型必填描述fingersnumber否 触发滑动的最少手指数,默以为1,最小为1指,最大为10指。
默认值:1
directionSwipeDirection否 触发滑动手势的滑动方向。
默认值:SwipeDirection.All
speednumber否 辨认滑动的最小速率。
默认值:100VP/s
说明:
当滑动速率的值小于等于0时,会被转化为默认值。
PinchGestureHandler
捏合手势处理器对象类型。
constructor
constructor(options?: PinchGestureHandlerOptions)
构造函数。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
参数:
参数名类型必填说明optionsPinchGestureHandlerOptions否捏合手势处理器配置参数。 onActionStart
onActionStart(event: Callback<GestureEvent>): PinchGestureHandler
Pinch手势辨认乐成回调。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名类型必填说明eventCallback<GestureEvent>是Pinch手势辨认乐成回调。 返回值:
类型说明PinchGestureHandler返回当前拖动手势处理器对象。 onActionUpdate
onActionUpdate(event: Callback<GestureEvent>): PinchGestureHandler
Pinch手势移动过程中回调。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名类型必填说明eventCallback<GestureEvent>是Pinch手势移动过程中回调。 返回值:
类型说明PinchGestureHandler返回当前拖动手势处理器对象。 onActionEnd
onActionEnd(event: Callback<GestureEvent>): PinchGestureHandler
Pinch手势辨认乐成,手指抬起后触发回调。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名类型必填说明eventCallback<GestureEvent>是Pinch手势辨认乐成,手指抬起后触发回调。 返回值:
类型说明PinchGestureHandler返回当前拖动手势处理器对象。 onActionCancel
onActionCancel(event: Callback<void>): PinchGestureHandler
Pinch手势辨认乐成,接收到触摸取消事故触发回调。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名类型必填说明eventCallback<void>是Pinch手势辨认乐成,接收到触摸取消事故触发回调。 返回值:
类型说明PinchGestureHandler返回当前拖动手势处理器对象。 PinchGestureHandlerOptions
捏合手势处理器配置参数。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
属性类型必填描述fingersnumber否 触发捏合的最少手指数, 最小为2指,最大为5指。
默认值:2
触发手势手指可以多于fingers数量,但只有先落下的与fingers雷同数量的手指参与手势盘算。
distancenumber否 最小辨认间隔,单元为vp。
默认值:5
说明:
当辨认间隔的值小于等于0时,会被转化为默认值。
RotationGestureHandler
旋转手势处理器对象类型。
constructor
constructor(options?: RotationGestureHandlerOptions)
构造函数。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
参数:
参数名类型必填说明optionsRotationGestureHandlerOptions否旋转手势处理器配置参数。 onActionStart
onActionStart(event: Callback<GestureEvent>): RotationGestureHandler
Rotation手势辨认乐成回调。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名类型必填说明eventCallback<GestureEvent>是Rotation手势辨认乐成回调。 返回值:
类型说明RotationGestureHandler返回当前拖动手势处理器对象。 onActionUpdate
onActionUpdate(event: Callback<GestureEvent>): RotationGestureHandler
Rotation手势移动过程中回调。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名类型必填说明eventCallback<GestureEvent>是Rotation手势移动过程中回调。 返回值:
类型说明RotationGestureHandler返回当前拖动手势处理器对象。 onActionEnd
onActionEnd(event: Callback<GestureEvent>): RotationGestureHandler
Rotation手势辨认乐成,手指抬起后触发回调。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名类型必填说明eventCallback<GestureEvent>是Rotation手势辨认乐成,手指抬起后触发回调。 返回值:
类型说明RotationGestureHandler返回当前拖动手势处理器对象。 onActionCancel
onActionCancel(event: Callback<void>): RotationGestureHandler
Rotation手势辨认乐成,接收到触摸取消事故触发回调。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名类型必填说明eventCallback<void>是Rotation手势辨认乐成,接收到触摸取消事故触发回调。 返回值:
类型说明RotationGestureHandler返回当前拖动手势处理器对象。 RotationGestureHandlerOptions
旋转手势处理器配置参数。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
属性类型必填描述fingersnumber否 触发旋转的最少手指数, 最小为2指,最大为5指。
默认值:2
触发手势手指可以多于fingers数量,但只有先落下的两指参与手势盘算。
anglenumber否 触发旋转手势的最小改变度数,单元为deg。
默认值:1
说明:
当改变度数的值小于等于0或大于360时,会被转化为默认值。
GestureGroupHandler
手势组处理器对象类型。
constructor
constructor(options?: GestureGroupGestureHandlerOptions)
构造函数。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
参数:
参数名类型必填说明optionsGestureGroupGestureHandlerOptions否手势组处理器配置参数。 onCancel
onCancel(event: Callback<void>): GestureGroupHandler
Rotation手势辨认乐成,接收到触摸取消事故触发回调。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
参数:
参数名类型必填说明eventCallback<void>是顺序组合手势(GestureMode.Sequence)取消后触发回调。 返回值:
类型说明GestureGroupHandler返回当前手势组处理器对象。 GestureGroupGestureHandlerOptions
手势组处理器配置参数。
元服务API: 从API version 12开始,该接口支持在元服务中利用。
体系能力: SystemCapability.ArkUI.ArkUI.Full
属性类型必填描述modeGestureMode是 设置组合手势辨认模式。
默认值:GestureMode.Sequence
gesturesGestureHandler<TapGestureHandler | LongPressGestureHandler | PanGestureHandler | SwipeGestureHandler | PinchGestureHandler | RotationGestureHandler | GestureGroupHandler>[]是 手势组下需要包含的手势。
说明:
当需要为一个组件同时添加单击和双击手势时,可在组合手势中添加两个TapGesture,需要双击手势在前,单击手势在后,否则不见效。
GesturePriority摆列说明
元服务API: 从API version 12开始,该接口支持在元服务中利用。
名称描述NORMAL普通优先级手势。PRIORITY高优先级手势。
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!更多信息从访问主页:qidao123.com:ToB企服之家,中国第一个企服评测及商务社交产业平台。 |