Baza znanjaIzpitno središče
SLSlovenščina
Izberi jezik13

CKTIS / JavaScript

cancelAnimationFrame — preklic čakajočega povratnega klica

cancelAnimationFrame(handle) odstrani čakajoči povratni klic, registriran z requestAnimationFrame(). Uporabite vrnjeni identifikator v istem kontekstu; metoda ne prekine kode, ki se že izvaja.

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

Sintaksa

window.cancelAnimationFrame(handle);

cancelAnimationFrame(handle) prekliče en čakajoči povratni klic, registriran z requestAnimationFrame(). Posredujte vrnjeni identifikator handle, ne funkcije povratnega klica, in uporabite isti objekt, ki zagotavlja API. Metoda vrne undefined.

Identifikator, ki ga ni več med čakajočimi povratnimi klici, ničesar ne spremeni. Preklic ne prekine povratnega klica, ki se je že začel, niti ne razveljavi njegovih učinkov. V zanki, ki načrtuje naslednje sličice, shranite najnovejši identifikator in prekličite prav tega; prejšnji identifikator ne predstavlja celotne animacije.

To je spletni API iz HTML Living Standard, ne funkcija ECMAScript. Trenutni brskalniški pogoni ga podpirajo za Window. Standard ga določa tudi v podprtih kontekstih DedicatedWorkerGlobalScope; nepodprt kontekst sproži NotSupportedError. Različica Node, uporabljena v repozitoriju, ne potrjuje razpoložljivosti tega API-ja.

Primer prekliče prvi povratni klic, nato pa v drugem preveri števec. Pričakovani izhod je calls: 0 in result: undefined. Preverjanje se izvede šele, ko brskalnik zažene drugi povratni klic.

Primeri

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

  const result = window.cancelAnimationFrame(handle);

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

Rezultat

calls: 0
result: undefined

Prikazana koda in navedeni rezultat sta bila preverjena v izoliranem okolju z metodo, zapisano v dokazilu o preverjanju te natančne različice.

Viri