akasha

Interface KeyframeEffectOptions

All Superinterfaces:

EffectTiming

All Known Subinterfaces:

KeyframeAnimationOptions

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="Object")
public interface KeyframeEffectOptions
extends EffectTiming

The KeyframeEffectOptions dictionary, part of the Web Animations API, is used by Element.animate(), KeyframeEffectReadOnly() and KeyframeEffect() to describe timing properties for animation effects. These properties are all optional, although without setting a duration the animation will not play.

See Also:

KeyframeEffectOptions - MDN, KeyframeEffectOptions - Web Animations Level 2, KeyframeEffectOptions - Web Animations

Method Summary

Modifier and Type	Method and Description
java.lang.String	composite()
default KeyframeEffectOptions	composite(java.lang.String composite)
static KeyframeEffectOptions	create()
default KeyframeEffectOptions	delay(double delay) The EffectTiming dictionary's delay property in the Web Animations API represents the number of milliseconds to delay the start of the animation.
default KeyframeEffectOptions	direction(java.lang.String direction) The direction property of the Web Animations API dictionary EffectTiming indicates an animation's playback direction along its timeline, as well as its behavior when it reaches the end of an iteration
default KeyframeEffectOptions	duration(double duration) The duration property of the dictionary EffectTiming in the Web Animations API specifies the duration in milliseconds that a single iteration (from beginning to end) the animation should take to complete.
default KeyframeEffectOptions	duration(java.lang.String duration) The duration property of the dictionary EffectTiming in the Web Animations API specifies the duration in milliseconds that a single iteration (from beginning to end) the animation should take to complete.
default KeyframeEffectOptions	easing(java.lang.String easing) The EffectTiming dictionary's easing property in the Web Animations API specifies the timing function used to scale the time to produce easing effects, where easing is the rate of the animation's change over time.
default KeyframeEffectOptions	endDelay(double endDelay) The endDelay property of the EffectTiming dictionary (part of the Web Animations API) indicates the number of milliseconds to delay after the active period of an animation sequence.
default KeyframeEffectOptions	fill(java.lang.String fill) The Web Animations API's EffectTiming dictionary's fill property specifies a fill mode, which defines how the element to which the animation is applied should look when the animation sequence is not actively running, such as before the time specified by iterationStart or after animation's end time.
java.lang.String	iterationComposite()
default KeyframeEffectOptions	iterationComposite(java.lang.String iterationComposite)
default KeyframeEffectOptions	iterations(double iterations) The Web Animations API dictionary EffectTiming's iterations property specifies the number of times the animation should repeat.
default KeyframeEffectOptions	iterationStart(double iterationStart) Web Animations API's EffectTiming dictionary's iterationStart property specifies the repetition number which repetition the animation begins at and its progress through it.
void	setComposite(java.lang.String composite)
void	setIterationComposite(java.lang.String iterationComposite)

Methods inherited from interface akasha.EffectTiming

delay, direction, duration, easing, endDelay, fill, iterations, iterationStart, setDelay, setDirection, setDuration, setDuration, setDuration, setEasing, setEndDelay, setFill, setIterations, setIterationStart

Method Detail

create

@JsOverlay
 @Nonnull
static KeyframeEffectOptions create()

Specified by:

create in interface EffectTiming

composite

@JsProperty(name="composite")
 @CompositeOperation
java.lang.String composite()

setComposite

@JsProperty
void setComposite(@CompositeOperation @Nonnull
                              java.lang.String composite)

composite

@JsOverlay
 @Nonnull
default KeyframeEffectOptions composite(@CompositeOperation @Nonnull
                                                             java.lang.String composite)

iterationComposite

@JsProperty(name="iterationComposite")
 @IterationCompositeOperation
java.lang.String iterationComposite()

setIterationComposite

@JsProperty
void setIterationComposite(@IterationCompositeOperation @Nonnull
                                       java.lang.String iterationComposite)

iterationComposite

@JsOverlay
 @Nonnull
