Docs4dev
Docs
angular / 12 / api / animations / animationplayer.html

AnimationPlayer

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
}

Class implementations

See also

Properties

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.

Methods

onDone()

Provides a callback to invoke when the animation finishes.

See also:

  • finish()

onDone(fn: () => void): void

Parameters
fn () => void

The callback function.
Returns

void
onStart()

Provides a callback to invoke when the animation starts.

See also:

  • run()

onStart(fn: () => void): void

Parameters
fn () => void

The callback function.
Returns

void
onDestroy()

Provides a callback to invoke after the animation is destroyed.

See also:

  • destroy()

  • beforeDestroy()

onDestroy(fn: () => void): void

Parameters
fn () => void

The callback function.
Returns

void
init()

Initializes the animation.

init(): void

Parameters

There are no parameters.

Returns

void
hasStarted()

Reports whether the animation has started.

hasStarted(): boolean

Parameters

There are no parameters.

Returns

boolean: True if the animation has started, false otherwise.
play()

Runs the animation, invoking the onStart() callback.

play(): void

Parameters

There are no parameters.

Returns

void
pause()

Pauses the animation.

pause(): void

Parameters

There are no parameters.

Returns

void
restart()

Restarts the paused animation.

restart(): void

Parameters

There are no parameters.

Returns

void
finish()

Ends the animation, invoking the onDone() callback.

finish(): void

Parameters

There are no parameters.

Returns

void
destroy()

Destroys the animation, after invoking the beforeDestroy() callback. Calls the onDestroy() callback when destruction is completed.

destroy(): void

Parameters

There are no parameters.

Returns

void
reset()

Resets the animation to its initial state.

reset(): void

Parameters

There are no parameters.

Returns

void
setPosition()

Sets the position of the animation.

setPosition(position: any): void

Parameters
position any

A 0-based offset into the duration, in milliseconds.
Returns

void
getPosition()

Reports the current position of the animation.

getPosition(): number

Parameters

There are no parameters.

Returns

number: A 0-based offset into the duration, in milliseconds.

© 2010–2021 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://v12.angular.io/api/animations/AnimationPlayer