Window clearTimeout() Method
Example
Prevent the function set with the setTimeout() to execute:
var myVar;
function myFunction() {
myVar = setTimeout(function(){ alert("Hello"); }, 3000);
}
function myStopFunction() {
clearTimeout(myVar);
}
Try it yourself »
More "Try it Yourself" examples below.
Definition and Usage
The clearTimeout() method clears a timer set with the setTimeout() method.
The ID value returned by setTimeout() is used as the parameter for the clearTimeout() method.
Note: To be able to use the clearTimeout() method, you must use a global variable when creating the timeout method:
myVar = setTimeout("javascript function",milliseconds);
Then, if the function has not already been executed, you will be able to stop the execution by calling the clearTimeout() method.
Browser Support
The numbers in the table specify the first browser version that fully supports the method.
Method | |||||
---|---|---|---|---|---|
clearTimeout() | 1.0 | 4.0 | 1.0 | 1.0 | 4.0 |
Syntax
clearTimeout(id_of_settimeout)
Parameter Values
Parameter | Description |
---|---|
id_of_settimeout | Required. The ID value of the timer returned by the setTimeout() method |
Technical Details
Return Value: | No return value |
---|
More Examples
Example
The following example has a "Start count!" button to start a timer, an input field that will count forever, and a "Stop count!" button that will stop the timer:
<button onclick="startCount()">Start count!</button>
<input type="text"
id="txt">
<button onclick="stopCount()">Stop count!</button>
<script>
var c = 0;
var t;
var timer_is_on = 0;
function timedCount() {
document.getElementById("txt").value = c;
c =
c + 1;
t = setTimeout(function(){timedCount()}, 1000);
}
function
startCount() {
if (!timer_is_on) {
timer_is_on = 1;
timedCount();
}
}
function stopCount() {
clearTimeout(t);
timer_is_on = 0;
}
</script>
Try it yourself »
Related Pages
Window Object: setTimeout() Method
Window Object: setInterval() Method
Window Object: clearInterval() Method
Window Object