diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md index 634e49c72c9b3e9fa1dec5c393e943168126fb63..8174f0054595ed1ced2a694967e9e193f3909932 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-longpressgesture.md @@ -24,8 +24,8 @@ LongPressGesture(value?: { fingers?: number, repeat?: boolean, duration?: number | 名称 | 功能描述 | | -------- | -------- | -| onAction(event:(event?: [GestureEvent](ts-gesture-settings.md)) => void) | LongPress手势识别成功回调。 | -| onActionEnd(event:(event?: [GestureEvent](ts-gesture-settings.md)) => void) | LongPress手势识别成功，手指抬起后触发回调。 | +| onAction(event:(event?: [GestureEvent](ts-gesture-settings.md#gestureevent对象说明)) => void) | LongPress手势识别成功回调。 | +| onActionEnd(event:(event?: [GestureEvent](ts-gesture-settings.md#gestureevent对象说明)) => void) | LongPress手势识别成功，手指抬起后触发回调。 | | onActionCancel(event: () => void) | LongPress手势识别成功，接收到触摸取消事件触发回调。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md index e7cdbf89ea19c575332a11adfcebca62d1b3be55..c4c190c8e0387d503cf437c6314c1aace48bf393 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pangesture.md @@ -60,9 +60,9 @@ PanGestureOptions(value?: { fingers?: number; direction?: PanDirection; distance | 名称 | 功能描述 | | -------- | -------- | -| onActionStart(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pan手势识别成功回调。 | -| onActionUpdate(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pan手势移动过程中回调。 | -| onActionEnd(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pan手势识别成功，手指抬起后触发回调。 | +| onActionStart(event: (event?: [GestureEvent](ts-gesture-settings.md#gestureevent对象说明)) => void) | Pan手势识别成功回调。 | +| onActionUpdate(event: (event?: [GestureEvent](ts-gesture-settings.md#gestureevent对象说明)) => void) | Pan手势移动过程中回调。 | +| onActionEnd(event: (event?: [GestureEvent](ts-gesture-settings.md#gestureevent对象说明)) => void) | Pan手势识别成功，手指抬起后触发回调。 | | onActionCancel(event: () => void) | Pan手势识别成功，接收到触摸取消事件触发回调。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md index e292fb68ce1481903e2ab603e81e3ab09d72c14e..467ed9c6a4a5be3568ad27f260cb74c81afb28fb 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-pinchgesture.md @@ -23,9 +23,9 @@ PinchGesture(value?: { fingers?: number, distance?: number }) | 名称 | 功能描述 | | -------- | -------- | -| onActionStart(event:(event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pinch手势识别成功回调。 | -| onActionUpdate(event:(event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pinch手势移动过程中回调。 | -| onActionEnd(event:(event?: [GestureEvent](ts-gesture-settings.md)) => void) | Pinch手势识别成功，手指抬起后触发回调。 | +| onActionStart(event:(event?: [GestureEvent](ts-gesture-settings.md#gestureevent对象说明)) => void) | Pinch手势识别成功回调。 | +| onActionUpdate(event:(event?: [GestureEvent](ts-gesture-settings.md#gestureevent对象说明)) => void) | Pinch手势移动过程中回调。 | +| onActionEnd(event:(event?: [GestureEvent](ts-gesture-settings.md#gestureevent对象说明)) => void) | Pinch手势识别成功，手指抬起后触发回调。 | | onActionCancel(event: () => void) | Pinch手势识别成功，接收到触摸取消事件触发回调。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md index 47420c92cbbfdffdec358305a1d4ec32a28e4d0d..9dd8ca8ff89bc90dc0eec4e7e31d96ba77fe6295 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-rotationgesture.md @@ -23,9 +23,9 @@ RotationGesture(value?: { fingers?: number, angle?: number }) | 名称 | 功能描述 | | -------- | -------- | -| onActionStart(event:(event?: [GestureEvent](ts-gesture-settings.md)) => void) | Rotation手势识别成功回调。 | -| onActionUpdate(event:(event?: [GestureEvent](ts-gesture-settings.md)) => void) | Rotation手势移动过程中回调。 | -| onActionEnd(event:(event?: [GestureEvent](ts-gesture-settings.md)) => void) | Rotation手势识别成功，手指抬起后触发回调。 | +| onActionStart(event:(event?: [GestureEvent](ts-gesture-settings.md#gestureevent对象说明)) => void) | Rotation手势识别成功回调。 | +| onActionUpdate(event:(event?: [GestureEvent](ts-gesture-settings.md#gestureevent对象说明)) => void) | Rotation手势移动过程中回调。 | +| onActionEnd(event:(event?: [GestureEvent](ts-gesture-settings.md#gestureevent对象说明)) => void) | Rotation手势识别成功，手指抬起后触发回调。 | | onActionCancel(event: () => void) | Rotation手势识别成功，接收到触摸取消事件触发回调。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md index b7973dadb17bf877a79aea035335e15660b9aa05..52a4901dd3ccac0070eaebb0cb993e9a501bcf6e 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-swipegesture.md @@ -33,7 +33,7 @@ SwipeGesture(value?: { fingers?: number; direction?: SwipeDirection; speed?: num | 名称 | 功能描述 | | -------- | -------- | -| onAction(event:(event?: [GestureEvent](ts-gesture-settings.md)) => void) | 滑动手势识别成功回调。 | +| onAction(event:(event?: [GestureEvent](ts-gesture-settings.md#gestureevent对象说明)) => void) | 滑动手势识别成功回调。 | ![zh-cn_image_0000001231374559](figures/zh-cn_image_0000001231374661.png) ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md index 68b27342c2b9fcc3cd267988c9b9fb6f601c05cf..6c27f6bbcf09bedabada2e7e57fc936842c54365 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-basic-gestures-tapgesture.md @@ -23,7 +23,7 @@ TapGesture(value?: { count?: number, fingers?: number }) | 名称 | 功能描述 | | -------- | -------- | -| onAction(event: (event?: [GestureEvent](ts-gesture-settings.md)) => void) | Tap手势识别成功回调。 | +| onAction(event: (event?: [GestureEvent](ts-gesture-settings.md#gestureevent对象说明)) => void) | Tap手势识别成功回调。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-combined-gestures.md b/zh-cn/application-dev/reference/arkui-ts/ts-combined-gestures.md index b702af0af1c0573fb956353f282a4704dd47c084..4b4886280dbfb229d401128e40151488ca57ed2b 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-combined-gestures.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-combined-gestures.md @@ -6,11 +6,6 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 接口 GestureGroup(mode: GestureMode, ...gesture: GestureType[]) @@ -18,10 +13,10 @@ GestureGroup(mode: GestureMode, ...gesture: GestureType[]) - 参数 | 参数名 | 参数类型 | 必填 | 默认值 | 参数描述 | | -------- | -------- | -------- | -------- | -------- | - | mode | GestureMode | 是 | - | 设置组合手势识别模式。 | + | mode | [GestureMode](#gesturemode枚举说明) | 是 | - | 设置组合手势识别模式。 | | gesture | [TapGesture](ts-basic-gestures-tapgesture.md)
\| [LongPressGesture](ts-basic-gestures-longpressgesture.md)
\| [PanGesture](ts-basic-gestures-pangesture.md)
\| [PinchGesture](ts-basic-gestures-pinchgesture.md)
\| [RotationGesture](ts-basic-gestures-rotationgesture.md) | 是 | - | 可变长参数，1个或者多个基础手势类型，这些手势会被组合识别。 | -- GestureMode枚举说明 +## GestureMode枚举说明 | 名称 | 描述 | | -------- | -------- | | Sequence | 顺序识别，按照手势的注册顺序识别手势，直到所有手势识别成功。当有一个手势识别失败时，所有手势识别失败。 | diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-container-listitemgroup.md b/zh-cn/application-dev/reference/arkui-ts/ts-container-listitemgroup.md index d9c1b34bf09f77b677ba7dfb9d7e9f137d3661da..aded2d381ea5da21148c91ea2aadb5adfc73defe 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-container-listitemgroup.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-container-listitemgroup.md @@ -8,7 +8,7 @@ ## 使用说明 当ListItemGroup的父组件List的listDirection属性为Axis.Vertical时，不允许设置ListItemGroup组件的height属性。ListItemGroup的高度为header高度、footer高度和所有ListItem布局后总高度之和。当父组件List的listDirection属性为Axis.Horizontal时，不允许设置ListItemGroup组件的width属性。ListItemGroup的宽度为header宽度、footer宽度和所有ListItem布局后总宽度之和。 -当前ListItemGroup内部的ListItem不支持编辑、框选、拖拽功能，即ListItemGroup内部的ListItem组件editable、selectable属性不生效。 +当前ListItemGroup内部的ListItem不支持编辑、框选、拖拽功能，即组件editable、selectable属性不生效。 ## 子组件 @@ -31,7 +31,7 @@ ListItemGroup(options?: {header?: CustomBuilder, footer?: CustomBuilder, space?: | 名称 | 参数类型 | 描述 | | -------- | -------- | -------- | -| divider | {
strokeWidth: [Length](ts-types.md#length),
color?: [ResourceColor](ts-types.md#resourcecolor8),
startMargin?: [Length](ts-types.md#length),
endMargin?: [Length](ts-types.md#length)
} \| null | 用于设置ListItem分割线样式，默认无分割线。
strokeWidth: 分割线的线宽。
color: 分割线的颜色。
startMargin： 分割线距离列表侧边起始端的距离。
endMargin: 分割线距离列表侧边结束端的距离。 | +| divider | {
strokeWidth: [Length](ts-types.md#length),
color?: [ResourceColor](ts-types.md#resourcecolor8),
startMargin?: [Length](ts-types.md#length),
endMargin?: [Length](ts-types.md#length)
} \| null | 用于设置ListItem分割线及分割线样式，设置值为null时无分割线。
strokeWidth: 分割线的线宽。
color: 分割线的颜色。
startMargin： 分割线距离列表侧边起始端的距离。
endMargin: 分割线距离列表侧边结束端的距离。 | ## 示例 diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-gesture-settings.md b/zh-cn/application-dev/reference/arkui-ts/ts-gesture-settings.md index 31571927efafe26c33abdd83139da9c3eb7db932..b0341789d351abd4aeff5c013c1ccf56db7f9b34 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-gesture-settings.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-gesture-settings.md @@ -6,11 +6,6 @@ > 从API Version 7开始支持。后续版本如有新增内容，则采用上角标单独标记该内容的起始版本。 -## 权限列表 - -无 - - ## 绑定手势识别 @@ -19,63 +14,63 @@ | 名称 | 参数类型 | 默认值 | 描述 | | -------- | -------- | -------- | -------- | -| gesture | gesture: GestureType,
mask?: GestureMask | gesture: -，
mask: GestureMask.Normal | 绑定手势识别。
- gesture: 绑定的手势类型， 
- mask: 事件响应设置。 | -| priorityGesture | gesture: GestureType,
mask?: GestureMask | gesture: -，
mask: GestureMask.Normal | 绑定优先识别手势。
- gesture: 绑定的手势类型， 
- mask: 事件响应设置。
默认情况下，子组件优先于父组件识别手势，当父组件配置priorityGesture时，父组件优先于子组件进行识别。 | -| parallelGesture | gesture: GestureType,
mask?: GestureMask | gesture: -，
mask: GestureMask.Normal | 绑定可与子组件手势同时触发的手势。
- gesture: 绑定的手势类型。 
- mask: 事件响应设置。
手势事件为非冒泡事件。父组件设置parallelGesture时，父子组件相同的手势事件都可以触发，实现类似冒泡效果。 | +| gesture | gesture: [GestureType](#gesturetype),
mask?: [GestureMask](#gesturemask枚举说明) | gesture: -，
mask: GestureMask.Normal | 绑定手势。
- gesture: 绑定的手势类型， 
- mask: 事件响应设置。 | +| priorityGesture | gesture: [GestureType](#gesturetype),
mask?: [GestureMask](#gesturemask枚举说明) | gesture: -，
mask: GestureMask.Normal | 绑定优先识别手势。
- gesture: 绑定的手势类型， 
- mask: 事件响应设置。
默认情况下，子组件优先识别通过gesture绑定的手势，当父组件配置priorityGesture时，子组件优先识别priorityGesture绑定的手势。 | +| parallelGesture | gesture: [GestureType](#gesturetype),
mask?: [GestureMask](#gesturemask枚举说明) | gesture: -，
mask: GestureMask.Normal | 绑定可与子组件手势同时触发的手势。
- gesture: 绑定的手势类型。 
- mask: 事件响应设置。
手势事件为非冒泡事件。父组件设置parallelGesture时，父子组件相同的手势事件都可以触发，实现类似冒泡效果。 | -- GestureMask枚举说明 - | 名称 | 描述 | +## GestureType +| 名称 | 描述 | | -------- | -------- | - | Normal | 不屏蔽子组件的手势，按照默认手势识别顺序进行识别。 | - | IgnoreInternal | 屏蔽子组件的手势，仅当前容器的手势进行识别。
子组件上系统内置的手势不会被屏蔽，如子组件为List组件时，内置的滑动手势仍然会触发。 | +| [TapGesture](ts-basic-gestures-tapgesture.md) | 点击手势，支持单次点击、多次点击识别。 | +| [LongPressGesture](ts-basic-gestures-longpressgesture.md) | 长按手势。 | +| [PanGesture](ts-basic-gestures-pangesture.md) | 平移手势，滑动最小距离为5vp时识别成功。 | +| [PinchGesture](ts-basic-gestures-pinchgesture.md) | 捏合手势。 | +| [RotationGesture](ts-basic-gestures-rotationgesture.md) | 旋转手势。 | +| [SwipeGesture](ts-basic-gestures-swipegesture.md) | 滑动手势，滑动最小速度为100vp/s时识别成功。 | +| [GestureGroup](ts-combined-gestures.md) | 手势识别组，多种手势组合为复合手势，支持连续识别、并行识别和互斥识别。 | -- GestureType +## GestureMask枚举说明 | 名称 | 描述 | | -------- | -------- | - | TapGesture | 点击手势，支持单次点击、多次点击识别。 | - | LongPressGesture | 长按手势。 | - | PanGesture | 平移手势，滑动最小距离为5vp时识别成功。 | - | PinchGesture | 捏合手势。 | - | RotationGesture | 旋转手势。 | - | SwipeGesture | 滑动手势，滑动最小速度为100vp/s时识别成功。 | - | GestureGroup | 手势识别组，多种手势组合为复合手势，支持连续识别、并行识别和互斥识别。 | + | Normal | 不屏蔽子组件的手势，按照默认手势识别顺序进行识别。 | + | IgnoreInternal | 屏蔽子组件的手势，仅当前容器的手势进行识别。
子组件上系统内置的手势不会被屏蔽，如子组件为List组件时，内置的滑动手势仍然会触发。 | ## 响应手势事件 -组件通过gesture方法绑定手势对象，可以通过手势对象提供的事件相应响应手势操作。例如通过TapGesture对象的onAction事件响应点击事件。其余手势的事件定义见各个手势对象章节。 +组件通过手势事件绑定不同GestureType的手势对象，各手势对象提供的事件响应手势操作，提供手势相关信息。下面通过TapGesture对象的onAction事件响应点击事件，获取事件相关信息。其余手势对象的事件定义见各个手势对象章节。 - TapGesture事件说明 | 名称 | 功能描述 | | -------- | -------- | | onAction((event?:GestureEvent) => void) | Tap手势识别成功回调。 | -- GestureEvent对象说明 +## GestureEvent对象说明 | 名称 | 类型 | 描述 | | -------- | -------- | -------- | | timestamp8+ | number | 事件时间戳。 | - | target8+ | [EventTarget](ts-universal-events-click.md) | 触发手势事件的元素对象显示区域。 | - | source8+ | SourceType | 事件输入设备。 | + | target8+ | [EventTarget](ts-universal-events-click.md#eventtarget8对象说明) | 触发手势事件的元素对象显示区域。 | + | source8+ | [SourceType](#sourcetype) | 事件输入设备。 | | repeat | boolean | 是否为重复触发事件，用于LongPressGesture手势触发场景。 | - | fingerList8+ | FingerInfo[] | 触发事件的所有手指信息，用于LongPressGesture与TapGesture手势触发场景。 | - | offsetX | number | 手势事件x轴偏移量，单位为vp，用于PanGesture手势触发场景。 | - | offsetY | number | 手势事件y轴偏移量，单位为vp，用于PanGesture手势触发场景。 | + | fingerList8+ | [FingerInfo](#fingerinfo对象说明)[] | 触发事件的所有手指信息，用于LongPressGesture与TapGesture手势触发场景。 | + | offsetX | number | 手势事件x轴相对偏移量，单位为vp，用于PanGesture手势触发场景，从左向右滑动offsetX为正，反之为负。 | + | offsetY | number | 手势事件y轴相对偏移量，单位为vp，用于PanGesture手势触发场景，从上向下滑动offsetY为正，反之为负。 | | angle | number | 用于RotationGesture手势触发场景时，表示旋转角度；用于SwipeGesture手势触发场景时，表示滑动手势的角度，即两根手指间的线段与水平方向的夹角变化的度数。
>  **说明：**
> 角度计算方式：滑动手势被识别到后，连接两根手指之间的线被识别为起始线条，随着手指的滑动，手指之间的线条会发生旋转，根据起始线条两端点和当前线条两端点的坐标，使用反正切函数分别计算其相对于水平方向的夹角，最后arctan2(cy2-cy1,cx2-cx1)-arctan2(y2-y1,x2-x1)为旋转的角度。以起始线条为坐标系，顺时针旋转为0到180度，逆时针旋转为-180到0度。 | | speed8+ | number | 滑动手势速度，即所有手指滑动的平均速度，单位为vp/秒，用于SwipeGesture手势触发场景。 | | scale | number | 缩放比例，用于PinchGesture手势触发场景。 | - | pinchCenterX | number | 捏合手势中心点x轴坐标，单位为vp，用于PinchGesture手势触发场景。 | - | pinchCenterY | number | 捏合手势中心点y轴坐标，单位为vp，用于PinchGesture手势触发场景。 | + | pinchCenterX | number | 捏合手势中心点相对于当前组件元素左上角x轴坐标，单位为vp，用于PinchGesture手势触发场景。 | + | pinchCenterY | number | 捏合手势中心点相对于当前组件元素左上角y轴坐标，单位为vp，用于PinchGesture手势触发场景。 | -- SourceType +## SourceType | 名称 | 描述 | | -------- | -------- | | Unknown | 未知设备。 | | Mouse | 鼠标。 | | TouchScreen | 触摸屏。 | -- FingerInfo对象说明 +## FingerInfo对象说明 | 名称 | 类型 | 描述 | | -------- | -------- | -------- | | id | number | 手指的索引编号。 |