JavaScriptでscrollTopプロパティを使って要素のスクロールされるピクセル数を取得、設定する方法を現役エンジニアが解説【初心者向け】
テックアカデミーマガジンは受講者数No.1のプログラミングスクール「テックアカデミー」が運営。初心者向けにプロが解説した記事を公開中。現役エンジニアの方はこちらをご覧ください。 ※ アンケートモニター提供元：GMOリサーチ株式会社 調査期間：2021年8月12日～8月16日 調査対象：2020年8月以降にプログラミングスクールを受講した18～80歳の男女1,000名 調査手法：インターネット調査
監修してくれたメンター
nakamoto
JavaScriptでscrollTopプロパティを使って要素のスクロールされるピクセル数を取得、設定する方法について、テックアカデミーのメンター（現役エンジニア）が実際のコードを使用して初心者向けに解説します。
JavaScriptでscrollTopプロパティを使うと、スクロール量をピクセル単位で設定や取得できます。
実務でもscrollTopプロパティによって画面スクロール処理を行うので、ぜひ学習してみてください。
目次
- scrollTopプロパティとは
- scrollTopプロパティの使い方
- 要素のスクロールされるピクセル数を取得する方法
- 要素のスクロールされるピクセル数を設定する方法
- 実際に書いてみよう
- offset().topとscrollTopの違い
- まとめ
- JavaScriptを学習中の方へ
そもそもJavaScriptについてよく分からないという方は、JavaScriptとは何なのかについて解説した記事を読むとさらに理解が深まります。
今回は、JavaScriptに関する内容だね！
どういう内容でしょうか？
JavaScriptでscrollTopプロパティを使って要素のスクロールされるピクセル数を取得、設定する方法について詳しく説明していくね！
お願いします！
scrollTopプロパティとは
scrollTopは、要素のプロパティです。
要素とはHTMLを構成する部品の塊を意味します。
JavaScriptでscrollTopプロパティを利用することで、要素の一番上からのスクロール量をピクセル単位で設定や取得できます。
scrollTopプロパティの使い方
あらかじめ、HTMLのスクロールが発生している要素を取得しておきます。
取得したタグの要素に.scrollTopと続けて記述することで、scrollTopプロパティを使うことができます。
要素.scrollTop;
要素のスクロールされるピクセル数を取得する方法
HTMLのソースでスクロールが発生しているタグを取得し、.scrollTopとすることでその時のスクロールしている量を取得できます。
サンプルコード
function count(){
var main = document.getElementById('main');
var scrollTop = main.scrollTop;
console.log(scrollTop);
}実行結果
解説
function count(){では、スクロール数を計測するcount()関数を宣言しています。
var main = document.getElementById(‘要素’);では、HTML内で「main」というidを持つ要素が存在しているという仮定で、要素を取得して、変数mainに代入しています。
var scrollTop = main.scrollTop;では、mainという要素に対して、scrollTopメソッドを適用して、スクロール数を取得して、変数scrollTopに代入しています。
console.log(scrollTop);では、変数scrollTopをコンソールに表示しています。
}では、function count(){を終了しています。
要素に指定したidを正しく指定することで、スクロール数を取得することが可能です。
要素のスクロールされるピクセル数を設定する方法
HTMLのソースでスクロールが発生しているタグを取得し、そのプロパティである.scrollTopに値を代入することで設定ができます。
サンプルコード
function set(){
var main = document.getElementById('main');
main.scrollTop = 50;
}実行結果
解説
function set(){では、スクロール数を指定するset()関数を宣言しています。
var main = document.getElementById(‘要素’);では、HTML内で「main」というidを持つ要素が存在しているという仮定で、要素を取得して、変数mainに代入しています。
main.scrollTop = 50;では、50pxの位置にスクロールする処理をしています。
}では、function set(){を終了しています。
要素に指定したidを正しく指定することで、指定した50pxスクロールした位置に移動します。
実際に書いてみよう
ここでは、scrollTopを実際に書いてみましょう。
HTMLサンプルコード
<div class="outer" id="target">
<div></div>
<div></div>
<div></div>
<div></div>
<div></div>
</div>
<button id="actionButton">スクロールの真ん中に移動する</button>CSSサンプルコード
.outer{
background-color: skyblue;
width: 200px;
height: 200px;
overflow-y: scroll;
}
.outer div{
background-color: pink;
width: 50px;
height: 200px;
}
.outer div:nth-child(even){
background-color: gray;
width: 50px;
height: 200px;
}JavaScriptサンプルコード
//スクロール量をコンソールに表示する処理
let target = document.getElementById('target');
target.onscroll = () => console.log(target.scrollTop);
//ボタンを押したらスクロール位置400に移動する処理
let actionButton = document.getElementById('actionButton');
actionButton.onclick = () => target.scrollTop = 400;実行結果
解説
まずはスクロールが発生するように、HTMLサンプルコードとCSSサンプルコードを準備します。
HTMLサンプルコードについて、次のコードで、高さ200pxのdivタグを5つ格納します。
高さ200pxの親divの中に、子のdivが200px×5で合計1000pxの高さが入り、800px分のスクロールが行われるようになります。
<div></div>
<div></div>
<div></div>
<div></div>
<div></div>
HTMLサンプルコードの次のコードで、スクロール位置を移動させるためのボタンを用意しておきます。
<button id="actionButton">スクロールの真ん中に移動する</button>
CSSサンプルコードにある次のコードについて、親のdivタグに200pxの高さを指定し、overflow-y: scrollとすることで200pxを超えた分がスクロールされるようにします。
.outer{
background-color: skyblue;
width: 200px;
height: 200px;
overflow-y: scroll;
}
CSSの次のコードで、スクロールしていることが見えやすいようにdivタグは色を交互に入れ替えています。
.outer div{
background-color: pink;
width: 50px;
height: 200px;
}
.outer div:nth-child(even){
background-color: gray;
width: 50px;
height: 200px;
}
手動でスクロールすると次のような表示になり、スクロールしていることがgrayとpinkの色でわかりやすく表示されます。
JavaScriptサンプルコードでは、プロパティの参照と代入を行っています。
let target = document.getElementById(‘target’);では、スクロールする要素であるidがtargetという名前のdivタグを取得しています。
target.onscroll = () => console.log(target.scrollTop);では、、スクロールが発生するごとにコンソールにスクロール量を出力しています。
スクロールの発生は、onscrollというイベントハンドラ（イベントを処理する部品）を使うことで対応できます。
let actionButton = document.getElementById(‘actionButton’);では、actionButtonというidで指定したボタンの要素を取得し、actionButton変数に代入しています。
actionButton.onclick = () => target.scrollTop = 400;では、スクロールの位置を移動させる処理をボタンがクリックされたら実行するようにしています。
クリックの発生は、onclickというイベントハンドラを使うことで対応できます。
ボタンが押されたらスクロールする要素のscrollTopに400を設定しています。
これでスクロール位置が400の場所に移動します。
offset().topとscrollTopの違い
scrollTopメソッドは、縦方向のスクロール数を取得・指定することができました。
offset().topは、画面左上端を基準として、任意の要素までの縦軸方向と横軸方向の距離を取得できます。
scrollTopメソッドは、スクロールするときに利用することが多いです。
例えば、ページのトップに戻るボタンなどで利用されます。
offset().topメソッドは、jQueryのメソッドです。
使用するためには、jQueryを読み込んでおく必要があります。
offset().topメソッドは、scrollTopメソッドと連携しながら、HTML内の要素の位置を計測することで、アニメーションの実装を行うときに利用されます。
まとめ
scrollTopを利用して、要素のスクロールされるピクセル数の取得を行いました。
scrollTopを利用して、要素へスクロールするピクセル数の指定を行いました。
スクロール量を把握することで、どこまでをユーザーが見たかを把握できます。
スクロールが長くなった場合に、特定のスクロール位置に移動できるようにすることでユーザーの操作を助けることができます。
JavaScriptでid名を取得する方法を通じて、要素の取得方法も復習してみてください。
jQueryのanimateには、scrollメソッドを活用した利用方法もあります。
内容が分かりやすくて良かったです！
ゆかりちゃんも分からないことがあったら質問してね！
分かりました。ありがとうございます！
JavaScriptを学習中の方へ
これで解説は終了です、お疲れさまでした。
- つまずかず「効率的に」学びたい
- 副業や転職後の「現場で使える」知識やスキルを身につけたい
プログラミングを学習していて、このように思ったことはありませんか？
テックアカデミーのフロントエンドコースでは、第一線で活躍する「プロのエンジニア」が教えているので、効率的に実践的なスキルを完全オンラインでしっかり習得できます。
合格率10%の選考を通過した、選ばれたエンジニアの手厚いサポートを受けながら、JavaScript・jQueryを使ったWebサービス開発を学べます。
まずは一度、無料体験で学習の悩みや今後のキャリアについて話してみて、「現役エンジニアから教わること」を実感してみてください。
時間がない方、深く知ってから体験してみたい方は、今スグ見られる説明動画から先に視聴することをおすすめします！
