Help Angular by taking a 1 minute survey!Go to surveyHome
API > @angular/animations

AnimationPlayer

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.

      
      
  1. interface AnimationPlayer {
  2.   parentPlayer: AnimationPlayer | null
  3.   totalTime: number
  4.   beforeDestroy?: () => any
  5.   onDone(fn: () => void): void
  6.   onStart(fn: () => void): void
  7.   onDestroy(fn: () => void): void
  8.   init(): void
  9.   hasStarted(): boolean
  10.   play(): void
  11.   pause(): void
  12.   restart(): void
  13.   finish(): void
  14.   destroy(): void
  15.   reset(): void
  16.   setPosition(position: any): void
  17.   getPosition(): number
  18. }

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
      
      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
      
      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:
onDestroy(fn: () => void): void
      
      onDestroy(fn: () => void): void
Parameters
fn () => void

The callback function.
Returns

void

init()

Initializes the animation.
init(): void
      
      init(): void
Parameters

There are no parameters.

Returns

void

hasStarted()

Reports whether the animation has started.
hasStarted(): boolean
      
      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
      
      play(): void
Parameters

There are no parameters.

Returns

void

pause()

Pauses the animation.
pause(): void
      
      pause(): void
Parameters

There are no parameters.

Returns

void

restart()

Restarts the paused animation.
restart(): void
      
      restart(): void
Parameters

There are no parameters.

Returns

void

finish()

Ends the animation, invoking the onDone() callback.
finish(): void
      
      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
      
      destroy(): void
Parameters

There are no parameters.

Returns

void

reset()

Resets the animation to its initial state.
reset(): void
      
      reset(): void
Parameters

There are no parameters.

Returns

void

setPosition()

Sets the position of the animation.
setPosition(position: any): void
      
      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
      
      getPosition(): number
Parameters

There are no parameters.

Returns

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