Skip to content

CAAnimationEvent ​

CAAnimationEvent represents an animation that has stopped: it played to the end, or was removed partway.

The stop event of CAAnimation is this class, and finished tells which case it was. The start event is a plain Event.

Inheritance: Event → CAAnimationEvent

Constructor ​

CAAnimationEvent()

Creates a CAAnimationEvent. The runtime creates one itself when it fires the events below; app code can use it to build an event object and fire it with dispatchEvent() to try out a listener.

Instance properties ​

Also inherits the properties of Event; the most commonly used are type and target. The properties below are read-only; assigning to them throws TypeError.

PropertyDescription
finished read-onlyWhether the animation played to the end or was removed partway

These properties live on the prototype, not on the event object itself: Object.keys(event) and { ...event } don't include them, so read them one by one. See Events with fields.

Events that use this class ​

ObjectEvents
CAAnimation and its subclassesstop

It can't be canceled: cancelable is false, and preventDefault() has no effect.

Examples ​

js
const dot = new CALayer();
const fade = CABasicAnimation.animationWithKeyPath('opacity');
fade.duration = 0.3;
fade.addEventListener('stop', (e) => {
  console.log(e instanceof CAAnimationEvent, e.finished);
});
dot.addAnimation(fade, { forKey: 'fade' });

Effect: when the animation finishes, prints true true.

Corresponding iOS API ​

ObjCJS
animationDidStop:finished:The stop event
The flag parameterevent.finished

See also ​