WinJS.UI.Animation.dragSourceEnd function

Performs an animation when the user finishes dragging an object.

The following video demonstrates the drag animations:

Syntax

WinJS.UI.Animation.dragSourceEnd(dragSource, offset, affected).done( /* Your success and error handlers */ );

Parameters

dragSource

Type: Object

Element or elements that were dragged.

offset

Type: Object

Initial offset from the drop point. The dropped object begins at the offset and animates to its final position at the drop point.

Note  When the element parameter specifies an array of elements, the offset parameter can specify an offset array with each item specified for its corresponding element array item. If the array of offsets is smaller than the array of elements, the last offset is applied to all remaining elements.

 

affected [optional]

Type: Object

Element or elements whose position the dropped object affects. Typically, this is all other items in a reorderable list. This should be the same element or element collection passed as the affected parameter in the dragSourceStart animation.

Return value

Type: Promise

An object that completes when the animation is finished.

Remarks

The dragSource and affected parameters can be expressed in several ways:

• As the special value "undefined", which means that the animation has no such target
• As a single object
• As a JavaScript array (possibly empty), in which each element of the array can be a single element or a JavaScript array of elements.
• As a NodeList (for example, the result of querySelectorAll)
• As an HTMLCollection

The offset parameter can also be provided in several forms:

• As the special value "undefined", which can be specified explicitly in the call or specified implicitly by omitting the parameter value. In the case of this animation, undefined means that no offset will be used.

• As a single JavaScript object of this form:

  { top: string, left: string, rtlflip: true | false }

  For example:

  { top: "12px", left: "0px", rtlflip: true }

  The object must have properties named top and left that represent the offset applied at the beginning of the animation. Any valid CSS units can be used to express the offset. In this form, the offset applies to all elements involved in the animation.

  The rtlflip parameter flips the values to a right-to-left alignment. It affects the left parameter and changes its sign. For instance, 10 px becomes -10px. This parameter is optional and can be omitted. If it is omitted, the default value is false.

• As a JavaScript array (possibly empty) of the {top: ..., left: ..., rtlflip: ...} objects discussed above. In this case, each object in the array applies to a single element in the animation, in the order given; the first object applies to the first element, the second to the second, and so on. If the number of elements is greater than the number of objects in this array, then the last element in the array applies to all of the remaining elements.

Requirements

See also

dragSourceStart

Animating drag-and-drop sequences

Guidelines and checklist for drag-and-drop animations

HTML animation library sample