为组件提供自定义手势判定能力。开发者可根据需要,在手势识别期间,决定是否响应手势。
说明
从API Version 11开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。
onGestureJudgeBegin
onGestureJudgeBegin(callback: (gestureInfo: GestureInfo, event: BaseGestureEvent) => GestureJudgeResult): T
元服务API: 从API version 12开始,该接口支持在元服务中使用。
参数:
参数名 | 参数类型 | 必填 | 参数描述 |
---|---|---|---|
callback | (gestureInfo: [GestureInfo], event: [BaseGestureEvent]) => [GestureJudgeResult] | 是 | 给组件绑定自定义手势判定回调,当绑定到该组件的手势被接受时,会触发用户定义的回调来获取结果。 |
返回值:
类型 | 说明 |
---|---|
T | 返回当前组件。 |
GestureJudgeResult11+
元服务API: 从API version 12开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
名称 | 描述 |
---|---|
CONTINUE | 不影响系统手势判定流程。 |
REJECT | 对于用户自定义的手势判定结果为失败。 |
GestureInfo对象说明
元服务API: 从API version 12开始,该接口支持在元服务中使用。
名称 | 类型 | 描述 |
---|---|---|
tag | string | 手势标记。**说明:**如果未设置事件标识tag属性的情况下,此处tag不返回或者返回undefined。 |
type | [GestureControl.GestureType] | 手势类型。**说明:**当手势为未暴露类型的系统内置手势事件时,type的值为-1。 |
isSystemGesture | boolean | 判断当前手势是否是组件自带的手势。默认值:false |
GestureType11+
元服务API: 从API version 11开始,该接口支持在元服务中使用。
系统能力: SystemCapability.ArkUI.ArkUI.Full
名称 | 值 | 描述 |
---|---|---|
TAP_GESTURE | 0 | 点击手势 |
LONG_PRESS_GESTURE | 1 | 长按手势 |
PAN_GESTURE | 2 | 拖动手势 |
PINCH_GESTURE | 3 | 捏合手势 |
SWIPE_GESTURE | 4 | 滑动手势 |
ROTATION_GESTURE | 5 |