interface
Provides programmatic control of a reusable animation sequence, built using the build()
method of AnimationBuilder
. The build()
method returns a factory, whose create()
method instantiates and initializes this interface.
interface AnimationPlayer { parentPlayer: AnimationPlayer | null totalTime: number beforeDestroy?: () => any onDone(fn: () => void): void onStart(fn: () => void): void onDestroy(fn: () => void): void init(): void hasStarted(): boolean play(): void pause(): void restart(): void finish(): void destroy(): void reset(): void setPosition(position: any): void getPosition(): number }
Property | Description |
---|---|
parentPlayer: AnimationPlayer | null | The parent of this player, if any. |
totalTime: number | Read-Only The total run time of the animation, in milliseconds. |
beforeDestroy?: () => any | Provides a callback to invoke before the animation is destroyed. |
onDone() | |||
---|---|---|---|
Provides a callback to invoke when the animation finishes. See also:
| |||
|
fn | () => void | The callback function. |
void
onStart() | |||
---|---|---|---|
Provides a callback to invoke when the animation starts. See also:
| |||
|
fn | () => void | The callback function. |
void
onDestroy() | |||
---|---|---|---|
Provides a callback to invoke after the animation is destroyed. See also:
| |||
|
fn | () => void | The callback function. |
void
init() |
---|
Initializes the animation. |
|
hasStarted() |
---|
Reports whether the animation has started. |
|
play() |
---|
Runs the animation, invoking the |
|
pause() |
---|
Pauses the animation. |
|
restart() |
---|
Restarts the paused animation. |
|
finish() |
---|
Ends the animation, invoking the |
|
destroy() |
---|
Destroys the animation, after invoking the |
|
reset() |
---|
Resets the animation to its initial state. |
|
setPosition() | |||
---|---|---|---|
Sets the position of the animation. | |||
|
position | any | A 0-based offset into the duration, in milliseconds. |
void
getPosition() |
---|
Reports the current position of the animation. |
|
© 2010–2021 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://v12.angular.io/api/animations/AnimationPlayer