akasha

Class VisualViewport

java.lang.Object

akasha.core.JsObject

akasha.EventTarget

akasha.VisualViewport

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="VisualViewport")
public class VisualViewport
extends EventTarget

The VisualViewport interface of the Visual Viewport API represents the visual viewport for a given window. For a page containing iframes, each iframe, as well as the containing page, will have a unique window object. Each window on a page will have a unique VisualViewport representing the properties associated with that window.

See Also:

VisualViewport - MDN, VisualViewport - Visual Viewport API

Field Summary

Fields

Modifier and Type	Field and Description
EventHandler	onresize The onresize event handler of the VisualViewport interface is called when a viewport is resized, i.e.
EventHandler	onscroll The onscroll event handler of the VisualViewport interface is called when a viewport is scrolled, i.e.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VisualViewport()

Method Summary

Modifier and Type	Method and Description
void	addResizeListener(EventListener callback)
void	addResizeListener(EventListener callback, AddEventListenerOptions options)
void	addResizeListener(EventListener callback, boolean useCapture)
void	addScrollListener(EventListener callback)
void	addScrollListener(EventListener callback, AddEventListenerOptions options)
void	addScrollListener(EventListener callback, boolean useCapture)
double	height() The height read-only property of the VisualViewport interface returns the height of the visual viewport, in CSS pixels.
double	offsetLeft() The offsetLeft read-only property of the VisualViewport interface returns the offset of the left edge of the visual viewport from the left edge of the layout viewport in CSS pixels.
double	offsetTop() The offsetTop read-only property of the VisualViewport interface returns the offset of the top edge of the visual viewport from the top edge of the layout viewport in CSS pixels.
double	pageLeft() The pageLeft read-only property of the VisualViewport interface returns the x coordinate of the left edge of the visual viewport relative to the initial containing block origin, in CSS pixels.
double	pageTop() The pageTop read-only property of the VisualViewport interface returns the y coordinate of the top edge of the visual viewport relative to the initial containing block origin, in CSS pixels.
void	removeResizeListener(EventListener callback)
void	removeResizeListener(EventListener callback, boolean useCapture)
void	removeResizeListener(EventListener callback, EventListenerOptions options)
void	removeScrollListener(EventListener callback)
void	removeScrollListener(EventListener callback, boolean useCapture)
void	removeScrollListener(EventListener callback, EventListenerOptions options)
double	scale() The scale read-only property of the VisualViewport interface returns the pinch-zoom scaling factor applied to the visual viewport.
JsArray<DOMRect>	segments()
double	width() The width read-only property of the VisualViewport interface returns the width of the visual viewport, in CSS pixels.

Methods inherited from class akasha.EventTarget

addEventListener, addEventListener, addEventListener, dispatchEvent, removeEventListener, removeEventListener, removeEventListener

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toString_, valueOf_, values

Methods inherited from class java.lang.Object

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

Field Detail

onresize

@Nullable
public EventHandler onresize

The onresize event handler of the VisualViewport interface is called when a viewport is resized, i.e. when the resize event is fired.

See Also:

VisualViewport.onresize - MDN, onresize - Visual Viewport API

onscroll

@Nullable
public EventHandler onscroll

The onscroll event handler of the VisualViewport interface is called when a viewport is scrolled, i.e. when the scroll event is fired.

See Also:

VisualViewport.onscroll - MDN, onscroll - Visual Viewport API

Constructor Detail

VisualViewport

protected VisualViewport()

Method Detail

height

@JsProperty(name="height")
public double height()

The height read-only property of the VisualViewport interface returns the height of the visual viewport, in CSS pixels.

See Also:

VisualViewport.height - MDN, height - Visual Viewport API

offsetLeft

@JsProperty(name="offsetLeft")
public double offsetLeft()

The offsetLeft read-only property of the VisualViewport interface returns the offset of the left edge of the visual viewport from the left edge of the layout viewport in CSS pixels.

See Also:

VisualViewport.offsetLeft - MDN, offsetLeft - Visual Viewport API

offsetTop

@JsProperty(name="offsetTop")
public double offsetTop()

The offsetTop read-only property of the VisualViewport interface returns the offset of the top edge of the visual viewport from the top edge of the layout viewport in CSS pixels.

See Also:

VisualViewport.offsetTop - MDN, offsetTop - Visual Viewport API

pageLeft

@JsProperty(name="pageLeft")
public double pageLeft()

The pageLeft read-only property of the VisualViewport interface returns the x coordinate of the left edge of the visual viewport relative to the initial containing block origin, in CSS pixels.

See Also:

VisualViewport.pageLeft - MDN, pageLeft - Visual Viewport API

pageTop

@JsProperty(name="pageTop")
public double pageTop()

The pageTop read-only property of the VisualViewport interface returns the y coordinate of the top edge of the visual viewport relative to the initial containing block origin, in CSS pixels.

See Also:

VisualViewport.pageTop - MDN, pageTop - Visual Viewport API

scale

@JsProperty(name="scale")
public double scale()

The scale read-only property of the VisualViewport interface returns the pinch-zoom scaling factor applied to the visual viewport.

See Also:

VisualViewport.scale - MDN, scale - Visual Viewport API

segments

@JsProperty(name="segments")
 @Nonnull
public JsArray<DOMRect> segments()

width

@JsProperty(name="width")
public double width()

The width read-only property of the VisualViewport interface returns the width of the visual viewport, in CSS pixels.

See Also:

VisualViewport.width - MDN, width - Visual Viewport API

addResizeListener

@JsOverlay
public final void addResizeListener(@Nonnull
                                               EventListener callback,
                                               @Nonnull
                                               AddEventListenerOptions options)

addResizeListener

@JsOverlay
public final void addResizeListener(@Nonnull
                                               EventListener callback,
                                               boolean useCapture)

addResizeListener

@JsOverlay
public final void addResizeListener(@Nonnull
                                               EventListener callback)

removeResizeListener

@JsOverlay
public final void removeResizeListener(@Nonnull
                                                  EventListener callback,
                                                  @Nonnull
                                                  EventListenerOptions options)

removeResizeListener

@JsOverlay
public final void removeResizeListener(@Nonnull
                                                  EventListener callback,
                                                  boolean useCapture)

removeResizeListener

@JsOverlay
public final void removeResizeListener(@Nonnull
                                                  EventListener callback)

addScrollListener

@JsOverlay
public final void addScrollListener(@Nonnull
                                               EventListener callback,
                                               @Nonnull
                                               AddEventListenerOptions options)

addScrollListener

@JsOverlay
public final void addScrollListener(@Nonnull
                                               EventListener callback,
                                               boolean useCapture)

addScrollListener

@JsOverlay
public final void addScrollListener(@Nonnull
                                               EventListener callback)

removeScrollListener

@JsOverlay
public final void removeScrollListener(@Nonnull
                                                  EventListener callback,
                                                  @Nonnull
                                                  EventListenerOptions options)

removeScrollListener

@JsOverlay
public final void removeScrollListener(@Nonnull
                                                  EventListener callback,
                                                  boolean useCapture)

removeScrollListener

@JsOverlay
public final void removeScrollListener(@Nonnull
                                                  EventListener callback)