DataTransfer

open external class DataTransfer(source)

Used to hold the data that is being dragged during a drag and drop operation. It may hold one or more data items, each of one or more data types. For more information about drag and drop, see HTML Drag and Drop API.

MDN Reference

Constructors

DataTransfer

constructor()

Properties

dropEffect

var dropEffect: DropEffect

Returns the kind of operation that is currently selected. If the kind of operation isn't one of those that is allowed by the effectAllowed attribute, then the operation will fail.

effectAllowed

var effectAllowed: AllowedEffect

Returns the kinds of operations that are to be allowed.

files

val files: FileList

Returns a FileList of the files being dragged, if any.

items

val items: DataTransferItemList

Returns a DataTransferItemList object, with the drag data.

types

val types: ReadonlyArray<String>

Returns a frozen array listing the formats that were set in the dragstart event. In addition, if any files are being dragged, then one of the types will be the string "Files".

Functions

clearData

fun clearData(format: String = definedExternally)

Removes the data of the specified formats. Removes all data if the argument is omitted.

getData

fun getData(format: String): String

Returns the specified data. If there is no such data, returns the empty string.

setData

fun setData(format: String, data: String)

Adds the specified data.

setDragImage

fun setDragImage(image: Element, x: Int, y: Int)

Uses the given element to update the drag feedback, replacing any previously specified feedback.