KeyframeEffect: getKeyframes() method
The getKeyframes()
method of a KeyframeEffect
returns an Array of the computed keyframes that make up this animation along with their computed offsets.
Syntax
js
getKeyframes()
Parameters
None.
Return value
Returns a sequence of objects with the following format:
property value pairs
-
As many property value pairs as are contained in each keyframe of the animation.
offset
-
The offset of the keyframe specified as a number between
0.0
and1.0
inclusive ornull
. This is equivalent to specifying start and end states in percentages in CSS stylesheets using@keyframes
. This will benull
if the keyframe is automatically spaced usingKeyframeEffect.spacing
. computedOffset
-
The computed offset for this keyframe, calculated when the list of computed keyframes was produced according to
KeyframeEffect.spacing
. Unlikeoffset
, above, thecomputedOffset
is nevernull
. easing
-
The easing function used from this keyframe until the next keyframe in the series.
composite
-
The
KeyframeEffect.composite
operation used to combine the values specified in this keyframe with the underlying value. This will be absent if the composite operation specified on the effect is being used.
Examples
In the Red Queen Race example, we can inspect Alice and the RedQueen's animation to see its individual keyframes like so:
js
// Return the array of keyframes
redQueen_alice.effect.getKeyframes();
Specifications
Specification |
---|
Web Animations # dom-keyframeeffect-getkeyframes |
Browser compatibility
BCD tables only load in the browser
See also
- Web Animations API
- Method of
KeyframeEffect
objects.