KeyframeEffectReadOnly.getKeyframes()

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 getKeyframes() method of a KeyframeEffectReadOnly or a KeyframeEffect returns an Array of the computed keyframes that make up this animation along with their computed offsets.

Syntax

JavaScript
var keyframes = keyframeEffect.<code>getKeyframes()</code>;

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 and 1.0 inclusive or null. This will be null if the keyframe is automatically spaced using KeyframeEffect.spacing.

computedOffset

The computed offset for this keyframe, calculated when the list of computed keyframes was produced according to KeyframeEffect.spacing. Unlike offset, above, the computedOffset is never null.

easing

The timing function used from this keyframe until the next keyframe in the series.

composite

The KeyframeEffectReadOnly.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:

JavaScript
// Return the array of keyframes

redQueen_alice.effect.getKeyframes();

Specifications

Specification Status Comment
Web Animations
The definition of 'KeyframeEffectReadOnly.getKeyframes()' in that specification.		 Working Draft Editor's draft.

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support No support No support No support No support No support
Feature Android Android Webview Chrome for Android Firefox Mobile (Gecko) Firefox OS IE Mobile Opera Mobile Safari Mobile
Basic 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/keyframeeffectreadonly/getkeyframes

Animation API Experimental getKeyframes KeyframeEffect KeyframeEffectReadOnly Method Reference waapi web animations api