Interface IAnimationController

Animation Controller interface

Remarks

This interface is used to control animations. It provides methods to start, stop, pause, and restore animations. It also provides a way to wait for the animation to stop.

This interface extends the IEventEmitter interface, which means you can listen to these events emitted by the animation controller:

  • animating - Emitted when the animation finishes it's delay phase and starts animating.
  • stopped - Emitted when the animation stops either by calling the stop() method or when the animation finishes naturally.

Hierarchy

  • IEventEmitter
    • IAnimationController

Properties

Current state of the animation

Remarks

  • stopped - The animation is currently stopped (at the beggining or end of the animation)
  • running - The animation is currently running
  • paused - The animation is currently paused

Methods

  • Type Parameters

    • K extends string | number

    Parameters

    • event: Extract<K, string>
    • data: unknown

    Returns void

  • Type Parameters

    • K extends string | number

    Parameters

    • event: Extract<K, string>
    • listener: {
          [s: string]: ((target, data) => void);
      }[K]

    Returns void

  • Type Parameters

    • K extends string | number

    Parameters

    • event: Extract<K, string>
    • listener: {
          [s: string]: ((target, data) => void);
      }[K]

    Returns void

  • Type Parameters

    • K extends string | number

    Parameters

    • event: Extract<K, string>
    • listener: {
          [s: string]: ((target, data) => void);
      }[K]

    Returns void

  • Promise that resolves when the last active animation is stopped (including when the animation finishes naturally).

    Returns Promise<void>

    Remarks

    The Promise returned by this method is reset every time the animation enters a new start/stop cycle. This means you must call start() before calling this method if you want to wait for the animation to stop.

    This method always returns a resolved promise if the animation is currently in a stopped state.

Generated using TypeDoc