AnimationPlayer — Angular

Предоставляет программное управление повторно используемой последовательностью анимации, созданной с помощью метода AnimationBuilder.build(), который возвращает AnimationFactory; его метод create() создает экземпляр этого интерфейса и инициализирует его.

Предупреждение об устаревании

Вместо этого используйте animate.enter или animate.leave. Планируется удалить в версии 23

API

interface AnimationPlayer {
  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: number): void;
  getPosition(): number;
  parentPlayer: AnimationPlayer | null;
  readonly totalTime: number;
  beforeDestroy?: (() => any) | undefined;
}

onDone

void

Предоставляет функцию обратного вызова, которая вызывается по завершении анимации.

@paramfn() => void

Функция обратного вызова.

@returnsvoid

onStart

void

Предоставляет функцию обратного вызова, которая вызывается при запуске анимации.

@paramfn() => void

Функция обратного вызова.

@returnsvoid

onDestroy

void

Предоставляет функцию обратного вызова, которая вызывается после уничтожения анимации.

@paramfn() => void

Функция обратного вызова.

@returnsvoid

init

void

Инициализирует анимацию.

@returnsvoid

hasStarted

boolean

Сообщает, запущена ли анимация.

@returnsboolean

Значение true, если анимация запущена, и false в противном случае.

play

void

Запускает анимацию, вызывая функцию обратного вызова onStart().

@returnsvoid

pause

void

Приостанавливает анимацию.

@returnsvoid

restart

void

Перезапускает приостановленную анимацию.

@returnsvoid

finish

void

Завершает анимацию, вызывая функцию обратного вызова onDone().

@returnsvoid

destroy

void

Уничтожает анимацию после вызова функции обратного вызова beforeDestroy(). По завершении уничтожения вызывает функцию обратного вызова onDestroy().

@returnsvoid

reset

void

Сбрасывает анимацию в исходное состояние.

@returnsvoid

setPosition

void

Задает позицию анимации.

@parampositionnumber

Дробное значение, обозначающее ход выполнения анимации.

@returnsvoid

getPosition

number

Сообщает текущую позицию анимации.

@returnsnumber

Дробное значение, обозначающее ход выполнения анимации.

parentPlayer

AnimationPlayer | null

Родитель этого проигрывателя, если он есть.

totalTime

number

Общая продолжительность анимации в миллисекундах.

beforeDestroy

(() => any) | undefined

Предоставляет функцию обратного вызова, которая вызывается перед уничтожением анимации.