Element.scrollHeightは読み取り専用の属性で、あふれた(overflowした)画面上に表示されていないコンテンツを含む要素の内容の高さを表します。 scrollHeightの値は、その要素が垂直スクロールバーを使用せずに、 要素の全てのコンテンツを見せるために収めるのに必要なclientHeightの最小値と同じ値になります。 要素のpaddingは含みますが、marginは含まれません。

このプロパティは整数に丸められます。 もし小数の値を必要とするのであれば、 Element.getBoundingClientRect()を使用してください。

• 文法
• 例
• 問題とその解決法
• scrollHeightデモ
• 仕様
• ブラウザの互換性
• 関連項目

文法

var h = document.getElementById(id_val).scrollHeight;

hには、要素のscrollHeightのピクセル値が数値として格納されます。 scrollHeightは、読み取り専用プロパティです。

例

 

問題とその解決法

要素が完全にスクロールされたかどうかを判定

下記は、要素が末尾までスクロールされていればtrueを返し、そうでなければfalseを返します。

element.scrollHeight - element.scrollTop === element.clientHeight

scrollHeightデモ

関連するonscrollイベントは、 この等価式を利用して、ユーザがテキストを読んだか読んでないかを判定するのに便利です。 (element.scrollTopとelement.clientHeightプロパティも参照してください)

下記のソースコードを適用したMozillaのリンク先のデモページでは、 スクロールして全文を表示しないとチェックボックスとボタンが有効になりません。

HTML

<form name="registration">
  <p>
    <textarea id="rules">Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum at laoreet magna.
Aliquam erat volutpat. Praesent molestie, dolor ut eleifend aliquam, mi ligula ultrices sapien, quis cursus
neque dui nec risus. Duis tincidunt lobortis purus eu aliquet. Quisque in dignissim magna. Aenean ac lorem at
velit ultrices consequat. Nulla luctus nisi ut libero cursus ultrices. Pellentesque nec dignissim enim. Phasellus
ut quam lacus, sed ultricies diam. Vestibulum convallis rutrum dolor, sit amet egestas velit scelerisque id.
Proin non dignissim nisl. Sed mi odio, ullamcorper eget mattis id, malesuada vitae libero. Integer dolor lorem,
mattis sed dapibus a, faucibus id metus. Duis iaculis dictum pulvinar. In nisi nibh, dapibus ac blandit at, porta
at arcu. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Praesent
dictum ipsum aliquet erat eleifend sit amet sollicitudin felis tempus. Aliquam congue cursus venenatis. Maecenas
luctus pellentesque placerat. Mauris nisl odio, condimentum sed fringilla a, consectetur id ligula. Praesent sem
sem, aliquet non faucibus vitae, iaculis nec elit. Nullam volutpat, lectus et blandit bibendum, nulla lorem congue
turpis, ac pretium tortor sem ut nibh. Donec vel mi in ligula hendrerit sagittis. Donec faucibus viverra fermentum.
Fusce in arcu arcu. Nullam at dignissim massa. Cras nibh est, pretium sit amet faucibus eget, sollicitudin in
ligula. Vivamus vitae urna mauris, eget euismod nunc. Aenean semper gravida enim non feugiat. In hac habitasse
platea dictumst. Cras eleifend nisl volutpat ante condimentum convallis. Donec varius dolor malesuada erat
consequat congue. Donec eu lacus ut sapien venenatis tincidunt. Quisque sit amet tellus et enim bibendum varius et
a orci. Donec aliquet volutpat scelerisque. Proin et tortor dolor. Ut aliquet, dolor a mattis sodales, odio diam
pulvinar sem, egestas pretium magna eros vitae felis. Nam vitae magna lectus, et ornare elit. Morbi feugiat, ipsum
ac mattis congue, quam neque mollis tortor, nec mollis nisl dolor a tortor. Maecenas varius est sit amet elit
interdum quis placerat metus posuere. Duis malesuada justo a diam vestibulum vel aliquam nisi ornare. Integer
laoreet nisi a odio ornare non congue turpis eleifend. Cum sociis natoque penatibus et magnis dis parturient montes,
nascetur ridiculus mus. Cras vulputate libero sed arcu iaculis nec lobortis orci fermentum.
    </textarea>
  </p>
  <p>
    <input type="checkbox" name="accept" id="agree" />
    <label for="agree">I agree</label>
    <input type="submit" id="nextstep" value="Next" />
  </p>
</form>

CSS

#notice {
  display: inline-block;
  margin-bottom: 12px;
  border-radius: 5px;
  width: 600px;
  padding: 5px;
  border: 2px #7FDF55 solid;
}

#rules {
  width: 600px;
  height: 130px;
  padding: 5px;
  border: #2A9F00 solid 2px;
  border-radius: 5px;
}

JavaScript

function checkReading () {
  if (checkReading.read) {
    return;
  }
  checkReading.read = this.scrollHeight - this.scrollTop === this.clientHeight;
  document.registration.accept.disabled = document.getElementById("nextstep").disabled = !checkReading.read;
  checkReading.noticeBox.innerHTML = checkReading.read ? "Thank you." : "Please, scroll and read the following text.";
}

onload = function () {
  var oToBeRead = document.getElementById("rules");
  checkReading.noticeBox = document.createElement("span");
  document.registration.accept.checked = false;
  checkReading.noticeBox.id = "notice";
  oToBeRead.parentNode.insertBefore(checkReading.noticeBox, oToBeRead);
  oToBeRead.parentNode.insertBefore(document.createElement("br"), oToBeRead);
  oToBeRead.onscroll = checkReading;
  checkReading.call(oToBeRead);
}

Mozillaのデモページで確認

仕様

scrollHeightは、MSIEのDHTMLオブジェクトモデルの一部です。 また、scrollHeightは、CSS Object Model (CSSOM) View Moduleの仕様の一部です。

ブラウザの互換性

デスクトップ

機能	Chrome	Firefox (Gecko)	IE	Opera	Safari
基本	◯	◯	◯	◯	◯

モバイル

機能	Android	Chrome for Android	Firefox Mobile	IE Mobile	Opera Mobile	Safari Mobile
基本	◯	◯	◯	◯	◯	◯

FireFoxバージョンが21より前のバージョンでは、要素の内容が垂直スクロールバーを生成しない場合、 scrollHeightプロパティはそのclientHeightプロパティと同じ値でした。 これはスクロールバーを必要とするのに内容が短すぎる、 または要素がvisible(スクロールバー不可)のoverflowのCSSスタイルを持つかの、 どちらかであることを意味します。

関連項目

• MSDN: scrollHeight Property
• MSDN: Measuring Element Dimension and Location
• MSDN: Measuring Element Dimension and Location with CSSOM in Windows Internet Explorer 9
• Element.clientHeight
• Element.offsetHeight
• Determining the dimensions of elements

 Back to top