In This Topic ▼

cancelAnimationFrame Method

Summary

Cancels an animation frame, with a fallback for older browsers.

Syntax

TypeScript

JavaScript

cancelAnimationFrame = function( 
   id 
)

static cancelAnimationFrame( 
   id: number 
): void;

The id received from RequestAnimationFrame.

Remarks

If SupportsAnimationFrame is true, RequestAnimationFrame and CancelAnimationFrame will be set to the browser-prefixed (if necessary) versions of window.requestAnimationFrame and window.cancelAnimationFrame, respectively.

If SupportsAnimationFrame is false, RequestAnimationFrame and CancelAnimationFrame will be set to window.setTimeout and window.clearTimeout, respectively.

LTHelper.CancelAnimationFrame should only be used with an id received from LTHelper.RequestAnimationFrame.

Requirements

Help Version 23.0.2024.2.29