DataTransferItem.getAsString()

The DataTransferItem.getAsString() method invokes the given callback with the drag data item's string data as the argument if the item's kind is a Plain unicode string (i.e. kind is string).

Syntax

dataTransferItem.getAsString(callback);

Parameters

callback
A callback function that has access to the data transfer item's string data. See Callback below for details.

Return value

undefined

Callback

The callback parameter is a callback function which accepts one parameter:

DOMString
The drag data item's string data.

The callback return value is undefined.

Example

This example shows the use of the getAsString() method as an inline function in a drop event handler.

function drop_handler(ev) {
 console.log("Drop");
 ev.preventDefault();
 var data = ev.dataTransfer.items;
 for (var i = 0; i < data.length; i += 1) {
   if ((data[i].kind == 'string') &&
       (data[i].type.match('^text/plain'))) {
     // This item is the target node
     data[i].getAsString(function (s){
       ev.target.appendChild(document.getElementById(s));
     });
   } else if ((data[i].kind == 'string') &&
              (data[i].type.match('^text/html'))) {
     // Drag data item is HTML
     console.log("... Drop: HTML");
   } else if ((data[i].kind == 'string') &&
              (data[i].type.match('^text/uri-list'))) {
     // Drag data item is URI
     console.log("... Drop: URI");
   } else if ((data[i].kind == 'file') &&
              (data[i].type.match('^image/'))) {
     // Drag data item is an image file
     var f = data[i].getAsFile();
     console.log("... Drop: File ");
   }
 }
}

Specifications

Specification Status Comment
HTML Living Standard
The definition of 'getAsString()' in that specification.
Living Standard Initial definition.
HTML 5.1
The definition of 'getAsString()' in that specification.
Recommendation Snapshot fo HTML WHATWG document

Browser compatibility

DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
getAsStringChrome Full support 11Edge Full support 12Firefox Full support 50IE No support NoOpera Full support 12Safari Full support 5.1WebView Android Full support 4Chrome Android Full support 18Firefox Android Full support 50Opera Android No support NoSafari iOS Full support 5Samsung Internet Android Full support 1.0

Legend

Full support
Full support
No support
No support

See also