Animation.oncancel

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.oncancel property of the Web Animations API is the event handler for the cancel event.

The cancel event can be triggered manually with Animation.cancel() or at an instance when the animation enters an idle play state from another state. (For instance, removing an animation before it has the chance to enter the finish play state.)

Note: Creating a new animation that is initially idle does not generate a new cancel event.

Syntax

JavaScript
// getting oncancel
var uponCancellation = animation.oncancel;

// setting oncancel
animation.oncancel = cancelAction;

Value

A function to be executed when the animation is cancelled or null.

Examples

If this animation is canceled, remove its element.

JavaScript
animation.oncancel = animation.effect.target.remove();

Specifications

Specification Status Comment
Web Animations
The definition of 'Animation.oncancel' 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/oncancel

Animation API Events events Experimental oncancel Property Reference waapi web animations api