Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / JavaScript

cancelAnimationFrame — anulowanie oczekującego wywołania

cancelAnimationFrame(handle) usuwa oczekujące wywołanie zarejestrowane przez requestAnimationFrame(). Użyj zwróconego identyfikatora w tym samym kontekście; metoda nie przerywa już wykonywanego kodu.

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

Składnia

window.cancelAnimationFrame(handle);

cancelAnimationFrame(handle) anuluje pojedyncze oczekujące wywołanie funkcji zarejestrowanej przez requestAnimationFrame(). Przekaż zwrócony identyfikator handle, a nie samą funkcję, i użyj tego samego obiektu udostępniającego API. Metoda zwraca undefined.

Identyfikator, którego nie ma już w zbiorze oczekujących wywołań, niczego nie zmienia. Anulowanie nie przerywa rozpoczętej funkcji ani nie cofa jej efektów. W pętli planującej kolejne klatki zapisuj najnowszy identyfikator i anuluj właśnie jego; wcześniejszy identyfikator nie oznacza całej animacji.

To Web API z HTML Living Standard, nie funkcja ECMAScript. Jest obsługiwane w aktualnych silnikach przeglądarek dla Window. Standard przewiduje je także w obsługiwanych kontekstach DedicatedWorkerGlobalScope; nieobsługiwany kontekst zgłasza NotSupportedError. Wersja Node używana w repozytorium nie potwierdza dostępności tego API.

Przykład anuluje pierwsze wywołanie, a drugie sprawdza licznik. Oczekiwany wynik to calls: 0 i result: undefined. Sprawdzenie nastąpi dopiero wtedy, gdy przeglądarka wykona drugie wywołanie.

Przykłady

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

  const result = window.cancelAnimationFrame(handle);

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

Wynik

calls: 0
result: undefined

Wyświetlony kod i zadeklarowany wynik zweryfikowano w odizolowanym środowisku metodą zapisaną w dowodzie weryfikacji tej dokładnej wersji.

Źródła