Skip to main content

startDrag

startDrag( event:Object, align:Boolean ) : void

Forces the Draggable to begin dragging.

Parameters

  • event: Object

    The mouse or touch or pointer event. It needs this in order to accurately measure distances and know where things start.

  • align: Boolean

    If the target element isn't on top of the pointer (according to the supplied event), setting align to true will move it there immediately.

Details​

This is rarely used, but you may force the Draggable to begin dragging by calling startDrag() and passing it the original mouse/touch/pointer event that initiated things - this is necessary because Draggable must inspect that event for various information like pageX, pageY, target, etc. You cannot call startDrag() without passing that original event.

startDrag() is different than enable() in that enable() activates the Draggable instance so that it responds to user interaction whereas startDrag() actually begins dragging the element, as if the user clicked on it and started dragging.

A great place to learn more about working with mouse/touch/pointer events is this article.

Contents