FileDrop

An experimental feature that lets users drop files on a Widget. The widget fires an event when a file is dropped onto it. In the event, you get access to the raw files as strings, that were parsed by calling readAsBinaryString.

This feature is disabled by default. For info on enabling it, see GridFeatures.

NOTE: Currently only supports dropping one file at a time.

Configs

9

Common

disabledInstancePlugin
listenersEvents

Misc

bubbleEventsEvents
callOnFunctionsEvents
clientInstancePlugin
localeClassLocalizable
localizableLocalizable
localizablePropertiesLocalizable

Other

catchEventHandlerExceptionsEvents

Properties

15

Common

disabledInstancePlugin

Class hierarchy

isFileDrop: Boolean= truereadonly
Identifies an object as an instance of FileDrop class, or subclass thereof.
isFileDrop: Boolean= truereadonlystatic
Identifies an object as an instance of FileDrop class, or subclass thereof.
isEventsEvents
isInstancePluginInstancePlugin
isLocalizableLocalizable

Lifecycle

configBase
isConstructingBase
isDestroyedBase
isDestroyingBase

Misc

callOnFunctionsEvents
clientInstancePlugin
localeHelperLocalizable
localeManagerLocalizable

Other

catchEventHandlerExceptionsEvents

Functions

28

Configuration

applyDefaultsstaticBase

Events

detachListenersBase

Lifecycle

constructBase
constructorBase
destroystaticBase
doDestroyBase
setConfigBase

Misc

animatePropertyBase
callbackBase
doDisableInstancePlugin
downloadTestCaseBase
initClassstaticBase
isOfTypeNamestaticBase
mixinstaticBase
optionalLstaticLocalizable
resolveCallbackBase
updateLocalizationLocalizable

Other

addListenerEvents
hasListenerEvents
LstaticLocalizable
onEvents
relayAllEvents
removeAllListenersEvents
removeListenerEvents
resumeEventsEvents
suspendEventsEvents
triggerEvents
unEvents

Events

6
fileDrop

Fired when a file is dropped on the widget element

// Adding a listener using the "on" method
fileDrop.on('fileDrop', ({ source, file, domEvent }) => {

});
ParameterTypeDescription
sourceGrid

The owning Grid instance

fileDataTransferItem

The dropped file descriptor

domEventDragEvent

The native DragEvent

beforeDestroyEvents
catchAllEvents
destroyEvents
disableInstancePlugin
enableInstancePlugin

Event handlers

6
onFileDrop

Called when a file is dropped on the widget element

new FileDrop({
    onFileDrop({ source, file, domEvent }) {

    }
});
ParameterTypeDescription
sourceGrid

The owning Grid instance

fileDataTransferItem

The dropped file descriptor

domEventDragEvent

The native DragEvent

onBeforeDestroyEvents
onCatchAllEvents
onDestroyEvents
onDisableInstancePlugin
onEnableInstancePlugin

Typedefs

1