JavaScript метод Element.getBoundingClientRect()

Определение и применение

JavaScript метод getBoundingClientRect() возвращает объект DOMRect, который содержит размеры элемента и его положение относительно видимой области просмотра. Метод getBoundingClientRect() не принимает аргументов.

Возвращаемый объект DOMRect содержит свойства left, right, top и bottom. Свойства left и top возвращают координаты X и Y верхнего левого угла элемента, а свойства right и bottom возвращают координаты правого нижнего угла элемента.

Кроме того, возвращаемый объект имеет такие свойства как width и height, которые соответствуют ширине и высоте элемента (эти значения включают границы элемента (border) и внутренние отступы элемента (padding), но не включают внешние отступы (margin), а также объект DOMRect содержит свойства x и y, которые соответствуют координате левой (x) и верхней (y) границы прямоугольника относительно видимой области.

Схематичное отображение работы методов getBoundingClientRect() и getClientRects() отображено на следующем изображении:

Схематичное отображение работы методов getBoundingClientRect() и getClientRects()

Схематичное отображение содержимого свойств объекта DOMRect представлено на следующем изображении:

Схематичное отображение свойств объекта DOMRect

Для того, чтобы определить координаты и размеры отдельных прямоугольников, занимаемых строчными элементами воспользуйтесь методом getClientRects(), он возвращает массивоподобный объект, элементы которого представляют объекты прямоугольных областей, подобные тем, что возвращаются методом getBoundingClientRect().

Поддержка браузерами

Спецификация: cssom-view

Поддерживается во всех основных браузерах с 2015 года.

Показать браузеры
Совместимостьapi.Element.getBoundingClientRect
ВозможностьКомпьютерыМобильные
ChromeEdgeFirefoxOperaSafariChrome AndroidFirefox for AndroidOpera AndroidSafari on iOSSamsung BrowserWebView AndroidWebView on iOS
getBoundingClientRect✓2✓12✓3✓9.5✓4✓18✓4✓10.1✓3.2✓1.0✓2✓3.2

поддерживаетсяс ограниченияминет поддержкинет данных≤31 — не позднее версии 31

JavaScript синтаксис

JavaScript
const domRect = element.getBoundingClientRect();

Спецификация

CSSOM View Module.

Размеры указаны в CSS-пикселях и учитывают CSS-трансформации элемента и его предков. Они могут быть дробными и отличаться от offsetWidth/offsetHeight. getClientRects() возвращает прямоугольники фрагментов, а getBoundingClientRect() — охватывающий их прямоугольник. visibility: hidden и opacity: 0 сами по себе не убирают геометрию; display: none убирает CSS-бокс.

Пример использования

Координаты и размеры элемента в прокручиваемом блоке

Нажмите ▶, затем Click me: под кнопкой появятся top, right, bottom, left, width и height абзаца. Прокрутите внешний блок и нажмите кнопку снова — координаты изменятся, а размеры останутся прежними.

index.html
HTML
<button data-migration-click-0="">Click me</button>

<div style="height: 150px; width: 200px; overflow: auto">
  <div style="width: 600px; height: 600px">
    <p id="myDiv" style="width: 70px; height: 70px; border: 1px solid green; margin: 20px">My elem</p>
  </div>
</div>

<div id="info"></div>
main.js
JavaScript
const getDomRect = function () {
    const elem = document.getElementById('myDiv'),
        info = document.getElementById('info'),
        domRect = elem.getBoundingClientRect()

    info.innerHTML =
        'Top: ' +
        domRect.top +
        '<br>Right: ' +
        domRect.right +
        '<br>Bottom: ' +
        domRect.bottom +
        '<br>Left: ' +
        domRect.left +
        '<br>Width: ' +
        domRect.width +
        '<br>Height: ' +
        domRect.height
}

// Обработчики кнопок перенесены из HTML для запуска с CSP без inline-скриптов.
document.querySelector('[data-migration-click-0]').addEventListener('click', function () {
    getDomRect()
})
document.querySelector('[data-migration-click-0]').removeAttribute('data-migration-click-0')

В этом примере с использованием метода addEventListener() при нажатии на кнопку (HTML элемент <button>) мы вызываем функцию, которая инициализирует три переменные, первая и вторая переменная содержит элементы, которые метод getElementById() находит с определенным глобальным атрибутом id. Третья переменная с помощью метода getBoundingClientRect() возвращает объект DOMRect, который содержит размеры элемента и его положение относительно видимой области просмотра.

Используя свойства объекта DOMRect мы с помощью свойства innerHTML добавляем элементу с глобальным атрибутом id равным значению info текстовое содержимое, которое соответствует значению свойств объекта DOMRect: left, right, top и bottom, width и height, они в свою очередь определяют положение прямоугольника относительно видимой области просмотра и его размер.