WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / JavaScript

cancelAnimationFrame — einen ausstehenden Callback abbrechen

cancelAnimationFrame(handle) entfernt einen ausstehenden Callback, der mit requestAnimationFrame() registriert wurde. Verwende die zurückgegebene Kennung im selben Kontext; die Methode unterbricht keinen bereits laufenden Code.

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

window.cancelAnimationFrame(handle);

cancelAnimationFrame(handle) bricht einen einzelnen ausstehenden Callback ab, der mit requestAnimationFrame() registriert wurde. Übergib die zurückgegebene Kennung handle, nicht die Callback-Funktion, und verwende dasselbe API-Anbieterobjekt. Die Methode gibt undefined zurück.

Eine Kennung, die nicht mehr zu den ausstehenden Callbacks gehört, bewirkt nichts. Das Abbrechen unterbricht weder einen bereits gestarteten Callback noch macht es dessen Auswirkungen rückgängig. Speichere in einer Schleife, die weitere Frames plant, die neueste Kennung und brich genau diese ab; eine frühere Kennung steht nicht für die gesamte Animation.

Dies ist eine Web API aus dem HTML Living Standard, keine ECMAScript-Funktion. Sie wird von aktuellen Browser-Engines für Window unterstützt. Der Standard sieht sie auch in unterstützten DedicatedWorkerGlobalScope-Kontexten vor; in einem nicht unterstützten Kontext wird NotSupportedError ausgelöst. Die in einem Repository verwendete Node-Version belegt nicht, dass diese API verfügbar ist.

Das Beispiel bricht den ersten Callback ab und prüft dann den Zähler in einem zweiten Callback. Die erwartete Ausgabe ist calls: 0 und result: undefined. Diese Prüfung erfolgt erst, wenn der Browser den zweiten Callback ausführt.

Beispiele

(() => {
  let calls = 0;
  const handle = window.requestAnimationFrame(() => {
    calls += 1;
  });

  const result = window.cancelAnimationFrame(handle);

  window.requestAnimationFrame(() => {
    console.log(`calls: ${calls}`);
    console.log(`result: ${result}`);
  });
})();

Ergebnis

calls: 0
result: undefined

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