kotlin-browser/web.cssom/CSSAnimation

CSSAnimation

class CSSAnimation : Animation(source)

The CSSAnimation interface of the Web Animations API represents an Animation object.

MDN Reference

Properties

animationName

val animationName: String

The animationName property of the specifies one or more keyframe at-rules which describe the animation applied to the element.

cancelEvent

val cancelEvent: EventInstance<AnimationPlaybackEvent, Animation, Animation>

MDN Reference

currentTime

var currentTime: CSSNumberish?

The Animation.currentTime property of the Web Animations API returns and sets the current time value of the animation in milliseconds, whether running or paused.

effect

var effect: AnimationEffect?

The Animation.effect property of the Web Animations API gets and sets the target effect of an animation.

finished

val finished: Promise<Animation>

The Animation.finished read-only property of the Web Animations API returns a Promise which resolves once the animation has finished playing.

finishEvent

val finishEvent: EventInstance<AnimationPlaybackEvent, Animation, Animation>

MDN Reference

var id: String

The Animation.id property of the Web Animations API returns or sets a string used to identify the animation.

oncancel

var oncancel: EventHandler<AnimationPlaybackEvent, Animation, Animation>?

MDN Reference

onfinish

var onfinish: EventHandler<AnimationPlaybackEvent, Animation, Animation>?

MDN Reference

onremove

var onremove: EventHandler<AnimationPlaybackEvent, Animation, Animation>?

MDN Reference

pending

val pending: Boolean

The read-only Animation.pending property of the Web Animations API indicates whether the animation is currently waiting for an asynchronous operation such as initiating playback or pausing a running animation.

playbackRate

var playbackRate: Double

The Animation.playbackRate property of the Web Animations API returns or sets the playback rate of the animation.

playState

val playState: AnimationPlayState

The read-only Animation.playState property of the Web Animations API returns an enumerated value describing the playback state of an animation.

ready

val ready: Promise<Animation>

The read-only Animation.ready property of the Web Animations API returns a Promise which resolves when the animation is ready to play.

removeEvent

val removeEvent: EventInstance<AnimationPlaybackEvent, Animation, Animation>

MDN Reference

replaceState

val replaceState: AnimationReplaceState

The read-only Animation.replaceState property of the Web Animations API indicates whether the animation has been removed by the browser automatically after being replaced by another animation.

startTime

var startTime: CSSNumberish?

The Animation.startTime property of the Animation interface is a double-precision floating-point value which indicates the scheduled time when an animation's playback should begin.

timeline

var timeline: AnimationTimeline?

The Animation.timeline property of the Animation interface returns or sets the AnimationTimeline associated with this animation.

Functions

cancel

fun cancel()

The Web Animations API's cancel() method of the Animation interface clears all KeyframeEffects caused by this animation and aborts its playback.

commitStyles

fun commitStyles()

The commitStyles() method of the Web Animations API's Animation interface writes the computed values of the animation's current styles into its target element's style attribute.

dispatchEvent

fun dispatchEvent(event: Event): Boolean

finish

fun finish()

The finish() method of the Web Animations API's Animation Interface sets the current playback time to the end of the animation corresponding to the current playback direction.

pause

fun pause()

The pause() method of the Web Animations API's Animation interface suspends playback of the animation.

persist

fun persist()

The persist() method of the Web Animations API's Animation interface explicitly persists an animation, preventing it from being automatically removed when it is replaced by another animation.

play

fun play()

The play() method of the Web Animations API's Animation Interface starts or resumes playing of an animation.

reverse

fun reverse()

The Animation.reverse() method of the Animation Interface reverses the playback direction, meaning the animation ends at its beginning.

updatePlaybackRate

fun updatePlaybackRate(playbackRate: Double)

The updatePlaybackRate() method of the Web Animations API's synchronizing its playback position.

when

fun <T : Event> when(type: EventType<T>, options: ObservableEventListenerOptions?): Observable<T>