DataTransfer

The DataTransfer object is used to hold any data transferred between contexts, such as a drag and drop operation, or clipboard read/write.

MDN Reference

Constructors

DataTransfer

constructor()

Properties

dropEffect

var dropEffect: DropEffect

The DataTransfer.dropEffect property controls the feedback (typically visual) the user is given during a drag and drop operation.

effectAllowed

var effectAllowed: AllowedEffect

The DataTransfer.effectAllowed property specifies the effect that is allowed for a drag operation.

files

val files: FileList

The files read-only property of DataTransfer objects is a list of the files in the drag operation.

items

val items: DataTransferItemList

The read-only items property of the DataTransfer interface is a DataTransferItemList of the DataTransferItem in a drag operation.

types

val types: ReadonlyArray<JsString>

The DataTransfer.types read-only property returns the available types that exist in the DataTransfer.items.

Functions

clearData

fun clearData(format: String = definedExternally)

The DataTransfer.clearData() method removes the drag operation's drag data for the given type.

getData

fun getData(format: String): String

The DataTransfer.getData() method retrieves drag data (as a string) for the specified type.

setData

fun setData(format: String, data: String)

The DataTransfer.setData() method sets the drag operation's drag data to the specified data and type.

setDragImage

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

When a drag occurs, a translucent image is generated from the drag target (the element the HTMLElement/dragstart_event event is fired at), and follows the mouse pointer during the drag.