Element: scroll() メソッド

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2020.

scroll() は Element インターフェイスのメソッドで、指定された要素内の特定の座標の組まで要素をスクロールさせます。

構文

js
scroll(x-coord, y-coord)
scroll(options)

引数

x-coord

左上に表示させたいこの要素の横軸方向のピクセルです。

y-coord

左上に表示させたいこの要素の縦軸方向のピクセルです。

- または -

options

以下の引数を含む辞書オブジェクトです。

top

ウィンドウまたは要素をスクロールする Y 軸方向のピクセル数を指定します。

left

ウィンドウまたは要素をスクロールする X 軸方向のピクセル数を指定します。

behavior

スクロールを即座に行うか、滑らかにアニメーションさせるかを決定します。このオプションは文字列であり、以下のいずれかの値を取ります。

  • smooth: スクロールをスムーズなアニメーションで行う
  • instant: スクロールを単一のジャンプで即座に行う
  • auto: スクロールの動作を scroll-behavior の計算値によって指定する

返値

なし (undefined)。

例

js
// 1000 番目の垂直ピクセルを要素の先頭に置く
element.scroll(0, 1000);

options の使用例:

js
element.scroll({
  top: 100,
  left: 100,
  behavior: "smooth",
});

仕様書

Specification
CSSOM View Module
# dom-element-scroll

ブラウザーの互換性

BCD tables only load in the browser