DataTransfer
Baseline Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.
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
イベントで設定されたフォーマットを示します。
Gecko プロパティ
Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。
メモ: この節のすべてのプロパティは Gecko 固有のものです。
DataTransfer.mozCursor
-
ドラッグカーソルの状態を返します。主にタブドラッグの際のカーソルを制御するのに使います。
DataTransfer.mozSourceNode
読取専用-
ドラッグ操作を開始するためにボタンを押下したときにマウスカーソルのあった
Node
を返します。外部アプリケーションからのドラッグの場合や、ドラッグを開始したノードが呼び出し元からアクセスできない物であった場合は、値はnull
となります。 DataTransfer.mozUserCancelled
読取専用-
このプロパティは
dragend
イベントに対してのみ適用され、ユーザーが Esc キーを押下してドラッグ操作を取り消した場合は値がtrue
となります。不正な場所でドロップした場合など、その他の理由でドラッグ操作に失敗した場合には、値はfalse
となります。
非推奨のプロパティ
DataTransfer.mozItemCount
読取専用 非推奨-
ドラッグされている項目の個数を返します。Firefox 71 で削除されました。
メソッド
標準メソッド
DataTransfer.clearData()
-
指定された型のデータを削除します。型の指定は省略可能です。型として空の文字列を指定した場合、もしくは型を指定しなかった場合、すべての型のデータが削除されます。指定された型のデータが存在しない場合、またはデータトランスファーが何もデータを持っていない場合、このメソッドは何もしません。
DataTransfer.getData()
-
指定された型のデータを取得します。指定された型のデータが存在しない場合、またはデータトランスファーが何もデータを保持していない場合、空文字を返します。
DataTransfer.setData()
-
指定された型のデータを設定します。その型のデータが存在しない場合、データはリストの最後に追加されるため、データ型のリストの最後の項目は、最後に追加された新しいデータ型となります。その型のデータがすでに存在している場合、データ型のリストにおける元と同じ位置で、古いデータが新しいデータと置き換わります。
DataTransfer.setDragImage()
-
独自のものが求められる場合、ドラッグ中に使われる画像を設定します。
Gecko メソッド
非標準: この機能は標準ではなく、標準化の予定もありません。公開されているウェブサイトには使用しないでください。ユーザーによっては使用できないことがあります。実装ごとに大きな差があることもあり、将来は振る舞いが変わるかもしれません。
メモ: この節のすべてのメソッドは Gecko 固有のものです。
DataTransfer.addElement()
-
ドラッグ元の要素を指定します。
非推奨のメソッド
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 で削除されました。
例
この記事に記載されているすべてのメソッドとプロパティには、それぞれリファレンスページがあり、それぞれのリファレンスページには、インターフェイスの例が直接記載されているか、例へのリンクが張られています。
仕様書
Specification |
---|
HTML Standard # the-datatransfer-interface |
ブラウザーの互換性
BCD tables only load in the browser