kotlin-browser/web.animations/KeyframeEffect

KeyframeEffect

open class KeyframeEffect( var target: Element?, keyframes: ReadonlyArray<Keyframe>?, options: Double = definedExternally) : AnimationEffect(source)

The KeyframeEffect interface of the Web Animations API lets us create sets of animatable properties and values, called keyframes. These can then be played using the Animation.Animation constructor.

MDN Reference

Constructors

KeyframeEffect

constructor(target: Element?, keyframes: ReadonlyArray<Keyframe>?, options: KeyframeEffectOptions)

constructor(target: Element?, keyframes: PropertyIndexedKeyframes?, options: Double = definedExternally)

constructor(target: Element?, keyframes: PropertyIndexedKeyframes?, options: KeyframeEffectOptions)

constructor(source: KeyframeEffect)

constructor(target: Element?, keyframes: ReadonlyArray<Keyframe>?, options: Double = definedExternally)

Properties

composite

var composite: CompositeOperation

The composite property of a KeyframeEffect resolves how an element's animation impacts its underlying property values.

iterationComposite

var iterationComposite: IterationCompositeOperation

The iterationComposite property of a KeyframeEffect resolves how the animation's property value changes accumulate or override each other upon each of the animation's iterations.

pseudoElement

var pseudoElement: String?

The pseudoElement property of a KeyframeEffect interface is a string representing the pseudo-element being animated.

target

var target: Element?

The target property of a KeyframeEffect interface represents the element or pseudo-element being animated.

Functions

getComputedTiming

fun getComputedTiming(): ComputedEffectTiming

The getComputedTiming() method of the AnimationEffect interface returns the calculated timing properties for this animation effect.

getKeyframes

fun getKeyframes(): ReadonlyArray<ComputedKeyframe>

The getKeyframes() method of a KeyframeEffect returns an Array of the computed keyframes that make up this animation along with their computed offsets.

getTiming

fun getTiming(): EffectTiming

The AnimationEffect.getTiming() method of the AnimationEffect interface returns an object containing the timing properties for the Animation Effect.

setKeyframes

fun setKeyframes(keyframes: ReadonlyArray<Keyframe>?)

The setKeyframes() method of the KeyframeEffect interface replaces the keyframes that make up the affected KeyframeEffect with a new set of keyframes.

fun setKeyframes(keyframes: PropertyIndexedKeyframes?)

updateTiming

fun updateTiming(timing: OptionalEffectTiming = definedExternally)

The updateTiming() method of the AnimationEffect interface updates the specified timing properties for an animation effect.