Methods

This section describes methods used to animate elements.

animate(element, config)

Animates the specified element.

Parameters:
element:

DOM Node

The element to animate.

An object that defines element animation options.

Return Value:

Object

A Promise of the jQuery.Deferred object resolved after animation is completed.

If you execute element animation before the previous one is completed, the animation is passed to a queue and is executed after the current one finishes.

isAnimating(element)

Returns a value indicating whether the specified element is being animated.

Parameters:
element:

DOM Node

The element to check for being animated.

Return Value:

Boolean

If the specified element is being animated, the method returns true. Otherwise, false.

stop(element, jumpToEnd)

Stops the animation.

Parameters:
element:

DOM Node

The element whose animation should be stopped.

jumpToEnd:

Boolean

A boolean value specifying whether to apply the target animation state to the specified object or leave the current state.