Skip to main content

Home > @jsplumbtoolkit/browser-ui > SurfaceDragOptions

SurfaceDragOptions interface

Options for element drag in a Surface.


export interface SurfaceDragOptions extends Omit<DragOptions, "grid"> 

Extends: Omit<DragOptions, "grid">


addHelperClasses?boolean(Optional) Defaults to true, meaning that when element dragging is occurring a class is added to the document body and also to the surface container.
constrainFunction?(desiredLoc: PointXY, dragEl: HTMLElement, constrainRect: Size, size: Size) => PointXY(Optional) Optional function to use to constrain element dragging.
filter?string(Optional) Optional CSS3 selector identifying parts of nodes/groups that should not cause a drag to start.