Animation.cancel()

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.cancel() method of the Animation interface clears all keyframeEffects caused by this animation and aborts its playback.

When an animation is cancelled, its startTime and currentTime are set to null.

Syntax

// cancels animation
animation.cancel();

Parameters

None.

Return Value

None.

Exceptions

If the animation's Animation.playState is anything but idle when cancelled, this action will reject the current finished promise with a DOMException named AbortError.

Specifications

Specification Status Comment
Web Animations
The definition of 'Animation.cancel()' in that specification.
Working Draft Editor's 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 Firefox Mobile (Gecko) IE Phone Opera Mobile Safari Mobile
Basic support (Yes) 48.0 (48) No support No support No support

 

See also

License

© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/animation/cancel