概要
文書が水平スクロールされているピクセル数を返します。
構文
var x = window.scrollX
引数
x
- 文書の垂直方向のスクロール量(ピクセル)
例
// scrollXが400以上の場合、文書の左上にスクロール位置をリセット if (window.scrollX > 400) { window.scroll(0, 0); }
注記
window.scrollBy
、window.scrollByLines
、window.scrollByPages
のような相対スクロールする関数を使用する際に、文書が既にスクロールしていないかをチェックするためにこのプロパティを使用してください。
pageXOffset プロパティは、scrollX プロパティのエイリアスです。:
window.pageXOffset == window.scrollX; // 常に true
クロスブラウザ互換性の為、window.scrollX
ではなく window.pageXOffset
を使用します。さらに、古いバージョンの Internet Explorer (IE9 以前) は何れもサポートしていないため、チェックの上、無ければ他の非標準の方法で回避する必要があります。以下に互換性を確保した例を示します。
var x = (window.pageXOffset !== undefined) ? window.pageXOffset : (document.documentElement || document.body.parentNode || document.body).scrollLeft, y = (window.pageYOffset !== undefined) ? window.pageYOffset : (document.documentElement || document.body.parentNode || document.body).scrollTop;
仕様
仕様 | 状況 | 備考 |
---|---|---|
CSS Object Model (CSSOM) View Module The definition of 'window.scrollX' in that specification. |
草案 |
現在、標準化作業が進められています。
- CSSOM View Module: window.scrollX (Editor's Draft)