Animation: finish() method
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
Parameters
Return value
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", () => {
try {
player.finish();
} catch (e) {
if (e instanceof InvalidState) {
console.log("finish() called on paused or finished animation.");
} else {
logMyErrors(e);
}
}
});
The following example finishes all the animations on a single element, regardless of their direction of playback.
elem.getAnimations().forEach((animation) => animation.finish());
Specifications
Browser compatibility
|
Desktop |
Mobile |
|
Chrome |
Edge |
Firefox |
Internet Explorer |
Opera |
Safari |
WebView Android |
Chrome Android |
Firefox for Android |
Opera Android |
Safari on IOS |
Samsung Internet |
finish |
75 |
79 |
48 |
No |
62 |
13.1 |
75 |
75 |
48 |
54 |
13.4 |
11.0 |
See also