Window: cancelAnimationFrame() method
HTML DOM
HTML DOM
The window.cancelAnimationFrame() method cancels an
animation frame request previously scheduled through a call to
window.requestAnimationFrame().
Syntax
cancelAnimationFrame(requestID)
Parameters
requestID- : The ID value returned by the call to window.requestAnimationFrame() that requested the callback.
Return value
None (undefined).
Examples
const start = document.timeline.currentTime;
let myReq;
function step(timestamp) {
const progress = timestamp - start;
d.style.left = `${Math.min(progress / 10, 200)}px`;
if (progress < 2000) {
// it's important to update the requestId each time you're calling requestAnimationFrame
myReq = requestAnimationFrame(step);
}
}
myReq = requestAnimationFrame(step);
// the cancellation uses the last requestId
cancelAnimationFrame(myReq);
Specifications
Browser compatibility
See also
- Window.requestAnimationFrame()
- DedicatedWorkerGlobalScope.cancelAnimationFrame()