Methods

This section describes the methods provided by the DevExpress.TransitionExecutor object.

enter(elements, animation)

Registers a set of elements that should be animated as "entering" using the specified animation configuration.

Parameters:
elements: jQuery

A jQuery object including the elements to be animated.

An object defining the target animation or the name of the animation that is registered in the animationPresets repository.

Before starting a transition (a set of simultaneous animations), the elements that will take part in it and the animation configurations to be used to animate these elements should be registered. For this purpose, use the enter(elements, animation) method. The elements registered using this method will be animated as "entering" ones. To register elements for a "leaving" animation within this transition, use the leave(elements, animation) method.

If you pass a name of a predefined animation as the second parameter, but an animation is not found by this name in the animation repository, the specified element(s) will not be animated within this transition.

leave(elements, animation)

Registers a set of elements that should be animated as "leaving" using the specified animation configuration.

Parameters:
elements: jQuery

A jQuery object including the elements to be animated.

An object defining the target animation or the name of the animation that is registered in the animationPresets repository.

Before starting a transition (a set of simultaneous animations), the elements that will take part in it and the animation configurations to be used to animate these elements should be registered. For this purpose, use the enter(elements, animation) method. The elements registered using this method will be animated as "entering" ones. To register elements for a "leaving" animation within this transition, use the leave(elements, animation) method.

If you pass a name of a predefined animation as the second parameter, but an animation is not found by this name in the animation repository, the specified element(s) will not be animated within this transition.

reset()

Deletes all the animations registered in the Transition Executor by using the enter(elements, animation) and leave(elements, animation) methods.

start()

Starts all the animations registered using the enter(elements, animation) and leave(elements, animation) methods beforehand.

Return Value: jQuery.Promise

A Promise of jQuery.Deferred, which resolves when all the animations are finished.