Window: scrollTo() メソッド
Baseline
広く利用可能
この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2015年7月以降、すべてのブラウザーで利用可能です。
Window.scrollTo() は文書内の特定の座標までスクロールします。
構文
js
scrollTo(xCoord, yCoord)
scrollTo(options)
引数
xCoord-
文書の水平軸上の、左上に表示させたいピクセルです。
yCoord-
文書の垂直軸上の、左上に表示させたいピクセルです。
options-
以下のプロパティが含まれているオブジェクトです。
top-
ウィンドウまたは要素をスクロールする Y 軸方向のピクセル数を指定します。
left-
ウィンドウまたは要素をスクロールする X 軸方向のピクセル数を指定します。
behavior-
スクロールを瞬時に行うか、滑らかにアニメーションするかを指定します。このオプションは文字列であり、以下のいずれかの値を設定しなければなりません。
smooth: スクロールを滑らかなアニメーションで行います。instant: スクロールを単一のジャンプで直ちに行います。auto: スクロールの動作はscroll-behaviorの計算値で定められます。
返値
なし (undefined)。
例
js
window.scrollTo(0, 1000);
options の使用例:
js
window.scrollTo({
top: 100,
left: 100,
behavior: "smooth",
});
注
Window.scroll() はこのメソッドとほぼ同じです。相対スクロールについては、 Window.scrollBy(), Window.scrollByLines(), Window.scrollByPages() を参照してください。
要素をスクロールするには、 Element.scrollTop および Element.scrollLeft を参照してください。
仕様書
| 仕様書 |
|---|
| CSSOM View Module # dom-window-scrollto |