Class FileDrop

Index

Constructors

Properties

element fileDroppedCallbackBinary fileDroppedCallbackJSON fileDroppedCallbackSVG fileDroppedCallbackText

Methods

destroy handleDragLeaveEvent handleDragOverEvent handleDropEvent onFileJSONDropped onFileSVGDropped onFileTextDropped

Constructors

constructor

new FileDrop(element): FileDrop
Parameters
- element: HTMLElement
  The element you wish to operate as the drop zone (like ).
Returns FileDrop
- Defined in plotboilerplate/src/ts/utils/io/FileDrop.ts:70

Properties

`Private` element

element: HTMLElement

The 'dropzone' element.

Memberof

FileDrop

Member

`Private` fileDroppedCallbackBinary

fileDroppedCallbackBinary: IDroppedCallbackBinary

The binary file drop callback.

Memberof

FileDrop

Member

`Private` fileDroppedCallbackJSON

fileDroppedCallbackJSON: IDroppedCallbackJSON

The JSON file drop callback.

Memberof

FileDrop

Member

`Private` fileDroppedCallbackSVG

fileDroppedCallbackSVG: IDroppedCallbackSVG

The SVG file drop callback.

Memberof

FileDrop

Member

`Private` fileDroppedCallbackText

fileDroppedCallbackText: IDroppedCallbackText

The text file drop callback.

Memberof

FileDrop

Member

Methods

destroy

destroy(): void
Removes all listeners (drop, dragover and dragleave).

Returns void
- Defined in plotboilerplate/src/ts/utils/io/FileDrop.ts:214

`Private` handleDragLeaveEvent

handleDragLeaveEvent(event): void
Restored the drop sensitive element's opacity back to 1.0.
Parameters
- event: DragEvent
  The event.
Returns void
- Defined in plotboilerplate/src/ts/utils/io/FileDrop.ts:205

`Private` handleDragOverEvent

handleDragOverEvent(event): void
Toggles the drop sensitive element's opacity to 0.5.
Parameters
- event: DragEvent
  The event.
Returns void
- Defined in plotboilerplate/src/ts/utils/io/FileDrop.ts:194

`Private` handleDropEvent

handleDropEvent(event): void
Internally handle a drop event.
Parameters
- event: DragEvent
Returns void
- Defined in plotboilerplate/src/ts/utils/io/FileDrop.ts:115

onFileJSONDropped

onFileJSONDropped(callback): void
Install the JSON (MIME type json*) file drop callback. Note than only one callback can be installed in this implementation. Calling this method multiple times will overwrite previously installed listeners.

The callback will receive the dropped file content as an object (parsed JSON).
Parameters
- callback: IDroppedCallbackJSON
Returns void
- Defined in plotboilerplate/src/ts/utils/io/FileDrop.ts:88

onFileSVGDropped

onFileSVGDropped(callback): void
Parameters
- callback: IDroppedCallbackSVG
Returns void
- Defined in plotboilerplate/src/ts/utils/io/FileDrop.ts:105

onFileTextDropped

onFileTextDropped(callback): void
Install the text file (MIME type text/plain) drop callback. Note than only one callback can be installed in this implementation. Calling this method multiple times will overwrite previously installed listeners.

The callback will receive the dropped file content as a string.
Parameters
- callback: IDroppedCallbackText
Returns void
- Defined in plotboilerplate/src/ts/utils/io/FileDrop.ts:101