Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / JavaScript

Animation.cancel(): annullare un’animazione

Animation.cancel() interrompe un’animazione e ne rimuove l’effetto sull’elemento, invece di mantenerla sul fotogramma corrente.

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

Sintassi

animation.cancel();

animation.cancel() è un metodo di Web Animations, non di ECMAScript in sé. Non accetta argomenti e restituisce undefined. Imposta playState su idle e currentTime e startTime su null.

Rimuove l’effetto dell’animazione, anche con fill: 'both'; non salva un fotogramma negli stili. A differenza di pause(), non conserva la posizione corrente; a differenza di finish(), non avanza fino alla fine. L’oggetto può essere riavviato con play().

Se l’animazione non è nello stato idle, il metodo sostituisce la promessa finished esistente con una nuova e accoda un evento cancel. La promessa precedente viene rifiutata con AbortError solo se è ancora in attesa. Se è già stata soddisfatta, rimane tale. Aggiungi la gestione del rifiuto prima di annullare. L’esempio richiede un browser; Node 24 non dimostra il supporto per questa API.

Esempi

(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();
})();

Risultato

idle
true
true
AbortError

Il codice mostrato e il risultato dichiarato sono stati verificati in un ambiente isolato con il metodo registrato nella prova di verifica di questa versione esatta.

Fonti