ViewDataTransfer

class

A facade over the native DataTransfer object.

See source

Properties

dropEffect : 'link' | 'none' | 'copy' | 'move'

See source (with github icon)

Parameters

value : 'link' | 'none' | 'copy' | 'move'
effectAllowed : 'link' | 'none' | 'copy' | 'move' | 'copyLink' | 'copyMove' | 'linkMove' | 'all' | 'uninitialized'

See source (with github icon)

Parameters

value : 'link' | 'none' | 'copy' | 'move' | 'copyLink' | 'copyMove' | 'linkMove' | 'all' | 'uninitialized'
files : Array<File>
readonly

The array of files created from the native DataTransfer#files or DataTransfer#items.

See source (with github icon)
isCanceled : boolean
readonly

Whether the dragging operation was canceled.

See source (with github icon)
types : readonly Array<string>
readonly

Returns an array of available native content types.

See source (with github icon)
_files : null | Array<File>
private

The array of files created from the native DataTransfer#files or DataTransfer#items.

See source (with github icon)
_native : DataTransfer
private

The native DataTransfer object.

See source (with github icon)

Methods

constructor( nativeDataTransfer, options = { [options.cacheFiles] } )

See source (with github icon)

Parameters

nativeDataTransfer : DataTransfer

The native DataTransfer object.

options : object

Properties

[ options.cacheFiles ] : boolean

Whether files list should be initialized in the constructor.

Defaults to {}
getData( type ) → string

module:engine/view/datatransfer~ViewDataTransfer#getData
Gets the data from the data transfer by its MIME type.
```
dataTransfer.getData( 'text/plain' );
```
Copy code
See source (with github icon)

Parameters

type : string

The MIME type. E.g. text/html or text/plain.

Returns

string
setData( type, data ) → void

Sets the data in the data transfer.

See source (with github icon)

Parameters

type : string

The MIME type. E.g. text/html or text/plain.

data : string

Returns

void
setDragImage( image, x, y ) → void

Set a preview image of the dragged content.

See source (with github icon)

Parameters

image : Element

x : number

y : number

Returns

void

ViewDataTransfer

Properties

`dropEffect : 'link' | 'none' | 'copy' | 'move'`

Parameters

`effectAllowed : 'link' | 'none' | 'copy' | 'move' | 'copyLink' | 'copyMove' | 'linkMove' | 'all' | 'uninitialized'`

Parameters

`files : Array<File>`
readonly

`isCanceled : boolean`
readonly

`types : readonly Array<string>`
readonly

`_files : null | Array<File>`
private

`_native : DataTransfer`
private

Methods

`constructor( nativeDataTransfer, options = { [options.cacheFiles] } )`

Parameters

`getData( type ) → string`

Parameters

Returns

`setData( type, data ) → void`

Parameters

Returns

`setDragImage( image, x, y ) → void`

Parameters

Returns

ViewDataTransfer

Properties

dropEffect : 'link' | 'none' | 'copy' | 'move'

Parameters

effectAllowed : 'link' | 'none' | 'copy' | 'move' | 'copyLink' | 'copyMove' | 'linkMove' | 'all' | 'uninitialized'

Parameters

files : Array<File> readonly

isCanceled : boolean readonly

types : readonly Array<string> readonly

_files : null | Array<File> Lock icon private

_native : DataTransfer Lock icon private

Methods

constructor( nativeDataTransfer, options = { [options.cacheFiles] } )

Parameters

getData( type ) → string

Parameters

Returns

setData( type, data ) → void

Parameters

Returns

setDragImage( image, x, y ) → void

Parameters

Returns

`dropEffect : 'link' | 'none' | 'copy' | 'move'`

`effectAllowed : 'link' | 'none' | 'copy' | 'move' | 'copyLink' | 'copyMove' | 'linkMove' | 'all' | 'uninitialized'`

`files : Array<File>`
readonly

`isCanceled : boolean`
readonly

`types : readonly Array<string>`
readonly

`_files : null | Array<File>`
private

`_native : DataTransfer`
private

`constructor( nativeDataTransfer, options = { [options.cacheFiles] } )`

`getData( type ) → string`

`setData( type, data ) → void`

`setDragImage( image, x, y ) → void`