default KeyframeEffectOptions iterationComposite(@IterationCompositeOperation @Nonnull
                                                                      java.lang.String iterationComposite)

delay

@JsOverlay
 @Nonnull
default KeyframeEffectOptions delay(double delay)

The EffectTiming dictionary's delay property in the Web Animations API represents the number of milliseconds to delay the start of the animation.

Specified by:

delay in interface EffectTiming

See Also:

EffectTiming.delay - MDN, delay - Web Animations

direction

@JsOverlay
 @Nonnull
default KeyframeEffectOptions direction(@PlaybackDirection @Nonnull
                                                             java.lang.String direction)

The direction property of the Web Animations API dictionary EffectTiming indicates an animation's playback direction along its timeline, as well as its behavior when it reaches the end of an iteration

Specified by:

direction in interface EffectTiming

See Also:

EffectTiming.direction - MDN, direction - Web Animations

duration

@JsOverlay
 @Nonnull
default KeyframeEffectOptions duration(double duration)

The duration property of the dictionary EffectTiming in the Web Animations API specifies the duration in milliseconds that a single iteration (from beginning to end) the animation should take to complete.

Specified by:

duration in interface EffectTiming

See Also:

EffectTiming.duration - MDN, duration - Web Animations

duration

@JsOverlay
 @Nonnull
default KeyframeEffectOptions duration(@Nonnull
                                                            java.lang.String duration)

The duration property of the dictionary EffectTiming in the Web Animations API specifies the duration in milliseconds that a single iteration (from beginning to end) the animation should take to complete.

Specified by:

duration in interface EffectTiming

See Also:

EffectTiming.duration - MDN, duration - Web Animations

easing

@JsOverlay
 @Nonnull
default KeyframeEffectOptions easing(@Nonnull
                                                          java.lang.String easing)

The EffectTiming dictionary's easing property in the Web Animations API specifies the timing function used to scale the time to produce easing effects, where easing is the rate of the animation's change over time.

Specified by:

easing in interface EffectTiming

See Also:

EffectTiming.easing - MDN, easing - Web Animations

endDelay

@JsOverlay
 @Nonnull
default KeyframeEffectOptions endDelay(double endDelay)

The endDelay property of the EffectTiming dictionary (part of the Web Animations API) indicates the number of milliseconds to delay after the active period of an animation sequence. The animation's end time—the time at which an iteration is considered to have finished—is the time at which the animation finishes an iteration (its initial delay, AnimationEffectTimingReadOnly.delay, plus its duration,duration, plus its end delay.

Specified by:

endDelay in interface EffectTiming

See Also:

EffectTiming.endDelay - MDN, endDelay - Web Animations

fill

@JsOverlay
 @Nonnull
default KeyframeEffectOptions fill(@FillMode @Nonnull
                                                        java.lang.String fill)

The Web Animations API's EffectTiming dictionary's fill property specifies a fill mode, which defines how the element to which the animation is applied should look when the animation sequence is not actively running, such as before the time specified by iterationStart or after animation's end time.

Specified by:

fill in interface EffectTiming

See Also:

EffectTiming.fill - MDN, fill - Web Animations

iterationStart

@JsOverlay
 @Nonnull
default KeyframeEffectOptions iterationStart(double iterationStart)

Web Animations API's EffectTiming dictionary's iterationStart property specifies the repetition number which repetition the animation begins at and its progress through it.

Specified by:

iterationStart in interface EffectTiming

See Also:

EffectTiming.iterationStart - MDN, iterationStart - Web Animations

iterations

@JsOverlay
 @Nonnull
default KeyframeEffectOptions iterations(double iterations)

The Web Animations API dictionary EffectTiming's iterations property specifies the number of times the animation should repeat. The default value is 1, indicating that it should only play once, but you can set it to any floating-point value (including positive Infinity defaults to 1, and can also take a value of Infinity to make it loop infinitely.

Specified by:

iterations in interface EffectTiming

See Also:

EffectTiming.iterations - MDN, iterations - Web Animations