This is an experimental technology
Because this technology's specification has not stabilized, check the compatibility table for usage in various browsers. Also note that the syntax and behavior of an experimental technology is subject to change in future versions of browsers as the specification changes.
The Animation.pause()
method of the Animation
interface suspends playback of the animation.
Syntax
animation.pause();
Parameters
None.
Return Value
None.
Exceptions
Throws an InvalidStateError
if the animation's currentTime
is unresolved
(perhaps it hasn't started playing yet) and the end time of the animation is positive infinity.
Example
Animation.pause()
is used many times in the Alice in Web Animations API Land Growing/Shrinking Alice Game, largely because animations created with the Element.animate()
method immediately start playing and must be paused manually if you want to avoid that:
// animation of the cupcake slowly getting eaten up var nommingCake = document.getElementById('eat-me_sprite').animate( [ { transform: 'translateY(0)' }, { transform: 'translateY(-80%)' } ], { fill: 'forwards', easing: 'steps(4, end)', duration: aliceChange.effect.timing.duration / 2 }); // doesn't actually need to be eaten until a click event, so pause it initially: nommingCake.pause();
Additionally, when resetting :
// An all-purpose function to pause the animations on Alice, the cupcake, and the bottle that reads "drink me." var stopPlayingAlice = function() { aliceChange.pause(); nommingCake.pause(); drinking.pause(); }; // When the user releases the cupcake or the bottle, pause the animations. cake.addEventListener("mouseup", stopPlayingAlice, false); bottle.addEventListener("mouseup", stopPlayingAlice, false);
Specifications
Specification | Status | Comment |
---|---|---|
Web Animations The definition of 'play()' in that specification. |
Working Draft |
Browser compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|
Basic support | 39.0 | 48 (48) | No support | No support | No support |
Feature | Android | Android Webview | Firefox Mobile (Gecko) | IE Phone | Opera Mobile | Safari Mobile | Chrome for Android |
---|---|---|---|---|---|---|---|
Basic support | No support | 39.0 | 48.0 (48) | No support | No support | No support | 39.0 |
See also
- Web Animations API
Animation
for other methods and properties you can use to control web page animation.Animation.pause()
to pause an animation.Animation.reverse()
to play an animation backwards.Animation.finish()
to finish an animation.Animation.cancel()
to cancel an animation.