Interface SurfaceDropMixinProps

Supported props for the SurfaceDrop mixin.

interface SurfaceDropMixinProps {
    allowDropOnCanvas?: string;
    allowDropOnEdge?: string;
    allowDropOnGroup?: string;
    canvasDropFilter?: CanvasDropFilter<BrowserElement>;
    canvasSelector?: string;
    dataGenerator?: DataGeneratorFunction<BrowserElement>;
    dragSize?: Size;
    groupIdentifier?: GroupIdentifierFunction<BrowserElement>;
    onVertexAdded?: OnVertexAddedCallback;
    selector: string;
    surfaceId?: string;
    typeGenerator?: TypeGeneratorFunction<BrowserElement>;
}

Properties

allowDropOnCanvas? allowDropOnEdge? allowDropOnGroup? canvasDropFilter? canvasSelector? dataGenerator? dragSize? groupIdentifier? onVertexAdded? selector surfaceId? typeGenerator?

Properties

OptionalallowDropOnCanvas

allowDropOnCanvas?: string

Whether or not to allow drop on whitespace in the canvas. Defaults to true.

OptionalallowDropOnEdge

allowDropOnEdge?: string

Whether or not to allow drop on edge. Defaults to false.

OptionalallowDropOnGroup

allowDropOnGroup?: string

Whether or not to allow drop on existing vertices. Defaults to true.

OptionalcanvasDropFilter

canvasDropFilter?: CanvasDropFilter<BrowserElement>

Optional filter to test if objects may be dropped on the canvas.

OptionalcanvasSelector

canvasSelector?: string

Optional selector specifying what parts of the surface's canvas should be considered whitespace. If you're using a decorator, for instance, you might want to add a selector for that decorator's elements so that items can be dropped onto them.

OptionaldataGenerator

dataGenerator?: DataGeneratorFunction<BrowserElement>

Function to use to get a dataset for an item that is being dragged. If omitted, JsPlumb will use a default data generator that extracts data values from any data-jtk-*** attribute on the element being dragged.

OptionaldragSize

dragSize?: Size

Optional size to use for dragged elements.

OptionalgroupIdentifier

groupIdentifier?: GroupIdentifierFunction<BrowserElement>

Function to use to determine whether an item that is being dragged represents a group.

OptionalonVertexAdded

onVertexAdded?: OnVertexAddedCallback

Optional callback that will be invoked after a new vertex has been dropped and added to the dataset.

Param: v

selector

selector: string

CSS 3 selector identifying what child elements of container are draggable.

OptionalsurfaceId

surfaceId?: string

ID of the surface to attach to. This is optional; JsPlumb will use the default surface ID if you do not provide this. For apps where there's only one surface there is no need to provide this.

OptionaltypeGenerator

typeGenerator?: TypeGeneratorFunction<BrowserElement>

Function to use to get the type of an item that is being dragged.

Settings

Member Visibility

On This Page

Properties
Version :