Animation: cancel() メソッド
Baseline
広く利用可能
この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2020年3月以降、すべてのブラウザーで利用可能です。
ウェブアニメーション API の cancel() は Animation インターフェイスのメソッドで、このアニメーションによって引き起こされたすべての KeyframeEffectを初期化し、再生を中止します。
メモ:
アニメ―ションをキャンセルした時、startTime と currentTime は、 null に設定されます。
構文
js
cancel()
引数
なし。
返値
なし。
例外
このメソッドは、直接は例外を発生しません。しかし、キャンセル時にアニメーションの playState が "idle" 以外の場合、 current finished promise は DOMException の AbortError で拒否されます。
仕様書
| 仕様書 |
|---|
| Web Animations> # dom-animation-cancel> |
ブラウザーの互換性
関連情報
- ウェブアニメーション API
KeyframeEffectAnimationAnimation.playStateAnimation.finishedはこのアニメーションのplayStateが"idle"でなくなると拒否されるこの操作のプロミスを返します。