Skip to main content

Home > @jsplumbtoolkit/drop

drop package

Classes

ClassDescription
DropManagerOffers a means to configure some element in the UI to act as a source for drag/drop of new nodes/groups. This is a concrete class that can be used standalone, but note that it is extended by the SurfaceDropManager, and for the vast majority of applications, SurfaceDropManager will be the class you want to use. The difference between the two classes is that DropManager provides a means for you to respond to items being dropped onto a surface canvas, but it does not do anything when such an event occurs other than inform you, via a set of callbacks, whereas the SurfaceDropManager provides implementations of these callbacks that manipulate the canvas and the data model.
SurfaceDropManagerSurfaceDropManager wraps DropManager with default implementations of the various callbacks. Most users will want to use this class rather than DropManager, as it operates at a higher level.

Functions

FunctionDescription
createManager(options)
createSurfaceManager(options)

Interfaces

InterfaceDescription
DropManagerOptionsOptions for the DropManager.
SurfaceDropManagerOptionsOptions for the SurfaceDropManager.

Type Aliases

Type AliasDescription
CanvasDropFilterDefines a function used to filter drop on a canvas
CanvasDropFunctionDefines the function invoked when an item is dropped onto whitespace in the canvas.
DataGeneratorFunctionDefines the function that is invoked to gather a dataset to associate with an item that is being dragged.
DragFunctionDefines the callback function invoked when an item is being dragged.
DropFilterDefines a function used to filter drop on another vertex.
DropFunctionDefines the function invoked when an item is dropped onto an existing vertex.
EdgeDropFilterDefines a function used to filter drop on an edge.
EdgeDropFunctionDefines the function invoked when an item is dropped on an edge.
GroupIdentifierFunctionDefines the function that is invoked to determine whether an item that is about to be dragged represents a group.
TypeGeneratorFunctionDefines the function invoked to determine the type of some item that is about to be dragged.