DataTransfer - 用于保存拖放操作期间拖动的数据

DataTransfer 对象用于保存拖放操作期间拖动的数据。它可以包含一个或多个数据项，每个数据项包含一种或多种数据类型。有关拖放的详细信息，请参阅HTML 拖放 API。

该对象可从 drag events 的 dataTransfer 属性获得。

构造函数

DataTransfer()

创建并返回一个新的 DataTransfer 对象。

属性

标准属性

DataTransfer.dropEffect

获取当前选定的拖放操作的类型，或将操作设置为新类型。值必须是 none，copy，link 或 move。

DataTransfer.effectAllowed

提供可能的所有类型的操作。必须是 none ，copy，copyLink，copyMove，link，linkMove，move，all 或 uninitialized 之一。

DataTransfer.files

包含数据传输中可用的所有本地文件的列表。如果拖动操作不涉及拖动文件，则该属性为空列表。

DataTransfer.items 只读

给出 DataTransferItemList 对象，该对象是所有拖动数据的列表。

DataTransfer.types 只读

一个 strings 数组，给出 dragstart 事件中设置的格式。

Gecko 属性

注意： 本节中的所有属性都是 Gecko 特有的。

DataTransfer.mozCursor

给出拖动光标的状态。这主要用于在标签拖动期间控制光标。

DataTransfer.mozItemCount 只读

提供拖动操作中的项目数。

DataTransfer.mozSourceNode 只读

按下按钮以启动拖动操作时鼠标光标所在的 Node。对于外部拖动，或者如果调用者无法访问节点，该值为 null。

DataTransfer.mozUserCancelled 只读

该属性仅适用于 dragend 事件，如果用户通过按 escape 取消拖动操作，则该属性为 true。在所有其他情况下，它将是 false，包括由于任何其他原因导致拖动失败，例如由于无效位置的丢失。

方法

标准方法

DataTransfer.clearData()

删除与给定类型关联的数据。type 参数是可选的。如果类型为空或未指定，则删除与所有类型关联的数据。如果指定类型的数据不存在，或者数据传输不包含任何数据，则该方法无效。

DataTransfer.getData()

检索给定类型的数据，如果该类型的数据不存在或数据传输不包含数据，则返回空字符串。

DataTransfer.setData()

设置给定类型的数据。如果该类型的数据不存在，则在末尾添加。如果该类型的数据已存在，则替换掉相同位置的数据。

DataTransfer.setDragImage()

如果需要自定义图像，请设置用于拖动的图像。

Gecko 方法

注意： 本节中的所有方法都是 Gecko 特有的。

DataTransfer.addElement()

将拖动源设置为给定元素。

DataTransfer.mozClearDataAt()

删除与指定索引处的项目的给定格式关联的数据。索引的范围从零到项目数减一。

DataTransfer.mozGetDataAt()

检索与指定索引处的项目的给定格式关联的数据，如果不存在，则返回 null。索引应该在从零到项目数减一的范围内。

DataTransfer.mozSetDataAt()

数据传输可以存储多个项目，每个项目从零开始索引。

DataTransfer.mozTypesAt()

保存为指定索引处的项目存储的数据的格式类型列表。如果索引不在 0 到项目数减 1 的范围内，则返回空字符串列表。

规范

规范	状态	备注
HTML Living Standard DataTransfer 的定义	现行的标准	mozCursor，mozItemCount，mozSourceNode，mozUserCancelled，addElement()，mozClearDataAt()，mozGetDataAt()，mozSetDataAt() 和 mozTypesAt 是 Gecko 特有的。
HTML 5.1 DataTransfer 的定义	推荐	不包含在 W3C HTML5 中

桌面浏览器兼容性

移动浏览器兼容性

1. 从 Firefox 52 开始，DataTransfer.types 属性根据规范返回一个冻结的 DOMString 数组，而不是 DOMStringList。

相关链接

• 拖放
• 拖动草稿
• 推荐的拖动类型
• 拖放多个项目