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

CKTIS / JavaScript

Animation.cancel() : annuler une animation

Animation.cancel() interrompt une animation et supprime son effet sur l’élément, au lieu de la figer sur l’image actuelle.

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

animation.cancel();

animation.cancel() est une méthode de Web Animations, et non du langage ECMAScript lui-même. Elle ne prend aucun argument et renvoie undefined. Elle définit playState sur idle, et currentTime ainsi que startTime sur null.

Elle supprime l’effet de l’animation, y compris avec fill: 'both' ; elle n’enregistre pas une image dans les styles. Contrairement à pause(), elle ne conserve pas la position actuelle ; contrairement à finish(), elle ne va pas jusqu’à la fin. L’objet peut être relancé avec play().

Si l’animation n’est pas dans l’état idle, la méthode remplace la promesse finished existante et met un événement cancel en file d’attente. L’ancienne promesse n’est rejetée avec AbortError que si elle est encore en attente. Si elle est déjà tenue, elle le reste. Ajoutez la gestion du rejet avant l’annulation. L’exemple nécessite un navigateur ; Node 24 ne permet pas d’établir la prise en charge de cette API.

Exemples

(async () => {
  const box = document.createElement('div');
  document.body.append(box);
  const animation = box.animate(
    [{ opacity: 0 }, { opacity: 1 }],
    { duration: 1000, fill: 'both' }
  );
  const outcome = animation.finished.catch(error => error.name);
  animation.cancel();
  console.log(animation.playState);
  console.log(animation.currentTime === null);
  console.log(animation.startTime === null);
  console.log(await outcome);
  box.remove();
})();

Résultat

idle
true
true
AbortError

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