AnimationEvent()

The AnimationEvent() constructor returns a newly created AnimationEvent, representing an event in relation with an animation.

Syntax

animationEvent = new AnimationEvent(type, {animationName: aPropertyName, 
                                           elapsedTime  : aFloat, 
                                           pseudoElement: aPseudoElementName});

Parameters

The AnimationEvent() constructor also inherits arguments from Event().

type

A DOMString representing the name of the type of the AnimationEvent. It is case-sensitive and can be: 'animationstart', 'animationend', or 'animationiteration'.

animationName Optional

A DOMString containing the value of the animation-name CSS property associated with the transition. It defaults to "".

elapsedTime Optional

A float giving the amount of time the animation has been running, in seconds, when this event fired, excluding any time the animation was paused. For an "animationstart" event, elapsedTime is 0.0 unless there was a negative value for animation-delay, in which case the event will be fired with elapsedTime containing  (-1 * delay). It defaults to 0.0.

pseudoElement Optional

Is a DOMString, starting with "::", containing the name of the pseudo-element the animation runs on. If the animation doesn't run on a pseudo-element but on the element itself, specify an empty string: "". It defaults to "".

Return value

A new AnimationEvent, initialized per any provided options.

Specifications

Browser compatibility

See also

• Using CSS animations
• Animation-related CSS properties and at-rules: animation, animation-delay, animation-direction, animation-duration, animation-fill-mode, animation-iteration-count, animation-name, animation-play-state, animation-timing-function, @keyframes
• The AnimationEvent interface it belongs to.