Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / JavaScript

cancelAnimationFrame — zrušení čekajícího callbacku

cancelAnimationFrame(handle) odstraní čekající callback zaregistrovaný pomocí requestAnimationFrame(). Použijte vrácený identifikátor ve stejném kontextu; metoda nepřeruší již spuštěný kód.

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

Syntaxe

window.cancelAnimationFrame(handle);

cancelAnimationFrame(handle) zruší jeden čekající callback zaregistrovaný pomocí requestAnimationFrame(). Předejte vrácený identifikátor handle, nikoli funkci callbacku, a použijte stejný objekt, který API poskytuje. Metoda vrací undefined.

Identifikátor, který už mezi čekajícími callbacky není, nic nezmění. Zrušení nepřeruší callback, který už začal, ani nevrátí zpět jeho účinky. Ve smyčce, která plánuje další snímky, ukládejte nejnovější identifikátor a zrušte právě ten; dřívější identifikátor nepředstavuje celou animaci.

Jde o Web API z HTML Living Standard, nikoli o funkci ECMAScript. Současné enginy prohlížečů ji podporují pro Window. Standard ji poskytuje také v podporovaných kontextech DedicatedWorkerGlobalScope; nepodporovaný kontext vyvolá NotSupportedError. Verze Node použitá v repozitáři nepotvrzuje dostupnost tohoto API.

Příklad zruší první callback a poté zkontroluje čítač ve druhém callbacku. Očekávaný výstup je calls: 0 a result: undefined. Kontrola proběhne až ve chvíli, kdy prohlížeč spustí druhý callback.

Příklady

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

  const result = window.cancelAnimationFrame(handle);

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

Výsledek

calls: 0
result: undefined

Zobrazený kód a uvedený výsledek byly ověřeny v izolovaném prostředí metodou zaznamenanou v dokladu o ověření této přesné verze.

Zdroje