Animation: cancel() method

{{ APIRef("Web Animations") }}

The Web Animations API's cancel() method of the {{domxref("Animation")}} interface clears all {{domxref("KeyframeEffect")}}s caused by this animation and aborts its playback.

[!NOTE] When an animation is cancelled, its {{domxref("Animation.startTime", "startTime")}} and {{domxref("Animation.currentTime", "currentTime")}} are set to null.

Syntax

cancel()

Parameters

None.

Return value

None ({{jsxref("undefined")}}).

Exceptions

This method doesn't directly throw exceptions; however, if the animation's {{domxref("Animation.playState", "playState")}} is anything but "idle" when cancelled, the {{domxref("Animation.finished", "current finished promise", "", 1)}} is rejected with a {{domxref("DOMException")}} named AbortError.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• Web Animations API
• {{domxref("KeyframeEffect")}}
• {{domxref("Animation")}}
• {{domxref("Animation.playState")}}
• {{domxref("Animation.finished")}} returns the promise this action will reject if the animation's playState is not "idle".