ViewDataTransfer
class
A facade over the native DataTransfer object.
Properties
dropEffect: 'link' | 'none' | 'copy' | 'move'module:engine/view/datatransfer~ViewDataTransfer#dropEffecteffectAllowed: 'link' | 'none' | 'copy' | 'move' | 'copyLink' | 'copyMove' | 'linkMove' | 'all' | 'uninitialized'module:engine/view/datatransfer~ViewDataTransfer#effectAllowedParameters
value: 'link' | 'none' | 'copy' | 'move' | 'copyLink' | 'copyMove' | 'linkMove' | 'all' | 'uninitialized'
files: Array<File>readonlymodule:engine/view/datatransfer~ViewDataTransfer#filesThe array of files created from the native
DataTransfer#filesorDataTransfer#items.isCanceled: booleanreadonlymodule:engine/view/datatransfer~ViewDataTransfer#isCanceledWhether the dragging operation was canceled.
types: readonly Array<string>readonlymodule:engine/view/datatransfer~ViewDataTransfer#typesReturns an array of available native content types.
_files: Array<File> | nullprivatemodule:engine/view/datatransfer~ViewDataTransfer#_filesThe array of files created from the native
DataTransfer#filesorDataTransfer#items._native: DataTransferprivatemodule:engine/view/datatransfer~ViewDataTransfer#_nativeThe native DataTransfer object.
Methods
constructor( nativeDataTransfer, options = { options.cacheFiles? } )module:engine/view/datatransfer~ViewDataTransfer#constructorParameters
nativeDataTransfer: DataTransferThe native
DataTransferobject.options: object- Properties
options.cacheFiles?: booleanWhether
fileslist should be initialized in the constructor.
Defaults to
{}
getData( type ) → stringmodule:engine/view/datatransfer~ViewDataTransfer#getDataGets the data from the data transfer by its MIME type.
Copy codedataTransfer.getData( 'text/plain' );Parameters
type: stringThe MIME type. E.g.
text/htmlortext/plain.
Returns
string
setData( type, data ) → voidmodule:engine/view/datatransfer~ViewDataTransfer#setDataSets the data in the data transfer.
Parameters
type: stringThe MIME type. E.g.
text/htmlortext/plain.data: string
Returns
void
setDragImage( image, x, y ) → voidmodule:engine/view/datatransfer~ViewDataTransfer#setDragImageSet a preview image of the dragged content.
Parameters
image: Elementx: numbery: number
Returns
void