Element: getClientRects() Methode

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since ⁨Juli 2015⁩.

Die getClientRects() Methode des Element Interfaces gibt eine Sammlung von DOMRect Objekten zurück, die die Begrenzungsrechtecke für jedes CSS-Border-Box in einem Client angeben.

Die meisten Elemente haben jeweils nur eine Border-Box, aber ein mehrzeiliges Inline-Level-Element (wie ein mehrzeiliges <span>-Element, standardmäßig) hat eine Border-Box um jede Zeile.

Der zurückgegebene Wert ist eine Sammlung von DOMRect Objekten, jeweils eine für jede mit dem Element verbundene CSS-Border-Box. Jedes DOMRect Objekt beschreibt die Border-Box in Pixeln, wobei die obere linke Ecke relativ zur oberen linken Ecke des Viewports liegt. Bei Tabellen mit Überschriften ist die Überschrift eingeschlossen, obwohl sie sich außerhalb der Border-Box der Tabelle befindet. Wenn sie auf SVG-Elementen aufgerufen wird, die nicht ein äußeres-<svg> sind, bezieht sich der "Viewport", relativ zu dem die resultierenden Rechtecke sind, auf den Viewport, den das äußere-<svg> Element festlegt (und um klar zu sein, die Rechtecke werden auch durch die viewBox-Transformation des äußeren-<svg> transformiert, falls vorhanden).

Die Menge des Scrollens, das im Viewport-Bereich (oder einem anderen scrollbaren Element) durchgeführt wurde, wird bei der Berechnung der Rechtecke berücksichtigt.

Die zurückgegebenen Rechtecke enthalten nicht die Grenzen von Kind-Elementen, die möglicherweise überlaufen.

Für HTML <area> Elemente, SVG-Elemente, die selbst nichts rendern, display:none Elemente und allgemein alle Elemente, die nicht direkt gerendert werden, wird eine leere Liste zurückgegeben.

Rechtecke werden sogar für CSS-Boxen zurückgegeben, die leere Border-Boxen haben. Die left, top, right und bottom Koordinaten können dennoch bedeutungsvoll sein.

Bruchteile von Pixelversätzen sind möglich.

Beispiele

Diese Beispiele zeichnen Client-Rechtecke in verschiedenen Farben. Beachten Sie, dass die JavaScript-Funktion, die die Client-Rechtecke zeichnet, über die Klasse withClientRectsOverlay mit dem Markup verbunden ist.

HTML

Beispiel 1: Dieses HTML erstellt drei Absätze mit einem <span> darin, die jeweils in einem <div> Block eingebettet sind. Client-Rechtecke werden für den Absatz im zweiten Block und für das <span> Element im dritten Block gezeichnet.

html

<h3>A paragraph with a span inside</h3> <p> Both the span and the paragraph have a border set. The client rects are in red. Note that the p has only one border box, while the span has multiple border boxes. </p> <div> <strong>Original</strong> <p> <span>Paragraph that spans multiple lines</span> </p> </div> <div> <strong>p's rect</strong> <p class="withClientRectsOverlay"> <span>Paragraph that spans multiple lines</span> </p> </div> <div> <strong>span's rect</strong> <p> <span class="withClientRectsOverlay" >Paragraph that spans multiple lines</span > </p> </div>

Beispiel 2: Dieses HTML erstellt drei geordnete Listen. Client-Rechtecke werden für das <ol> im zweiten Block und für jedes <li> Element im dritten Block gezeichnet.

html

<h3>A list</h3> <p> Note that the border box doesn't include the number, so neither do the client rects. </p> <div> <strong>Original</strong> <ol> <li>Item 1</li> <li>Item 2</li> </ol> </div> <div> <strong>ol's rect</strong> <ol class="withClientRectsOverlay"> <li>Item 1</li> <li>Item 2</li> </ol> </div> <div> <strong>each li's rect</strong> <ol> <li class="withClientRectsOverlay">Item 1</li> <li class="withClientRectsOverlay">Item 2</li> </ol> </div>

Beispiel 3: Dieses HTML erstellt zwei Tabellen mit Überschriften. Client-Rechtecke werden für die <table> im zweiten Block gezeichnet.

html

<h3>A table with a caption</h3> <p> Although the table's border box doesn't include the caption, the client rects do include the caption. </p> <div> <strong>Original</strong> <table> <caption> caption </caption> <thead> <tr> <th>thead</th> </tr> </thead> <tbody> <tr> <td>tbody</td> </tr> </tbody> </table> </div> <div> <strong>table's rect</strong> <table class="withClientRectsOverlay"> <caption> caption </caption> <thead> <tr> <th>thead</th> </tr> </thead> <tbody> <tr> <td>tbody</td> </tr> </tbody> </table> </div>

CSS

Das CSS zieht Rahmen um den Absatz und das <span> innerhalb jedes <div> Blocks im ersten Beispiel, um das <ol> und <li> im zweiten Beispiel, und um <table>, <th>, und <td> Elemente im dritten Beispiel.

css

strong { text-align: center; } div { display: inline-block; width: 150px; } div p, ol, table { border: 1px solid blue; } span, li, th, td { border: 1px solid green; }

JavaScript

Der JavaScript-Code zeichnet die Client-Rechtecke für alle HTML-Elemente, denen die CSS-Klasse withClientRectsOverlay zugewiesen ist.

function addClientRectsOverlay(elt) { /* Absolutely position a div over each client rect so that its border width is the same as the rectangle's width. Note: the overlays will be out of place if the user resizes or zooms. */ const rects = elt.getClientRects(); for (const rect of rects) { const tableRectDiv = document.createElement("div"); tableRectDiv.style.position = "absolute"; tableRectDiv.style.border = "1px solid red"; const scrollTop = document.documentElement.scrollTop || document.body.scrollTop; const scrollLeft = document.documentElement.scrollLeft || document.body.scrollLeft; tableRectDiv.style.margin = tableRectDiv.style.padding = "0"; tableRectDiv.style.top = `${rect.top + scrollTop}px`; tableRectDiv.style.left = `${rect.left + scrollLeft}px`; // We want rect.width to be the border width, so content width is 2px less. tableRectDiv.style.width = `${rect.width - 2}px`; tableRectDiv.style.height = `${rect.height - 2}px`; document.body.appendChild(tableRectDiv); } } (() => { /* Call function addClientRectsOverlay(elt) for all elements with assigned class "withClientRectsOverlay" */ const elems = document.getElementsByClassName("withClientRectsOverlay"); for (const elem of elems) { addClientRectsOverlay(elem); } })();