{ "id": "api/animations/AnimationPlayer", "title": "AnimationPlayer", "contents": "\n\n
\n
\n
\n \n API > @angular/animations\n
\n \n
\n \n
\n

AnimationPlayerlink

\n \n \n \n \n \n
\n \n \n\n
\n \n
\n

Provides programmatic control of a reusable animation sequence,\nbuilt using the build() method of AnimationBuilder. The build() method\nreturns a factory, whose create() method instantiates and initializes this interface.

\n\n \n
\n \n \n
\n\ninterface AnimationPlayer {\n parentPlayer: AnimationPlayer | null\n totalTime: number\n beforeDestroy?: () => any\n onDone(fn: () => void): void\n onStart(fn: () => void): void\n onDestroy(fn: () => void): void\n init(): void\n hasStarted(): boolean\n play(): void\n pause(): void\n restart(): void\n finish(): void\n destroy(): void\n reset(): void\n setPosition(position: any): void\n getPosition(): number\n}\n\n\n \n \n\n\n \n \n
\n

Class implementationslink

\n \n\n\n\n\n
\n \n\n
\n\n \n
\n

See alsolink

\n \n
\n\n\n \n \n \n
\n

Propertieslink

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
PropertyDescription
\n \n parentPlayer: AnimationPlayer | null\n \n \n

The parent of this player, if any.

\n\n \n
\n \n totalTime: number\n Read-Only\n \n

The total run time of the animation, in milliseconds.

\n\n \n
\n \n beforeDestroy?: () => any\n \n \n

Provides a callback to invoke before the animation is destroyed.

\n\n \n
\n
\n \n\n
\n

Methodslink

\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n onDone()\n \n link

\n \n
\n
\n

Provides a callback to invoke when the animation finishes.

\n\n

See also:

\n
    \n \n
  • finish()

    \n
  • \n
\n \n
\n
\n \n\n onDone(fn: () => void): void\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n fn\n () => void\n

The callback function.

\n\n
\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n onStart()\n \n link

\n \n
\n
\n

Provides a callback to invoke when the animation starts.

\n\n

See also:

\n
    \n \n
  • run()

    \n
  • \n
\n \n
\n
\n \n\n onStart(fn: () => void): void\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n fn\n () => void\n

The callback function.

\n\n
\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n onDestroy()\n \n link

\n \n
\n
\n

Provides a callback to invoke after the animation is destroyed.

\n\n

See also:

\n
    \n \n
  • destroy()

    \n
  • \n
  • beforeDestroy()

    \n
  • \n
\n \n
\n
\n \n\n onDestroy(fn: () => void): void\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n fn\n () => void\n

The callback function.

\n\n
\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n init()\n \n link

\n \n
\n
\n

Initializes the animation.

\n\n
\n
\n \n\n init(): void\n\n \n\n
Parameters
\n

There are no parameters.

\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n hasStarted()\n \n link

\n \n
\n
\n

Reports whether the animation has started.

\n\n
\n
\n \n\n hasStarted(): boolean\n\n \n\n
Parameters
\n

There are no parameters.

\n\n \n
Returns
\n

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

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n play()\n \n link

\n \n
\n
\n

Runs the animation, invoking the onStart() callback.

\n\n
\n
\n \n\n play(): void\n\n \n\n
Parameters
\n

There are no parameters.

\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n pause()\n \n link

\n \n
\n
\n

Pauses the animation.

\n\n
\n
\n \n\n pause(): void\n\n \n\n
Parameters
\n

There are no parameters.

\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n restart()\n \n link

\n \n
\n
\n

Restarts the paused animation.

\n\n
\n
\n \n\n restart(): void\n\n \n\n
Parameters
\n

There are no parameters.

\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n finish()\n \n link

\n \n
\n
\n

Ends the animation, invoking the onDone() callback.

\n\n
\n
\n \n\n finish(): void\n\n \n\n
Parameters
\n

There are no parameters.

\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n destroy()\n \n link

\n \n
\n
\n

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

\n\n
\n
\n \n\n destroy(): void\n\n \n\n
Parameters
\n

There are no parameters.

\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n reset()\n \n link

\n \n
\n
\n

Resets the animation to its initial state.

\n\n
\n
\n \n\n reset(): void\n\n \n\n
Parameters
\n

There are no parameters.

\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n setPosition()\n \n link

\n \n
\n
\n

Sets the position of the animation.

\n\n
\n
\n \n\n setPosition(position: any): void\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n
\n \n position\n any\n

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

\n\n
\n\n \n
Returns
\n

void

\n\n \n\n\n \n\n \n
\n
\n\n \n \n\n \n \n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n getPosition()\n \n link

\n \n
\n
\n

Reports the current position of the animation.

\n\n
\n
\n \n\n getPosition(): number\n\n \n\n
Parameters
\n

There are no parameters.

\n\n \n
Returns
\n

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

\n\n \n\n\n \n\n \n
\n
\n\n \n
\n\n\n \n\n\n
\n
\n\n\n" }