tinymce.util.Delay
Utility class for working with delayed actions like setTimeout.
Methods
name | summary | defined by |
---|---|---|
clearInterval() | Clears an interval timer so it won't execute. | tinymce.util.Delay |
clearTimeout() | Clears an timeout timer so it won't execute. | tinymce.util.Delay |
debounce() | Creates debounced callback function that only gets executed once within the specified time. | tinymce.util.Delay |
requestAnimationFrame() | Requests an animation frame and fallbacks to a timeout on older browsers. | tinymce.util.Delay |
setEditorInterval() | Sets an interval timer it's similar to setInterval except that it checks if the editor instance is still alive when the callback gets executed. | tinymce.util.Delay |
setEditorTimeout() | Sets an editor timeout it's similar to setTimeout except that it checks if the editor instance is still alive when the callback gets executed. | tinymce.util.Delay |
setInterval() | Sets an interval timer in ms and executes the specified callback at every interval of that time. | tinymce.util.Delay |
setTimeout() | Sets a timer in ms and executes the specified callback when the timer runs out. | tinymce.util.Delay |
Methods
clearInterval
Clears an interval timer so it won't execute.
Parameters
- Interval (Number) - timer id number.
clearTimeout
Clears an timeout timer so it won't execute.
Parameters
- Timeout (Number) - timer id number.
debounce
Creates debounced callback function that only gets executed once within the specified time.
Parameters
- callback (function) - Callback to execute when timer finishes.
- time (Number) - Optional time to wait before the callback is executed, defaults to 0.
Return value
- Function - debounced function callback.
requestAnimationFrame
Requests an animation frame and fallbacks to a timeout on older browsers.
Parameters
- callback (function) - Callback to execute when a new frame is available.
- element (DOMElement) - Optional element to scope it to.
setEditorInterval
Sets an interval timer it's similar to setInterval except that it checks if the editor instance is still alive when the callback gets executed.
Parameters
- callback (function) - Callback to execute when interval time runs out.
- time (Number) - Optional time to wait before the callback is executed, defaults to 0.
Return value
- Number - Timeout id number.
setEditorTimeout
Sets an editor timeout it's similar to setTimeout except that it checks if the editor instance is still alive when the callback gets executed.
Parameters
- editor (tinymce.Editor) - Editor instance to check the removed state on.
- callback (function) - Callback to execute when timer runs out.
- time (Number) - Optional time to wait before the callback is executed, defaults to 0.
Return value
- Number - Timeout id number.
setInterval
Sets an interval timer in ms and executes the specified callback at every interval of that time.
Parameters
- callback (function) - Callback to execute when interval time runs out.
- time (Number) - Optional time to wait before the callback is executed, defaults to 0.
Return value
- Number - Timeout id number.
setTimeout
Sets a timer in ms and executes the specified callback when the timer runs out.
Parameters
- callback (function) - Callback to execute when timer runs out.
- time (Number) - Optional time to wait before the callback is executed, defaults to 0.
Return value
- Number - Timeout id number.
Can't find what you're looking for? Let us know.
Except as otherwise noted, the content of this page is licensed under the Creative Commons BY-NC-SA 3.0 License, and code samples are licensed under the Apache 2.0 License.