diff --git a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md index ae6cbbb52c75105f43dc6bc864026e0803b4d556..ac23958c7db2a7f4271484d5aa6b6ab8ddf042ef 100644 --- a/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md +++ b/zh-cn/application-dev/reference/arkui-ts/ts-universal-events-drag-drop.md @@ -6,6 +6,13 @@ > > 从API Version 8开始支持。后续版本如有新增内容,则采用上角标单独标记该内容的起始版本。 +## 属性 + +拖拽事件相关组件除支持[通用属性](ts-universal-attributes-size.md)外,支持绑定以下属性: +| 名称 | 参数类型 | 描述 | +| -------- | -------- | -------- | +| allowDrop10+ | Array\ | 设置该组件上允许落入的数据类型。
默认值:空
| +| draggable10+ | boolean | 设置该组件是否允许进行拖拽。
默认值:false
| ## 事件 | 名称 | 支持冒泡 | 功能描述 | @@ -15,6 +22,7 @@ | onDragMove(event: (event?: [DragEvent](#dragevent说明), extraParams?: string) => void) | 否 | 拖拽在组件范围内移动时,触发回调。
- event:拖拽事件信息,包括拖拽点坐标。
- extraParams:拖拽事件额外信息,详见[extraParams](#extraparams说明)说明。
当监听了onDrop事件时,此事件才有效。 | | onDragLeave(event: (event?: [DragEvent](#dragevent说明), extraParams?: string) => void) | 否 | 拖拽离开组件范围内时,触发回调。
- event:拖拽事件信息,包括拖拽点坐标。
- extraParams:拖拽事件额外信息,详见[extraParams](#extraparams说明)说明。
当监听了onDrop事件时,此事件才有效。 | | onDrop(event: (event?: [DragEvent](#dragevent说明), extraParams?: string) => void) | 否 | 绑定此事件的组件可作为拖拽释放目标,当在本组件范围内停止拖拽行为时,触发回调。
- event:拖拽事件信息,包括拖拽点坐标。
- extraParams:拖拽事件额外信息,详见[extraParams](#extraparams说明)说明。 | +| onDragEnd(event: (event?: [DragEvent](#dragevent说明), extraParams?: string) => void)10+ | 否 | 绑定此事件的组件触发的拖拽结束后,触发回调。
- event:拖拽事件信息,包括拖拽点坐标。
- extraParams:拖拽事件额外信息,详见[extraParams](#extraparams说明)说明。 | ## DragItemInfo说明 @@ -42,6 +50,31 @@ | ------ | ------ | ---------------- | | getX() | number | 当前拖拽点相对于屏幕左上角的x轴坐标,单位为vp。 | | getY() | number | 当前拖拽点相对于屏幕左上角的y轴坐标,单位为vp。 | +| useCustomDropAnimation10+ | boolean | 当拖拽结束时,是否使用系统默认落入动画。 | +| dragBehavior10+ | [DragBehavior](#dragbehavior10枚举说明) | DrgaEvent对应的组件树行为。 | +| setData(unifiedData: UnifiedData)10+ | void | 向DragEvent中设置拖拽相关数据。 | +| getData()10+ | UnifiedData | 从DragEvent中获取拖拽相关数据。 | +| getSummary()10+ | Summary | 从DragEvent中获取拖拽相关数据的简介。 | +| setResult(dragRect: [DragRet](#dragret10枚举说明))10+ | void | 向DragEvent中设置拖拽结果。 | +| getResult()10+ | [DragRet](#dragret10枚举说明) | 从DragEvent中获取拖拽结果。 | +| getPrviewRect()10+ | [Rectangle](ts-universal-attributes-touch-target.md#rectangle对象说明) | 获取预览图所在的Rectangle。 | + +## DragBehavior10+枚举说明 + +| 名称 | 描述 | +| ------ | ------ | +| COPY | 在组件树上,对发起拖拽的组件进行拷贝,将拷贝结果复制到拖拽结束的位置。 | +| MOVE | 在组件树上,对发起拖拽的组件进行裁剪,移动至拖拽结束的位置。 | + +## DragRet10+枚举说明 + +| 名称 | 描述 | +| ----- | ----------------- | +| DRAG_SUCCESS | 拖拽成功 | +| DRAG_FAIL | 拖拽失败 | +| DRAG_CANCEL | 拖拽取消 | +| ENABLE_DROP | 组件允许落入 | +| DISABLE_DROP | 组件不允许落入 | ## 示例