CKTIS / JavaScript
cancelAnimationFrame — een wachtende callback annuleren
cancelAnimationFrame(handle) verwijdert een wachtende callback die met requestAnimationFrame() is geregistreerd. Gebruik de teruggegeven identifier in dezelfde context; de methode onderbreekt geen code die al wordt uitgevoerd.
Versie: 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) annuleert één wachtende callback die met requestAnimationFrame() is geregistreerd. Geef de teruggegeven identifier handle door, niet de callbackfunctie, en gebruik hetzelfde object dat de API aanbiedt. De methode retourneert undefined.
Een identifier die niet meer tussen de wachtende callbacks staat, verandert niets. Annuleren onderbreekt geen callback die al is begonnen en maakt de effecten ervan niet ongedaan. Sla in een lus die volgende frames plant de nieuwste identifier op en annuleer die; een eerdere identifier staat niet voor de hele animatie.
Dit is een Web API uit de HTML Living Standard, geen ECMAScript-functie. De API wordt door huidige browserengines ondersteund voor Window. De standaard voorziet er ook in ondersteunde DedicatedWorkerGlobalScope-contexten in; een niet-ondersteunde context veroorzaakt NotSupportedError. De Node-versie die in een repository wordt gebruikt, toont niet aan dat deze API beschikbaar is.
Het voorbeeld annuleert de eerste callback en controleert daarna de teller in een tweede callback. De verwachte uitvoer is calls: 0 en result: undefined. Die controle vindt pas plaats wanneer de browser de tweede callback uitvoert.
Voorbeelden
(() => {
let calls = 0;
const handle = window.requestAnimationFrame(() => {
calls += 1;
});
const result = window.cancelAnimationFrame(handle);
window.requestAnimationFrame(() => {
console.log(`calls: ${calls}`);
console.log(`result: ${result}`);
});
})();Resultaat
calls: 0 result: undefined
De getoonde code en het opgegeven resultaat zijn in een geïsoleerde omgeving geverifieerd met de methode die in het verificatiebewijs voor exact deze versie is vastgelegd.