大网数据广告活动
Web 标准与前端开发

DataTransfer

· 52CE 我爱测

`DataTransfer`** 对象用于保存上下文间的数据传输,如在拖放操作、剪切板读写中的那些数据。它可以保存一项或多项,每项都可以是同一种或多种数据类型的数据。

HTML Drag and Drop API

DataTransfer 对象用于保存上下文间的数据传输,如在拖放操作、剪切板读写中的那些数据。它可以保存一项或多项,每项都可以是同一种或多种数据类型的数据。

DataTransfer 主要旨在服务 HTML 拖放 API(用于 DragEvent.dataTransfer 属性)。其在 HTML 拖放一节中得到定义,但也用于其他 API,如 ClipboardEvent.clipboardData 和 InputEvent.dataTransfer。但是,其他 API 只使用该接口的其中一部分,忽略了部分属性(如 dropEffect)。DataTransfer 文档将主要讨论拖放操作中该对象的使用方式。你应该参考相应 API 的文档以了解在其他上下文环境中 DataTransfer 的使用方式。

构造函数

  • 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
    • : 提供 dragstart 事件中设置的格式的字符串数组。

实例方法

  • DataTransfer.addElement()
    • : 设置给定元素的拖拽源。这将成为 HTMLElement/drag_event 和 HTMLElement/dragend_event 事件能被触发的元素而非默认对象(被拖拽的节点)。该方法为 Firefox 特有方法。
  • DataTransfer.clearData()
    • : 删除与给定类型关联的数据。类型参数是可选的。如果类型为空或未指定,则删除与所有类型关联的数据。如果指定类型的数据不存在,或者 DataTransfer 中不包含任何数据,则该方法不会产生任何效果。
  • DataTransfer.getData()
    • : 获取给定类型的数据,如果该类型的数据不存在或 DataTransfer 不包含数据,则返回空字符串。
  • DataTransfer.setData()
    • : 设置给定类型的数据。如果该类型的数据不存在,则将其添加到末尾,以便类型列表中的最后一项将是新的格式。如果该类型的数据已经存在,则在相同位置替换现有数据。
  • DataTransfer.setDragImage()
    • : 用于设置自定义的拖拽图像。

示例

本文档中的每个方法和属性都有自己的参考页面,每个参考页面中都直接包含了接口的示例或给出了示例的链接。

读取粘贴或放下事件的数据

在下述示例中,我们定义了包含三种不同类型的文本输入框的 form,分别是文本 input 元素、textarea 元素和 contenteditable 属性设为 true 的 div 元素。用户可以向其中任意元素粘贴或放下文本,我们将随后在表单中显示 ClipboardEvent.clipboardData 或 DragEvent.dataTransfer 对象中的数据。

HTML

<form>
  <fieldset>
    <legend>&lt;input /></legend>
    <input type="text" />
    <table class="center">
      <tbody>
        <tr>
          <th scope="row">操作类型</th>
          <td></td>
        </tr>
        <tr>
          <th scope="row">内容类型</th>
          <td></td>
        </tr>
      </tbody>
    </table>
  </fieldset>
  <fieldset>
    <legend>&lt;textarea /></legend>
    <textarea></textarea>
    <table class="center">
      <tbody>
        <tr>
          <th scope="row">操作类型</th>
          <td></td>
        </tr>
        <tr>
          <th scope="row">内容类型</th>
          <td></td>
        </tr>
      </tbody>
    </table>
  </fieldset>
  <fieldset>
    <legend>&lt;div contenteditable /></legend>
    <div contenteditable></div>
    <table class="center">
      <tbody>
        <tr>
          <th scope="row">操作类型</th>
          <td></td>
        </tr>
        <tr>
          <th scope="row">内容类型</th>
          <td></td>
        </tr>
      </tbody>
    </table>
  </fieldset>
  <p class="center">
    <input type="reset" />
  </p>
</form>

CSS

.center {
  text-align: center;
}

form > fieldset > * {
  vertical-align: top;
}
form input,
form textarea,
form [contenteditable] {
  min-width: 15rem;
  padding: 0.25rem;
}
[contenteditable] {
  appearance: textfield;
  display: inline-block;
  min-height: 1rem;
  border: 1px solid;
}

form table {
  display: inline-table;
}
table ol {
  text-align: left;
}

JavaScript

const form = document.querySelector("form");

function displayData(event) {
  if (event.type === "drop") event.preventDefault();

  const cells = event.target.nextElementSibling.querySelectorAll("td");
  cells[0].textContent = event.type;
  const transfer = event.clipboardData || event.dataTransfer;
  const ol = document.createElement("ol");
  cells[1].textContent = "";
  cells[1].appendChild(ol);
  for (const item of transfer.items) {
    const li = document.createElement("li");
    li.textContent = `${item.kind} ${item.type}`;
    ol.appendChild(li);
  }
}

form.addEventListener("paste", displayData);
form.addEventListener("drop", displayData);
form.addEventListener("reset", () => {
  for (const cell of form.querySelectorAll("[contenteditable], td")) {
    cell.textContent = "";
  }
});

结果

读取粘贴或放下事件的数据

规范

浏览器兼容性

参见

来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。

资料来源与适用范围

资料来源
MDN Web Docs / Mozilla 贡献者
适用范围
请按文中版本与环境说明核对
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-15
授权说明
CC BY-SA 2.5

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。