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

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support4 Yes50 No12 No
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support Yes Yes ?50 No No ?

See also

Document Tags and Contributors

Contributors to this page: fscholz, dikirill, erikadoyle, teoli, Sheppy, rolfedh, AFBarstow
Last updated by: fscholz,