Interface SurfaceDragOptions

Options for element drag in a Surface.

interface SurfaceDragOptions {
    addHelperClasses?: boolean;
    autoPan?: boolean;
    autoPanDelta?: number;
    autoPanRepeat?: number;
    constrainFunction?: ((desiredLoc, dragEl, constrainRect, size, currentLoc) => PointXY);
    filter?: string;
}

Hierarchy

  • Omit<DragOptions, "grid">
    • SurfaceDragOptions

Properties

addHelperClasses? autoPan? autoPanDelta? autoPanRepeat? constrainFunction? filter?

Properties

Optional addHelperClasses

addHelperClasses?: boolean

Defaults to true, meaning that when element dragging is occurring a class is added to the document body and also to the surface container.

Optional autoPan

autoPan?: boolean

Defaults to true, meaning the canvas will pan automatically to track elements that have been dragged out of the visible area.

Optional autoPanDelta

autoPanDelta?: number

When auto-panning, this is the number of pixels that the canvas repositions itself on each tick. Defaults to 5.

Optional autoPanRepeat

autoPanRepeat?: number

When auto-panning, this is the speed (in milliseconds) at which the canvas repositions itself. Defaults to 15ms.

Optional constrainFunction

constrainFunction?: ((desiredLoc, dragEl, constrainRect, size, currentLoc) => PointXY)

Optional function to use to constrain element dragging.

Type declaration

Optional filter

filter?: string

Optional CSS3 selector identifying parts of nodes/groups that should not cause a drag to start.

Settings

Member Visibility

Theme

On This Page

addHelperClassesautoPanautoPanDeltaautoPanRepeatconstrainFunctionfilter