Animation.cancel()
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The Web Animations API's cancel()
method of the Animation
interface clears all KeyframeEffect
s caused by this animation and aborts its playback.
Note: When an animation is cancelled, its startTime
and currentTime
are set to null
.
Syntax
Animation.cancel();
Parameters
None.
Return value
None.
Exceptions
This method doesn't directly throw exceptions; however, if the animation's playState
is anything but "idle"
when cancelled, the current finished promise is rejected with a DOMException
named AbortError
.
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 | |
cancel |
39 |
79 |
48 |
No |
26 |
13.1 |
39 |
39 |
48 |
26 |
13.4 |
4.0 |
See also
- Web Animations API
KeyframeEffect
Animation
Animation.playState
-
Animation.finished
returns the promise this action will reject if the animation'splayState
is not"idle"
.
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/Animation/cancel