Components Interactions Examples Tutorials API FAQ
Options
Menu

An Animator with easing and configurable durations and delays.

Hierarchy

  • Easing

Implements

Index

Constructors

constructor

Properties

Private _easingMode

_easingMode: any

Private _maxTotalDuration

_maxTotalDuration: any

Private _startDelay

_startDelay: any

Private _stepDelay

_stepDelay: any

Private _stepDuration

_stepDuration: any

Static Private _DEFAULT_EASING_MODE

_DEFAULT_EASING_MODE: any

The default easing of the animation

Static Private _DEFAULT_ITERATIVE_DELAY_MILLISECONDS

_DEFAULT_ITERATIVE_DELAY_MILLISECONDS: any

The default maximum start delay between each step of an animation

Static Private _DEFAULT_MAX_TOTAL_DURATION_MILLISECONDS

_DEFAULT_MAX_TOTAL_DURATION_MILLISECONDS: any

The default maximum total animation duration

Static Private _DEFAULT_START_DELAY_MILLISECONDS

_DEFAULT_START_DELAY_MILLISECONDS: any

The default starting delay of the animation in milliseconds

Static Private _DEFAULT_STEP_DURATION_MILLISECONDS

_DEFAULT_STEP_DURATION_MILLISECONDS: any

The default duration of one animation step in milliseconds

Methods

Private _getAdjustedIterativeDelay

  • _getAdjustedIterativeDelay(numberOfSteps: any): any
  • Adjust the iterative delay, such that it takes into account the maxTotalDuration constraint

    Parameters

    • numberOfSteps: any

    Returns any

animate

easingMode

  • easingMode(): string
  • easingMode(easingMode: string)
  • Gets the current easing mode of the animation.

    Returns string

    the current easing mode.

  • Sets the easing mode of the animation.

    Parameters

    • easingMode: string

      The desired easing mode.

maxTotalDuration

  • maxTotalDuration(): number
  • maxTotalDuration(maxTotalDuration: number)
  • Gets the maximum total animation duration constraint in milliseconds.

    If the animation time would exceed the specified time, the duration of each step and the delay between each step will be reduced until the animation fits within the specified time.

    Returns number

    The current maximum total animation duration.

  • Sets the maximum total animation duration constraint in miliseconds.

    If the animation time would exceed the specified time, the duration of each step and the delay between each step will be reduced until the animation fits within the specified time.

    Parameters

    • maxTotalDuration: number

      The maximum total animation duration in milliseconds.

startDelay

  • startDelay(): number
  • startDelay(startDelay: number)
  • Gets the start delay of the animation in milliseconds.

    Returns number

    The current start delay.

  • Sets the start delay of the animation in milliseconds.

    Parameters

    • startDelay: number

      The start delay in milliseconds.

stepDelay

  • stepDelay(): number
  • stepDelay(stepDelay: number)
  • Gets the maximum start delay between animation steps in milliseconds.

    Returns number

    The current maximum iterative delay.

  • Sets the maximum start delay between animation steps in milliseconds.

    Parameters

    • stepDelay: number

      The maximum iterative delay in milliseconds.

stepDuration

  • stepDuration(): number
  • stepDuration(stepDuration: number)
  • Gets the duration of one animation step in milliseconds.

    Returns number

    The current duration.

  • Sets the duration of one animation step in milliseconds.

    Parameters

    • stepDuration: number

      The duration in milliseconds.

totalTime

  • totalTime(numberOfSteps: number): number

Generated using TypeDoc