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 KeyframeEffects caused by this animation and aborts its playback.

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

Specification
Web Animations Level 2 (Web Animations 2)
# dom-animation-cancel

Browser compatibility

BCD tables only load in the browser

See also