Cette page a été traduite à partir de l'anglais par la communauté. Vous pouvez contribuer en rejoignant la communauté francophone sur MDN Web Docs.

Window : méthode cancelAnimationFrame()

Baseline Widely available

Cette fonctionnalité est bien établie et fonctionne sur de nombreux appareils et versions de navigateurs. Elle est disponible sur tous les navigateurs depuis juillet 2015.

La méthode cancelAnimationFrame() de l'interface Window annule une demande de trame d'animation précédemment programmée avec un appel à window.requestAnimationFrame().

Syntaxe

js
cancelAnimationFrame(requestID)

Paramètres

requestID

L'identifiant retourné par l'appel à window.requestAnimationFrame() qui a généré la fonction de rappel.

Valeur de retour

Aucune (undefined).

Exemples

js
const debut = document.timeline.currentTime;

let maRequete;

function etape(timestamp) {
  const progres = timestamp - debut;
  d.style.left = `${Math.min(progres / 10, 200)}px`;
  if (progres < 2000) {
    // c'est important de mettre à jour l'identifiant de la requête à chaque appel de requestAnimationFrame
    maRequete = requestAnimationFrame(etape);
  }
}
maRequete = requestAnimationFrame(etape);
// l'annulation utilise le dernier identifiant de requête
cancelAnimationFrame(maRequete);

Spécifications

Specification
HTML
# animationframeprovider-cancelanimationframe

Compatibilité des navigateurs

Voir aussi