DataTransfer extension type

The DataTransfer object is 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.

This object is available from the DragEvent.dataTransfer property of all DragEvent.

API documentation sourced from MDN Web Docs.

on
Implemented types
Available extensions

Constructors

DataTransfer()
factory

Properties

dropEffect ↔ String
The DataTransfer.dropEffect property controls the feedback (typically visual) the user is given during a drag and drop operation. It will affect which cursor is displayed while dragging. For example, when the user hovers over a target drop element, the browser's cursor may indicate which type of operation will occur.
getter/setter pair
effectAllowed ↔ String
The DataTransfer.effectAllowed property specifies the effect that is allowed for a drag operation. The copy operation is used to indicate that the data being dragged will be copied from its present location to the drop location. The move operation is used to indicate that the data being dragged will be moved, and the link operation is used to indicate that some form of relationship or connection will be created between the source and drop locations.
getter/setter pair
files → FileList
The files read-only property of DataTransfer objects is a FileList in the drag operation. If the operation includes no files, the list is empty.
no setter
hashCode → int
The hash code for this object.
no setterinherited
items → DataTransferItemList
The read-only items property of the DataTransfer interface is a DataTransferItemList of the DataTransferItem in a drag operation. The list includes one item for each item in the operation and if the operation had no items, the list is empty.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
types → JSArray<JSString>
The DataTransfer.types read-only property returns the available types that exist in the DataTransfer.items.
no setter

Methods

clearData([String format]) → void
The DataTransfer.clearData() method removes the drag operation's DataTransfer for the given type. If data for the given type does not exist, this method does nothing.
getData(String format) → String
The DataTransfer.getData() method retrieves drag data (as a string) for the specified type. If the drag operation does not include data, this method returns an empty string.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
setData(String format, String data) → void
The DataTransfer.setData() method sets the drag operation's DataTransfer to the specified data and type. If data for the given type does not exist, it is added at the end of the drag data store, such that the last item in the DataTransfer.types list will be the new type. If data for the given type already exists, the existing data is replaced in the same position. That is, the order of the DataTransfer.types list is not changed when replacing data of the same type.
setDragImage(Element image, int x, int y) → void
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. This image is created automatically, so you do not need to create it yourself. However, if a custom image is desired, the DataTransfer.setDragImage() method can be used to set the custom image to be used. The image will typically be an img element but it can also be a canvas or any other visible element.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited