akasha

Class IntersectionObserver

java.lang.Object

akasha.IntersectionObserver

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="IntersectionObserver")
public class IntersectionObserver
extends java.lang.Object

provides a way to asynchronously observe changes in the intersection of a target element with an ancestor element or with a top-level document's viewport.

See Also:

IntersectionObserver - MDN, IntersectionObserver - Intersection Observer

Constructor Summary

Constructors

Constructor and Description
IntersectionObserver(IntersectionObserverCallback callback) The IntersectionObserver() constructor creates and returns a new IntersectionObserver object.
IntersectionObserver(IntersectionObserverCallback callback, IntersectionObserverInit options) The IntersectionObserver() constructor creates and returns a new IntersectionObserver object.

Method Summary

Modifier and Type	Method and Description
void	disconnect() The IntersectionObserver method disconnect() stops watching all of its target elements for visibility changes.
void	observe(Element target) The IntersectionObserver method observe() adds an element to the set of target elements being watched by the IntersectionObserver.
ElementOrDocumentUnion	root() The IntersectionObserver interface's read-only root property identifies the Element or Document whose bounds are treated as the bounding box of the viewport for the element which is the observer's target.
java.lang.String	rootMargin() The IntersectionObserver interface's read-only rootMargin property is a string with syntax similar to that of the CSS margin property.
JsArray<IntersectionObserverEntry>	takeRecords() The IntersectionObserver method takeRecords() returns an array of IntersectionObserverEntry objects, one for each targeted element which has experienced an intersection change since the last time the intersections were checked, either explicitly through a call to this method or implicitly by an automatic call to the observer's callback.
JsArray<java.lang.Double>	thresholds() The IntersectionObserver interface's read-only thresholds property returns the list of intersection thresholds that was specified when the observer was instantiated with IntersectionObserver().
void	unobserve(Element target) The IntersectionObserver method unobserve() instructs the IntersectionObserver to stop observing the specified target element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IntersectionObserver

public IntersectionObserver(@Nonnull
                            IntersectionObserverCallback callback,
                            @Nonnull
                            IntersectionObserverInit options)

The IntersectionObserver() constructor creates and returns a new IntersectionObserver object.

See Also:

IntersectionObserver.IntersectionObserver - MDN, IntersectionObserver constructor - Intersection Observer

IntersectionObserver

public IntersectionObserver(@Nonnull
                            IntersectionObserverCallback callback)

The IntersectionObserver() constructor creates and returns a new IntersectionObserver object.

See Also:

IntersectionObserver.IntersectionObserver - MDN, IntersectionObserver constructor - Intersection Observer

Method Detail

root

@JsProperty(name="root")
 @Nullable
public ElementOrDocumentUnion root()

The IntersectionObserver interface's read-only root property identifies the Element or Document whose bounds are treated as the bounding box of the viewport for the element which is the observer's target.

See Also:

IntersectionObserver.root - MDN, IntersectionObserver - Intersection Observer

rootMargin

@JsProperty(name="rootMargin")
 @Nonnull
public java.lang.String rootMargin()

The IntersectionObserver interface's read-only rootMargin property is a string with syntax similar to that of the CSS margin property. Each side of the rectangle represented by rootMargin is added to the corresponding side in the root element's bounding box before the intersection test is performed. This lets you, for example, adjust the bounds outward so that the target element is considered 100% visible even if a certain number of pixels worth of width or height is clipped away, or treat the target as partially hidden if an edge is too close to the edge of the root's bounding box.

See Also:

IntersectionObserver.rootMargin - MDN, IntersectionObserver.rootMargin - Intersection Observer

thresholds

@JsProperty(name="thresholds")
 @Nonnull
public JsArray<java.lang.Double> thresholds()

The IntersectionObserver interface's read-only thresholds property returns the list of intersection thresholds that was specified when the observer was instantiated with IntersectionObserver(). If only one threshold ratio was provided when instanitating the object, this will be an array containing that single value.

See Also:

IntersectionObserver.thresholds - MDN, IntersectionObserver.thresholds - Intersection Observer

disconnect

public void disconnect()

The IntersectionObserver method disconnect() stops watching all of its target elements for visibility changes.

See Also:

IntersectionObserver.disconnect - MDN, IntersectionObserver.disconnect() - Intersection Observer

observe

public void observe(@Nonnull
                    Element target)

The IntersectionObserver method observe() adds an element to the set of target elements being watched by the IntersectionObserver. One observer has one set of thresholds and one root, but can watch multiple target elements for visibility changes in keeping with those.

See Also:

IntersectionObserver.observe - MDN, IntersectionObserver.observe() - Intersection Observer

takeRecords

@Nonnull
public JsArray<IntersectionObserverEntry> takeRecords()

The IntersectionObserver method takeRecords() returns an array of IntersectionObserverEntry objects, one for each targeted element which has experienced an intersection change since the last time the intersections were checked, either explicitly through a call to this method or implicitly by an automatic call to the observer's callback.

See Also:

IntersectionObserver.takeRecords - MDN, IntersectionObserver.takeRecords() - Intersection Observer

unobserve

public void unobserve(@Nonnull
                      Element target)

The IntersectionObserver method unobserve() instructs the IntersectionObserver to stop observing the specified target element.

See Also:

IntersectionObserver.unobserve - MDN, IntersectionObserver.unobserve() - Intersection Observer