Web/API/Animation/finish

From Get docs

This is an experimental technologyCheck the Browser compatibility table carefully before using this in production.


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 AnimationsThe definition of 'finish()' in that specification. Working Draft  

Browser compatibility

Update compatibility data on GitHub

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari Android webview Chrome for Android Firefox for Android Opera for Android Safari on iOS Samsung Internet

finish

Experimental'

Chrome

Full support 39

Edge

Full support 79

Firefox Full support 48


Full support 48


No support 46 — 48

Disabled'

Disabled' From version 46 until version 48 (exclusive): this feature is behind the dom.animations-api.core.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.

IE

No support No

Opera

Full support 26

Safari

No support No

WebView Android

Full support 39

Chrome Android

Full support 39

Firefox Android Full support 48


Full support 48


No support 46 — 48

Disabled'

Disabled' From version 46 until version 48 (exclusive): this feature is behind the dom.animations-api.core.enabled preference (needs to be set to true). To change preferences in Firefox, visit about:config.

Opera Android

Full support 26

Safari iOS

No support No

Samsung Internet Android

Full support 4.0

Legend

Full support  
Full support
No support  
No support
Experimental. Expect behavior to change in the future.'
Experimental. Expect behavior to change in the future.
User must explicitly enable this feature.'
User must explicitly enable this feature.


See also