VS Code API
    Preparing search index...

    Class DataTransfer

    A map containing a mapping of the mime type of the corresponding transferred data.

    Drag and drop controllers that implement handleDrag can add additional mime types to the data transfer. These additional mime types will only be included in the handleDrop when the drag was initiated from an element in the same drag and drop controller.

    Implements

    Index

    Constructors

    Methods

    Constructors

    Methods

    • Get a new iterator with the [mime, item] pairs for each element in this data transfer.

      Returns IterableIterator<[mimeType: string, item: DataTransferItem]>

    • Allows iteration through the data transfer items.

      Parameters

      • callbackfn: (item: DataTransferItem, mimeType: string, dataTransfer: DataTransfer) => void

        Callback for iteration through the data transfer items.

      • OptionalthisArg: any

        The this context used when invoking the handler function.

      Returns void

    • Retrieves the data transfer item for a given mime type.

      Parameters

      • mimeType: string

        The mime type to get the data transfer item for, such as text/plain or image/png. Mimes type look ups are case-insensitive.

        Special mime types:

        • text/uri-list — A string with toString()ed Uris separated by \r\n. To specify a cursor position in the file, set the Uri's fragment to L3,5, where 3 is the line number and 5 is the column number.

      Returns DataTransferItem | undefined

    • Sets a mime type to data transfer item mapping.

      Parameters

      • mimeType: string

        The mime type to set the data for. Mimes types stored in lower case, with case-insensitive looks up.

      • value: DataTransferItem

        The data transfer item for the given mime type.

      Returns void