window.cancelAnimationFrame()

La méthode window.cancelAnimationFrame() met fin à une animation précédement configurée par un appel à window.requestAnimationFrame().

Syntaxe

window.cancelAnimationFrame(requestID);

Paramètres

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

Exemples

var requestAnimationFrame = window.requestAnimationFrame || window.mozRequestAnimationFrame ||
                            window.webkitRequestAnimationFrame || window.msRequestAnimationFrame;

var cancelAnimationFrame = window.cancelAnimationFrame || window.mozCancelAnimationFrame;

var start = window.mozAnimationStartTime;  // Seulement supporté par Firefox. Les autre navigateurs peuvent utiliser quelque chose comme Date.now()..

var myReq; // Déclarer la variable globalement avant de lancer l'animation

function step(timestamp) {
  var progress = timestamp - start;
  d.style.left = Math.min(progress / 10, 200) + 'px';
  if (progress < 2000) {
    // Ne pas oublier de récupérer l'identifiant à chaque appel de la fonction
    myReq = requestAnimationFrame(step);
  }
}
myReq = requestAnimationFrame(step);
// L'annulation utilise le dernier identifiant
cancelAnimationFrame(myReq);

Spécifications

Spécification
Timing control for script-based animations: cancelAnimationFrameWD

Compatibilité des navigateurs

BCD tables only load in the browser

Voir aussi