@microsoft/fast-animation > Animate
Animate class
Base animate type. This is extended by AnimateTo and AnimateFrom.
Signature:export default abstract class Animate
Constructors
Constructor | Modifiers | Description |
---|---|---|
(constructor)(element, options, effectTiming) | Constructs a new instance of the Animate class |
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
addKeyframes | (keyframes: Array<Partial<Keyframe>>) => void | adds a set of keyframes to set of animation keyframes the animation should execute | |
cancel | () => void | cancels the animation | |
effectTiming | EffectTiming | Stores animation timing functions | |
finish | () => void | finishes the animation | |
keyframeEffect | KeyframeEffect | Returns the key frame effect object | |
keyframes | Keyframe[] | Returns the animation's keyframes | |
mode | AnimationMode | Tracks if the animation should animate toward an elements natural position or away from it | |
onCancel | () => void | Callback to call when the animation is canceled | |
onFinish | () => void | ||
options | AnimateConfig | Stores animation options | |
pause | () => void | pauses the animation | |
play | () => void | plays the animation | |
reverse | () => void | reverses an animation |