Hype Animation Frame
Document Methods

4min
HypeAnimationFrame.version
JS
// property with the current version of the extension
HypeAnimationFrame.version;
// property with the current version of the extension
HypeAnimationFrame.version;
﻿
Description
The value of the version property is a string containing the current version of the extension
﻿
HypeAnimationFrame.stopAllAnimationFrames
JS
// stop all running animation frames across the page
HypeAnimationFrame.stopAllAnimationFrames();
// stop all running animation frames across the page
HypeAnimationFrame.stopAllAnimationFrames();
﻿
Description
This method stops all running Hype Animation Frames across all Hype documents on the page.
﻿
 HypeAnimationFrame.stopAnimationFrameByHypeDocumentId
JS
// stop running animation frame by id 'myTicker' in the Hype document named 'index'
HypeAnimationFrame.stopAnimationFrameByHypeDocumentId('index', 'myTicker');

// stop running animation frame by function reference myCallback in the Hype document named 'index'
HypeAnimationFrame.stopAnimationFrameByHypeDocumentId('index', myCallback);
// stop running animation frame by id 'myTicker' in the Hype document named 'index'
HypeAnimationFrame.stopAnimationFrameByHypeDocumentId('index', 'myTicker');

// stop running animation frame by function reference myCallback in the Hype document named 'index'
HypeAnimationFrame.stopAnimationFrameByHypeDocumentId('index', myCallback);
﻿
Parameter
documentId
This parameter must be a string determining the document id of your Hype document
animationFrameId
The id to of the animation frame you want to stop. This id was set while creating the animation frame and if none was given defaults to the callback function as a reference.
Description
This method stops a specific Hype Animation Frame for a specific Hype document on the page.
﻿
 HypeAnimationFrame.stopAllAnimationFramesByHypeDocumentId
JS
// stop all running animation frames in the Hype document named 'index'
HypeAnimationFrame.stopAnimationFrameByHypeDocumentId('index');
// stop all running animation frames in the Hype document named 'index'
HypeAnimationFrame.stopAnimationFrameByHypeDocumentId('index');
﻿
Parameter
documentId
This parameter must be a string determining the document id of your Hype document
Description
This method stops all running Hype Animation Frames for a specific Hype document on the page.
Example
Extension Methods