WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

Animation.cancel(): eine Animation abbrechen

Animation.cancel() bricht eine Animation ab und entfernt ihre Wirkung auf das Element, statt sie auf dem aktuellen Frame anzuhalten.

Version: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Syntax

animation.cancel();

animation.cancel() ist eine Methode der Web Animations API und nicht von ECMAScript selbst. Sie nimmt keine Argumente entgegen und gibt undefined zurück. Sie setzt playState auf idle sowie currentTime und startTime auf null.

Sie entfernt die Wirkung der Animation, auch bei fill: 'both'; ein Frame wird nicht in den Styles gespeichert. Anders als pause() behält sie die aktuelle Position nicht bei; anders als finish() springt sie nicht zum Ende. Das Objekt kann mit play() erneut gestartet werden.

Ist die Animation nicht im Zustand idle, ersetzt die Methode das bisherige finished-Promise durch ein neues und stellt ein cancel-Ereignis in die Warteschlange. Das bisherige Promise wird nur dann mit AbortError abgelehnt, wenn es noch aussteht. Wurde es bereits erfüllt, bleibt es erfüllt. Füge die Fehlerbehandlung vor dem Abbrechen hinzu. Das Beispiel erfordert einen Browser; Node 24 belegt nicht, dass diese API unterstützt wird.

Beispiele

(async () => {
  const box = document.createElement('div');
  document.body.append(box);
  const animation = box.animate(
    [{ opacity: 0 }, { opacity: 1 }],
    { duration: 1000, fill: 'both' }
  );
  const outcome = animation.finished.catch(error => error.name);
  animation.cancel();
  console.log(animation.playState);
  console.log(animation.currentTime === null);
  console.log(animation.startTime === null);
  console.log(await outcome);
  box.remove();
})();

Ergebnis

idle
true
true
AbortError

Der angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.

Quellen