DataTransfer オブジェクトは、ドラッグ＆ドロップ操作中にドラッグされているデータを保持するために使用されます。これは、1 つ以上のデータ項目を保持することができ、それぞれが 1 つ以上のデータ型を持ちます。ドラッグ＆ドロップの詳細については、HTML ドラッグ＆ドロップ API を参照してください。
このオブジェクトはすべての ドラッグイベント の 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イベントでセットされたフォーマットを示すstringsの配列。
Gecko プロパティ
注: この節の全プロパティは Gecko-固有のものです。
DataTransfer.mozCursor- ドラッグカーソルの状態を返します。主にタブドラッグの際のカーソルを制御するのに使います。
DataTransfer.mozSourceNode読取専用- ドラッグ操作を開始するためにボタンを押下したときにマウスカーソルのあった
Nodeを返します。外部アプリケーションからのドラッグの場合や、ドラッグを開始したノードが呼び出し元からアクセスできない物であった場合は、値はnullとなります。 DataTransfer.mozUserCancelled読取専用- このプロパティは
dragendイベントに対してのみ適用され、ユーザーが Esc キーを押下してドラッグ操作を取り消した場合は値がtrueとなります。不正な場所でドロップした場合など、その他の理由でドラッグ操作に失敗した場合には、値はfalseとなります。
Deprecated プロパティ
DataTransfer.mozItemCount読取専用- ドラッグされている項目の個数を返します。Firefox 71 で削除されます。
メソッド
標準メソッド
DataTransfer.clearData()- 指定された型のデータを削除します。型の指定は省略可能です。型として空の文字列を指定した場合、もしくは型を指定しなかった場合、すべての型のデータが削除されます。指定された型のデータが存在しない場合、またはデータトランスファーが何もデータを持っていない場合、このメソッドは何もしません。
DataTransfer.getData()- 指定された型のデータを取得します。指定された型のデータが存在しない場合、またはデータトランスファーが何もデータを保持していない場合、空文字を返します。
DataTransfer.setData()- 指定された型のデータを設定します。その型のデータが存在しない場合、データはリストの最後に追加されるため、データ型のリストの最後の項目は、最後に追加された新しいデータ型となります。その型のデータがすでに存在している場合、データ型のリストにおける元と同じ位置で、古いデータが新しいデータと置き換わります。
DataTransfer.setDragImage()- ドラッグ中に表示されるフィードバックイメージについて、独自のものを使用したい場合に、それをセットします。
Gecko メソッド
非標準
この機能は標準ではなく、標準化の予定もありません。公開されているウェブサイトには使用しないでください。ユーザーによっては使用できないことがあります。実装ごとに大きな差があることもあり、将来は振る舞いが変わるかもしれません。
注: この節の全メソッドは Gecko-固有のものです。
DataTransfer.addElement()- ドラッグ元の要素を指定します。
Deprecated メソッド
DataTransfer.mozClearDataAt()- 指定されたインデックスの項目について、指定された形式に関連付けられたデータを削除します。インデックスは 0〜(項目の数-1）の範囲です。Firefox 71 で削除されます。
DataTransfer.mozGetDataAt()- 指定されたインデックスの項目の、指定された形式のデータを取得します。存在しない項目またはデータ形式を指定した場合は null を返します。インデックスは 0〜(項目の数-1）の範囲です。Firefox 71 で削除されます。
DataTransfer.mozSetDataAt()- データトランスファーは複数の項目を保持する事ができ、それぞれの項目には 0 から始まるインデックスが付けられます。
mozSetDataAt()は、すでに存在する項目を変更する場合にはmozItemCountより小さい値をインデックスとして指定し、新しい項目を追加する場合はmozItemCountに等しい値をインデックスとして指定します。また、mozItemCountは項目を追加する度に増加します。Firefox 71 で削除されます。 DataTransfer.mozTypesAt()- 指定されたインデックスの項目が保持しているデータの形式のリスト（文字列の配列）を返します。0〜(項目の数-1）の範囲外のインデックスを指定した場合は、空のリストを返します。Firefox 71 で削除されます。
例
この文書に載っているすべてのメソッドとプロパティは自分自身のリファレンスページを持ち、そのページに直接例が載っているか、例へのリンクがあるかのいずれかです。
仕様
| 仕様書 | 策定状況 | コメント |
|---|---|---|
| HTML Living Standard DataTransfer の定義 |
現行の標準 | mozCursor, mozItemCount, mozSourceNode, mozUserCancelled, addElement(), mozClearDataAt(), mozGetDataAt(), mozSetDataAt() and mozTypesAt are Gecko specific. |
| HTML 5.1 DataTransfer の定義 |
勧告 | Not included in W3C HTML5 勧告 |
ブラウザー実装状況
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
| デスクトップ | モバイル | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
DataTransfer | Chrome 完全対応 3 | Edge 完全対応 12 | Firefox
完全対応
3.5
| IE 完全対応 10 | Opera 完全対応 12 | Safari 完全対応 3.1 | WebView Android 完全対応 ≤37 | Chrome Android 完全対応 18 | Firefox Android
完全対応
4
| Opera Android 完全対応 12 | Safari iOS 完全対応 2 | Samsung Internet Android 完全対応 1.0 |
DataTransfer() constructor | Chrome 完全対応 60 | Edge 完全対応 ≤79 | Firefox ? | IE 未対応 なし | Opera 完全対応 47 | Safari 未対応 なし | WebView Android 完全対応 60 | Chrome Android 完全対応 60 | Firefox Android ? | Opera Android 完全対応 44 | Safari iOS 未対応 なし | Samsung Internet Android 完全対応 8.0 |
addElement | Chrome 未対応 なし | Edge 未対応 なし | Firefox 完全対応 あり | IE 未対応 なし | Opera 未対応 なし | Safari 未対応 なし | WebView Android 未対応 なし | Chrome Android 未対応 なし | Firefox Android ? | Opera Android 未対応 なし | Safari iOS 未対応 なし | Samsung Internet Android 未対応 なし |
clearData | Chrome 完全対応 あり | Edge 完全対応 12 | Firefox 完全対応 あり | IE ? | Opera 完全対応 あり | Safari 完全対応 あり | WebView Android 完全対応 あり | Chrome Android 完全対応 あり | Firefox Android 完全対応 あり | Opera Android 完全対応 あり | Safari iOS 未対応 なし | Samsung Internet Android 完全対応 あり |
dropEffect | Chrome 完全対応 あり | Edge 完全対応 12 | Firefox 完全対応 あり | IE ? | Opera 完全対応 あり | Safari 完全対応 あり | WebView Android 完全対応 あり | Chrome Android 完全対応 あり | Firefox Android 完全対応 あり | Opera Android 完全対応 あり | Safari iOS 未対応 なし | Samsung Internet Android 完全対応 あり |
effectAllowed | Chrome 完全対応 あり | Edge 完全対応 12 | Firefox 完全対応 あり | IE ? | Opera 完全対応 あり | Safari 完全対応 あり | WebView Android 完全対応 あり | Chrome Android 完全対応 あり | Firefox Android 完全対応 あり | Opera Android 完全対応 あり | Safari iOS 未対応 なし | Samsung Internet Android 完全対応 あり |
files | Chrome 完全対応 あり | Edge 完全対応 12 | Firefox 完全対応 あり | IE ? | Opera 完全対応 あり | Safari 完全対応 あり | WebView Android 完全対応 あり | Chrome Android 完全対応 あり | Firefox Android 完全対応 あり | Opera Android 完全対応 あり | Safari iOS 未対応 なし | Samsung Internet Android 完全対応 あり |
getData | Chrome 完全対応 あり | Edge 完全対応 12 | Firefox 完全対応 あり | IE ? | Opera 完全対応 あり | Safari 完全対応 あり | WebView Android 完全対応 あり | Chrome Android 完全対応 あり | Firefox Android 完全対応 あり | Opera Android 完全対応 あり | Safari iOS 未対応 なし | Samsung Internet Android 完全対応 あり |
items | Chrome 完全対応 4 | Edge 完全対応 12 | Firefox 完全対応 50 | IE 未対応 なし | Opera 完全対応 12 | Safari 未対応 なし | WebView Android 完全対応 あり | Chrome Android 完全対応 あり | Firefox Android 完全対応 52 | Opera Android 完全対応 あり | Safari iOS 未対応 なし | Samsung Internet Android 完全対応 あり |
mozClearDataAt | Chrome 未対応 なし | Edge 未対応 なし | Firefox 未対応 ? — 71 | IE 未対応 なし | Opera 未対応 なし | Safari 未対応 なし | WebView Android 未対応 なし | Chrome Android 未対応 なし | Firefox Android ? | Opera Android 未対応 なし | Safari iOS 未対応 なし | Samsung Internet Android 未対応 なし |
mozCursor | Chrome 未対応 なし | Edge 未対応 なし | Firefox 完全対応 あり | IE 未対応 なし | Opera 未対応 なし | Safari 未対応 なし | WebView Android 未対応 なし | Chrome Android 未対応 なし | Firefox Android ? | Opera Android 未対応 なし | Safari iOS 未対応 なし | Samsung Internet Android 未対応 なし |
mozGetDataAt | Chrome 未対応 なし | Edge 未対応 なし | Firefox 未対応 ? — 71 | IE 未対応 なし | Opera 未対応 なし | Safari 未対応 なし | WebView Android 未対応 なし | Chrome Android 未対応 なし | Firefox Android ? | Opera Android 未対応 なし | Safari iOS 未対応 なし | Samsung Internet Android 未対応 なし |
mozItemCount | Chrome 未対応 なし | Edge 未対応 なし | Firefox 未対応 ? — 71 | IE 未対応 なし | Opera 未対応 なし | Safari 未対応 なし | WebView Android 未対応 なし | Chrome Android 未対応 なし | Firefox Android ? | Opera Android 未対応 なし | Safari iOS 未対応 なし | Samsung Internet Android 未対応 なし |
mozSetDataAt | Chrome 未対応 なし | Edge 未対応 なし | Firefox 未対応 ? — 71 | IE 未対応 なし | Opera 未対応 なし | Safari 未対応 なし | WebView Android 未対応 なし | Chrome Android 未対応 なし | Firefox Android ? | Opera Android 未対応 なし | Safari iOS 未対応 なし | Samsung Internet Android 未対応 なし |
mozSourceNode | Chrome 未対応 なし | Edge 未対応 なし | Firefox 完全対応 あり | IE 未対応 なし | Opera 未対応 なし | Safari 未対応 なし | WebView Android 未対応 なし | Chrome Android 未対応 なし | Firefox Android ? | Opera Android 未対応 なし | Safari iOS 未対応 なし | Samsung Internet Android 未対応 なし |
mozTypesAt | Chrome 未対応 なし | Edge 未対応 なし | Firefox 未対応 ? — 71 | IE 未対応 なし | Opera 未対応 なし | Safari 未対応 なし | WebView Android 未対応 なし | Chrome Android 未対応 なし | Firefox Android ? | Opera Android 未対応 なし | Safari iOS 未対応 なし | Samsung Internet Android 未対応 なし |
mozUserCancelled | Chrome 未対応 なし | Edge 未対応 なし | Firefox 完全対応 あり | IE 未対応 なし | Opera 未対応 なし | Safari 未対応 なし | WebView Android 未対応 なし | Chrome Android 未対応 なし | Firefox Android ? | Opera Android 未対応 なし | Safari iOS 未対応 なし | Samsung Internet Android 未対応 なし |
setData | Chrome 完全対応 3 | Edge 完全対応 12 | Firefox 完全対応 10 | IE 未対応 なし | Opera 完全対応 12 | Safari 完全対応 5 | WebView Android 完全対応 ≤37 | Chrome Android 完全対応 18 | Firefox Android 完全対応 10 | Opera Android 完全対応 12 | Safari iOS 完全対応 5 | Samsung Internet Android 完全対応 1.0 |
setDragImage | Chrome 完全対応 あり | Edge 完全対応 18 | Firefox 完全対応 あり | IE ? | Opera 完全対応 あり | Safari 完全対応 あり | WebView Android 完全対応 あり | Chrome Android 完全対応 あり | Firefox Android 完全対応 あり | Opera Android 完全対応 あり | Safari iOS 未対応 なし | Samsung Internet Android 完全対応 あり |
types | Chrome 完全対応 あり | Edge 完全対応 12 | Firefox 完全対応 あり | IE
完全対応
10
| Opera
完全対応
あり
| Safari 完全対応 あり | WebView Android 完全対応 あり | Chrome Android 完全対応 あり | Firefox Android 完全対応 あり | Opera Android 完全対応 あり | Safari iOS 未対応 なし | Samsung Internet Android 完全対応 あり |
凡例
- 完全対応
- 完全対応
- 未対応
- 未対応
- 実装状況不明
- 実装状況不明
- 実験的。動作が変更される可能性があります。
- 実験的。動作が変更される可能性があります。
- 非標準。ブラウザー間の互換性が低い可能性があります。
- 非標準。ブラウザー間の互換性が低い可能性があります。
- 実装ノートを参照してください。
- 実装ノートを参照してください。