CKTIS / JavaScript
IntersectionObserverEntry: isIntersecting, intersectionRatio en target
Lees af of het geobserveerde element het referentiegebied snijdt, welk deel van zijn oppervlak daarin valt en hoe dit verschilt van het passeren van een drempelwaarde.
Versie: Current web platform; runtime support varies
Syntax
entry.isIntersecting // boolean
entry.intersectionRatio // number in [0, 1]
entry.target // ElementEen IntersectionObserverEntry legt de toestand van één doelelement op het meetmoment vast. De callback van de observer ontvangt de vermeldingen asynchroon en kan er meerdere tegelijk krijgen. entry.target is hetzelfde Element dat aan observe() is doorgegeven, niet root. De drie eigenschappen zijn alleen-lezen, maar het element zelf kun je nog steeds aanpassen. Deze API hoort bij het webplatform, niet bij ECMAScript 2024.
entry.isIntersecting is een boolean die aangeeft of het doel bij die meting het referentiegebied van de observer snijdt. Bij de standaardinstelling root: null is dat de viewport van het document op het hoogste niveau, niet die van het iframe waarin het doel staat. De viewport van het iframe kan de berekende doorsnede wel begrenzen. true beschrijft een toestand, niet per se een overgang naar die toestand. Volgens de specificatie kunnen randen die elkaar alleen raken al als snijpunt tellen, ook als het snijoppervlak nul is.
entry.intersectionRatio is een getal van 0 tot 1: de oppervlakte van intersectionRect gedeeld door die van boundingClientRect van het doel, niet door de oppervlakte van het referentiegebied. Als de doelrechthoek geen oppervlakte heeft, is het resultaat 1 wanneer isIntersecting gelijk is aan true, en anders 0. Standaard is de meting geometrisch en bewijst ze niet dat het doel vrij is van afdekking door een ander element.
Na observe() krijg je een eerste vermelding, zelfs als het doel buiten het referentiegebied ligt. Daarna kan een vermelding volgen als de verhouding een drempel in een van beide richtingen passeert of als isIntersecting verandert. Niet elke verandering in de verhouding levert een vermelding op. threshold: 0.5 stelt een meldingsdrempel in; entry.intersectionRatio >= 0.5 controleert de waarde in één specifieke vermelding.
Voorbeelden
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>IntersectionObserverEntry example</title>
</head>
<body>
<script>
(() => {
const root = document.createElement('div');
root.style.cssText = 'position:relative;overflow:hidden;width:100px;height:100px';
const target = document.createElement('div');
target.style.cssText = 'position:absolute;left:0;top:50px;width:100px;height:100px;background:royalblue';
root.append(target);
document.body.append(root);
let moved = false;
const observer = new IntersectionObserver((entries) => {
for (const entry of entries) {
console.log(`${entry.isIntersecting} ${entry.intersectionRatio} ${entry.target === target}`);
if (!moved) {
moved = true;
target.style.top = '150px';
} else {
observer.disconnect();
root.remove();
}
}
}, { root, threshold: 0.5 });
observer.observe(target);
})();
</script>
</body>
</html>Resultaat
true 0.5 true false 0 true
Sla het voorbeeld op als HTML-bestand en open het in een eigen tabblad in een browser die de API ondersteunt. Open de ontwikkelaarsconsole en laad de pagina opnieuw. De eerste vermelding laat zien dat de helft van het doeloppervlak in het referentiegebied ligt. De code verplaatst het doel helemaal buiten dat gebied; de tweede vermelding laat zien dat er geen snijding meer is. Beide vermeldingen verwijzen naar hetzelfde element. Na de tweede stopt de code de observatie en verwijdert hij het referentiegebied.
Gerelateerde lessen
- JavaScript · Les 37 · Gevorderd · Versie: 4
Bronnen
- IntersectionObserverEntry: isIntersecting property
- IntersectionObserverEntry: intersectionRatio property
- IntersectionObserverEntry: target property
- IntersectionObserver: observe() method
- IntersectionObserver: IntersectionObserver() constructor
- HTML Standard — Web application APIs
- Intersection Observer specification — intersection geometry