Animation.oncancel

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The oncancel property of the Web Animations API's Animation interface is the event handler for the cancel event.

The cancel event can be triggered manually with Animation.cancel() when the animation enters the "idle" play state from another state, such as when the animation is removed from an element before it finishes playing

Note: Creating a new animation that is initially idle does not trigger a cancel event on the new animation.

Syntax

var cancelHandler = Animation.oncancel;

Animation.oncancel = cancelHandler;

Value

A function to be executed when the animation is cancelled, or null if there is no cancel event handler.

Examples

If this animation is canceled, remove its element.

animation.oncancel = function() { animation.effect.target.remove(); };

Specifications

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

Browser compatibility

BCD tables only load in the browser

See also