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 finish() method of the Web Animations API's Animation Interface sets the current playback time to the end of the animation corresponding to the current playback direction. That is, if the animation is playing forward, it sets the playback time to the length of the animation sequence, and if the animation is playing in reverse (having had its reverse() method called), it sets the playback time to 0.
Syntax
Animation.finish();
Parameters
None.
Return value
None.
Exceptions
InvalidState- The player's playback rate is 0 or the animation's playback rate is greater than 0 and the end time of the animation is infinity.
Examples
The following example shows how to use the finish() method and catch an InvalidState error.
interfaceElement.addEventListener("mousedown", function() {
try {
player.finish();
} catch(e if e instanceof InvalidState) {
console.log("finish() called on paused or finished animation.");
} catch(e);
logMyErrors(e); //pass exception object to error handler
}
});
The following example finishes all the animations on a single element, regardless of their direction of playback.
elem.getAnimations().forEach(
function(animation){
return animation.finish();
}
);
Specifications
| Specification | Status | Comment |
|---|---|---|
| Web Animations The definition of 'finish()' in that specification. |
Working Draft |
Browser compatibility
| Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
|---|---|---|---|---|---|
| Basic support | 39.0 | 48 (48)[1] | 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)[1] | No support | No support | No support | 39.0 |
[1] The Web Animations API is only enabled by default in Firefox Developer Edition and Nightly builds. You can enable it in beta and release builds by setting the preference dom.animations-api.core.enabled to true, and can disable it in any Firefox version by setting this preference to false.
See also
- Web Animations API
Animationfor other methods and properties you can use to control web page animation.Animation.play()to play an animation forward.Animation.reverse()to play an animation backward.