Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / JavaScript

cancelAnimationFrame — annuler un rappel en attente

cancelAnimationFrame(handle) supprime un rappel en attente enregistré avec requestAnimationFrame(). Utilisez l’identifiant renvoyé dans le même contexte ; la méthode n’interrompt pas le code déjà en cours d’exécution.

Version : 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) annule un seul rappel en attente enregistré avec requestAnimationFrame(). Transmettez l’identifiant renvoyé handle, et non la fonction de rappel, et utilisez le même objet fournissant l’API. La méthode renvoie undefined.

Un identifiant qui ne figure plus parmi les rappels en attente ne change rien. L’annulation n’interrompt pas un rappel qui a commencé et n’annule pas non plus ses effets. Dans une boucle qui programme les images suivantes, enregistrez l’identifiant le plus récent et annulez celui-là ; un identifiant antérieur ne représente pas toute l’animation.

Il s’agit d’une API Web du HTML Living Standard, et non d’une fonction ECMAScript. Elle est prise en charge par les moteurs de navigateur actuels pour Window. Le standard la prévoit également dans les contextes DedicatedWorkerGlobalScope pris en charge ; un contexte non pris en charge déclenche NotSupportedError. La version de Node utilisée dans un dépôt ne permet pas d’établir la disponibilité de cette API.

L’exemple annule le premier rappel, puis vérifie le compteur dans un deuxième rappel. Le résultat attendu est calls: 0 et result: undefined. Cette vérification n’a lieu que lorsque le navigateur exécute le deuxième rappel.

Exemples

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

  const result = window.cancelAnimationFrame(handle);

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

Résultat

calls: 0
result: undefined

Le code affiché et le résultat déclaré ont été vérifiés dans un environnement isolé selon la méthode consignée dans la preuve de vérification de cette version exacte.

Sources