Window: Methode cancelAnimationFrame()

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

Die Methode window.cancelAnimationFrame() storniert eine Animationsrahmenanfrage, die zuvor durch einen Aufruf von window.requestAnimationFrame() geplant wurde.

Syntax

js
cancelAnimationFrame(requestID)

Parameter

requestID

Der ID-Wert, der durch den Aufruf von window.requestAnimationFrame() zurückgegeben wurde, der den Rückruf angefordert hat.

Rückgabewert

Keiner (undefined).

Beispiele

js
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);

Spezifikationen

Specification
HTML
# animationframeprovider-cancelanimationframe

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch