Namespace Simples.Animation
Simples.Animation
Defined in: animation.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Animation controller if provide a standard animation object to this functionality it will execute the animation
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
Simples.Animation.create(elem, setStyle, opts)
Simples.Animation.create: used to to create an animation object which can be used by the animation queue runner
|
| <static> |
Simples.Animation.reset(animation, resetToEnd)
Simples.Animation.reset: used to reset an animation to either the start or finish position
|
| <static> |
Simples.Animation.reverse(animation)
Simples.Animation.reverse: used to take an animation in its current position and reverse and run
|
| <static> |
Simples.Animation.start(animation)
Simples.Animation.start: used to add the animation to the animation runner queue
|
| <static> |
Simples.Animation.stop(animation, jumpToEnd)
Simples.Animation.stop: used to stop a supplied animation and cleanup after itsef
|
Namespace Detail
Simples.Animation
Animation controller if provide a standard animation object to this functionality it will execute the animation
Method Detail
<static>
Simples.Animation.create(elem, setStyle, opts)
Simples.Animation.create: used to to create an animation object which can be used by the animation queue runner
- Parameters:
- elem
- {Element} DOM Element to animate
- setStyle
- {Object} CSS to use in animation, final position
- opts
- {Object}
- opts.callback
- {Function} when animation complete
- opts.tween
- {Function} tween to use when animating
- opts.duration
- {Object} the time to elapse during animation
<static>
Simples.Animation.reset(animation, resetToEnd)
Simples.Animation.reset: used to reset an animation to either the start or finish position
- Parameters:
- animation
- {Object} animation to perform action on
- resetToEnd
- {Boolean} whether to reset to finish (true) or start (false||undefined) state
<static>
Simples.Animation.reverse(animation)
Simples.Animation.reverse: used to take an animation in its current position and reverse and run
- Parameters:
- animation
- {Object} animation to perform action on
<static>
Simples.Animation.start(animation)
Simples.Animation.start: used to add the animation to the animation runner queue
- Parameters:
- animation
- {Object} animation to perform action on
<static>
Simples.Animation.stop(animation, jumpToEnd)
Simples.Animation.stop: used to stop a supplied animation and cleanup after itsef
- Parameters:
- animation
- {Object} the animation object to use and work on.
- jumpToEnd
- {Boolean} whether to leave in current position or set css to finish position