akasha

Interface KeyframeEffectOptions.Builder

All Superinterfaces:

EffectTiming, KeyframeEffectOptions

Enclosing interface:

KeyframeEffectOptions

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

The KeyframeEffectOptions dictionary, part of the Web Animations API, is used by Element.animate() 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

Nested Class Summary

Nested classes/interfaces inherited from interface akasha.KeyframeEffectOptions

KeyframeEffectOptions.Builder

Method Summary

Modifier and Type	Method and Description
default KeyframeEffectOptions.Builder	composite(java.lang.String composite)
default KeyframeEffectOptions.Builder	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.Builder	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.Builder	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.Builder	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.Builder	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.Builder	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.Builder	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.
default KeyframeEffectOptions.Builder	iterations(double iterations) The Web Animations API dictionary EffectTiming's iterations property specifies the number of times the animation should repeat.
default KeyframeEffectOptions.Builder	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.
default KeyframeEffectOptions.Builder	pseudoElement(java.lang.String pseudoElement)

Methods inherited from interface akasha.KeyframeEffectOptions

composite, create, pseudoElement, setComposite, setPseudoElement

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

composite

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

pseudoElement

@JsOverlay
 @Nonnull
default KeyframeEffectOptions.Builder pseudoElement(@Nonnull
                                                                         java.lang.String pseudoElement)

delay

@JsOverlay
 @Nonnull
default KeyframeEffectOptions.Builder 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.

See Also:

EffectTiming.delay - MDN, delay - Web Animations

direction

@JsOverlay
 @Nonnull
default KeyframeEffectOptions.Builder 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

See Also:

EffectTiming.direction - MDN, direction - Web Animations

duration

@JsOverlay
 @Nonnull
default KeyframeEffectOptions.Builder 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.

See Also:

EffectTiming.duration - MDN, duration - Web Animations

duration

@JsOverlay
 @Nonnull
default KeyframeEffectOptions.Builder 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.

See Also:

EffectTiming.duration - MDN, duration - Web Animations

easing

@JsOverlay
 @Nonnull
default KeyframeEffectOptions.Builder 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.

See Also:

EffectTiming.easing - MDN, easing - Web Animations

endDelay

@JsOverlay
 @Nonnull
default KeyframeEffectOptions.Builder 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.

See Also:

EffectTiming.endDelay - MDN, endDelay - Web Animations

fill

@JsOverlay
 @Nonnull
default KeyframeEffectOptions.Builder 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.

See Also:

EffectTiming.fill - MDN, fill - Web Animations

iterationStart

@JsOverlay
 @Nonnull
default KeyframeEffectOptions.Builder 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.

See Also:

EffectTiming.iterationStart - MDN, iterationStart - Web Animations

iterations

@JsOverlay
 @Nonnull
default KeyframeEffectOptions.Builder 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.

See Also:

EffectTiming.iterations - MDN, iterations - Web Animations