.clearTimeout()
setTimeout()を使用して設定された遅延処理を取り消します。
文法
window.clearTimeout(timeoutID);
引数 | 説明 |
---|---|
timeoutID |
timeoutID には、取り消したいtimeoutのIDを指定します。
このIDはsetTimeout()の戻り値として返されます。
|
例
下記のWebページ内のスクリプトを実行し、一度ページをクリックしてみてください。 1秒後、アラートダイアログでメッセージを目にすることになるでしょう。 もし、1秒が経過するまでに続けてクリックが行われると、 そのポップアップが表示されることはありません。
var alarm = {
remind: function(aMessage) {
alert(aMessage);
delete this.timeoutID;
},
setup: function() {
this.cancel();
var self = this;
this.timeoutID = window.setTimeout(function(msg) {self.remind(msg);}, 1000, "Wake up!");
},
cancel: function() {
if(typeof this.timeoutID == "number") {
window.clearTimeout(this.timeoutID);
delete this.timeoutID;
}
}
};
window.onclick = function() { alarm.setup() };
注意事項
不正なIDをclearTimeout
に渡した場合は、何も起こりません。(例外もスローされません。)
仕様
関連項目
© 2017 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
このページは、ページトップのURL先のMozilla Developer Network(以下、MDN)のコンテンツを翻訳した内容を基に構成されています。 構成について異なる点も含まれますので、下記の項目を確認し、必要に応じて元のコンテンツをご確認ください。 もし、誤訳などの間違いを見つけましたら、 @tomofまで教えていただければ幸いです。
- 特定のブラウザに特化しすぎている情報やあまりにも古い情報、 または試験的に導入されているようなAPIや機能については、省略していることがあります。
- 例やデモについて、実際にページ内で動作させる関係で一部ソースコードを変更している場合や、 その例で使用しているコンテンツの単語や文章などを日本人向けに変更しいてる場合があります。
- MDNの更新頻度が高いため、元のコンテンツと比べ情報が古くなっている可能性があります。
- "訳注:"などの断わりを入れた上で、日本人向けの情報の追記を行っている事があります。