akasha

Interface EffectTiming

All Known Subinterfaces:

ComputedEffectTiming, ComputedEffectTiming.Builder, EffectTiming.Builder, KeyframeAnimationOptions, KeyframeAnimationOptions.Builder, KeyframeEffectOptions, KeyframeEffectOptions.Builder

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

The EffectTiming 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:

EffectTiming - MDN, EffectTiming - Web Animations

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EffectTiming.Builder The EffectTiming dictionary, part of the Web Animations API, is used by Element.animate(), KeyframeEffectReadOnly(), and KeyframeEffect() to describe timing properties for animation effects.

Method Summary

Modifier and Type	Method and Description
static EffectTiming.Builder	create()
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.
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
UnrestrictedDoubleOrStringUnion	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.
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.
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.
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.
double	iterations() The Web Animations API dictionary EffectTiming's iterations property specifies the number of times the animation should repeat.
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	setDelay(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.
void	setDirection(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 void	setDuration(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 void	setDuration(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.
void	setDuration(UnrestrictedDoubleOrStringUnion 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.
void	setEasing(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.
void	setEndDelay(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.
void	setFill(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.
void	setIterations(double iterations) The Web Animations API dictionary EffectTiming's iterations property specifies the number of times the animation should repeat.
void	setIterationStart(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.

Method Detail

create

@JsOverlay
 @Nonnull
static EffectTiming.Builder create()

delay

@JsProperty(name="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

setDelay

@JsProperty
void setDelay(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

@JsProperty(name="direction")
 @PlaybackDirection
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

setDirection

@JsProperty
void setDirection(@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

@JsProperty(name="duration")
UnrestrictedDoubleOrStringUnion 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

setDuration

@JsProperty
void setDuration(@Nonnull
                             UnrestrictedDoubleOrStringUnion 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

setDuration

@JsOverlay
default void setDuration(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

setDuration

@JsOverlay
default void setDuration(@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

@JsProperty(name="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.

See Also:

EffectTiming.easing - MDN, easing - Web Animations

setEasing

@JsProperty
void setEasing(@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

@JsProperty(name="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

setEndDelay

@JsProperty
void setEndDelay(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

@JsProperty(name="fill")
 @FillMode
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

setFill

@JsProperty
void setFill(@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

@JsProperty(name="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

setIterationStart

@JsProperty
void setIterationStart(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

@JsProperty(name="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

setIterations

@JsProperty
void setIterations(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