JavaScript метод Element.getClientRects()
Определение и применение
JavaScript метод getClientRects() возвращает массивоподобный объект, который содержит коллекцию объектов
DOMRect, которые необходимы для определения координат относительно видимой области просмотра и размеров
отдельных прямоугольников, занимаемых строчными элементами. Метод getClientRects() не принимает
аргументов.
Объекты DOMRect содержат свойства left, right, top и
bottom. Свойства left и top возвращают координаты X и
Y верхнего левого угла элемента, а свойства right и bottom возвращают
координаты правого нижнего угла элемента.
Кроме того объект DOMRect имеет такие свойства как width и height, которые
соответствуют ширине и высоте элемента (эти значения включают границы элемента (border) и внутренние отступы элемента (padding), но не включают внешние отступы (margin), а также объект DOMRect содержит свойства x и y, которые соответствуют
координате левой (x) и верхней (y) границы прямоугольника относительно видимой области.
Схематичное отображение работы методов
getBoundingClientRect()
и getClientRects() отображено на следующем изображении:
Схематичное отображение содержимого свойств объекта DOMRect представлено на следующем изображении:
Если у элемента нет CSS-бокса, например при display: none у него или его предка, возвращается пустой
DOMRectList. Для строчного элемента, перенесённого на несколько строк, список обычно содержит несколько
прямоугольников; метод применим и к блочным элементам.
Для того, чтобы возвратить объект DOMRect, который содержит размеры элемента и его положение относительно
видимой области просмотра, то воспользуйтесь методом
getBoundingClientRect(). Этот метод подходит для работы с блочными элементами.
Поддержка браузерами
Спецификация: cssom-view
Поддерживается во всех основных браузерах с 2015 года.
| Возможность | Компьютеры | Мобильные | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
getClientRects | 2 | 12 | 3 | 9.5 | 4 | 18 | 4 | 10.1 | 3.2 | 1.0 | 2 | 3.2 |
поддерживаетсяс ограниченияминет поддержкинет данных≤31 — не позднее версии 31
JavaScript синтаксис
const domRectCollection = element.getClientRects();
Спецификация
Размеры указаны в CSS-пикселях и учитывают CSS-трансформации элемента и его предков. Они могут быть дробными и
отличаться от offsetWidth/offsetHeight. getClientRects() возвращает
прямоугольники фрагментов, а getBoundingClientRect() — охватывающий их прямоугольник.
visibility: hidden и opacity: 0 сами по себе не убирают геометрию;
display: none убирает CSS-бокс.
Пример использования
Прямоугольники строк выделенного текста
Нажмите , затем Click me: для текста в b, перенесённого на несколько строк, появится отдельный набор координат каждого прямоугольника. Измените ширину абзаца в index.html и сравните число прямоугольников.
index.html
<button data-migration-click-0="">Click me</button>
<p style="width: 200px">Съешь ещё этих <b id="myElem">мягких французских булок</b>, да выпей же чаю.</p>
<div id="info" style="display: flex; justify-content: space-between"></div>
main.js
const getDomRects = function () {
const elem = document.getElementById('myElem'),
info = document.getElementById('info'),
domRects = elem.getClientRects()
console.log(domRects)
for (let i = 0; i < domRects.length; i++) {
info.innerHTML +=
'<div>Top: ' +
domRects[i].top +
'<br>Right: ' +
domRects[i].right +
'<br>Bottom: ' +
domRects[i].bottom +
'<br>Left: ' +
domRects[i].left +
'<br>Width: ' +
domRects[i].width +
'<br>Height: ' +
domRects[i].height +
'</div>'
}
}
// Обработчики кнопок перенесены из HTML для запуска с CSP без inline-скриптов.
document.querySelector('[data-migration-click-0]').addEventListener('click', function () {
getDomRects()
})
document.querySelector('[data-migration-click-0]').removeAttribute('data-migration-click-0')
Нажмите , чтобы запустить пример.
В этом примере с использованием метода
addEventListener()
при нажатии на кнопку (HTML элемент
<button>) мы вызываем функцию, которая инициализирует три переменные, первая и вторая переменная
содержит элементы, которые метод
getElementById()
находит с определенным глобальным атрибутом
id. Третья переменная с помощью метода getClientRects() возвращает массивоподобный объект,
который содержит коллекцию объектов DOMRect, которые необходимы для определения координат относительно
видимой области просмотра и размеров отдельных прямоугольников, занимаемых строчными элементами.
После этого мы проходим циклом по каждому элементу коллекции и используя свойства каждого объекта
DOMRect мы с помощью свойства innerHTML добавляем элементу с глобальным атрибутом
id
равным значению info текстовое содержимое, которое соответствует значению свойств каждого объекта
DOMRect: left, right, top и bottom,
width и height, они в свою очередь определяют положение прямоугольника относительно видимой
области просмотра и его размер. Для удобства, значения по каждому отдельному объекту DOMRect мы поместили
в элемент
<div>.