CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

DataTransfer (engine/view)

@ckeditor/ckeditor5-engine/src/view/datatransfer

class
See source

A facade over the native DataTransfer object.

Filtering

Properties

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

    See source

    Parameters

    value : 'link' | 'none' | 'copy' | 'move'

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

    See source

    Parameters

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

  • readonly

    files : Array<File>

    See source

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

  • readonly

    isCanceled : boolean

    See source

    Whether the dragging operation was canceled.

  • readonly

    types : readonly Array<string>

    See source

    Returns an array of available native content types.

  • private

    _files : null | Array<File>

    See source

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

  • private

    _native : DataTransfer

    See source

    The native DataTransfer object.

Methods

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

    See source

    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

    See source

    Gets the data from the data transfer by its MIME type.

    dataTransfer.getData( 'text/plain' );

    Parameters

    type : string

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

    Returns

    string

  • setData( type, data ) → void

    See source

    Sets the data in the data transfer.

    Parameters

    type : string

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

    data : string

    Returns

    void

  • setDragImage( image, x, y ) → void

    See source

    Set a preview image of the dragged content.

    Parameters

    image : Element
    x : number
    y : number

    Returns

    void