WindowScrollHost class

Provides a scroll host that uses the browser window content area.

Implemented types
Annotations
  • @Injectable()

Constructors

WindowScrollHost(DomService domService, NgZone ngZone, GestureListenerFactory gestureListenerFactory, Window window)

Properties

anchorElement Element?
Returns anchor element for hosting virtual horizontal scrollbar.
no setterinherited
clientHeight int
The visible content height
no setterinherited
clientWidth int
The visible content width
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
nativeOnScroll Stream<ScrollHostEvent>
The stream of ScrollHostEvents before they have been handled to scroll the content of the ScrollHost.
no setterinherited
offsetX num
The leftmost position
finalinherited
offsetY num
The topmost position
finalinherited
onScroll Stream<ScrollHostEvent>?
The stream of ScrollHostEvents from nativeOnScroll after they have been handled, i.e. the content of the ScrollHost has been scrolled.
no setterinherited
panController PanController?
Gets the pan controller for the given scroll host.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
scrollbarHost GlobalEventHandlers
The target of scroll events from the scrollbar.
no setterinherited
scrollHeight int
The total scrollable content height
no setterinherited
scrollLength int
The total scrollable length.
no setterinherited
scrollPosition int
The current position (>=0, < scrollLength)
no setterinherited
stickyController StickyController?
Gets the sticky controller for the given scroll host.
no setterinherited
throttleScrollEvents bool
Whether to throttle scroll events to at most one event per frame.
no setterinherited
usePositionSticky bool
Whether to use position: sticky and multithreaded scrolling.
finalinherited
useTouchGestureListener bool
Whether to use GestureListener to override the native browser smooth scrolling on touch devices.
finalinherited

Methods

calcViewportRect() Rectangle<num>
Returns absolute positions of the visible frame.
inherited
dispose() → void
Disposes this disposable and any resources it has open.
inherited
ngOnDestroy() → void
Executed before the directive is removed from the DOM and destroyed.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onIntersection(Element? element) Stream<IntersectionObserverEntry?>
A stream which fires when element intersects with the scroll viewport.
inherited
scrollToPosition(int newPosition) → void
Scrolls the scrollbar into the new position.
inherited
scrollWithDelta(int delta) → void
Scrolls the scrollbar with the given delta.
inherited
startNativeScrollListener() → void
Start intercepting events that would cause scrolling.
inherited
stopEvent(WheelEvent event) → void
Stop an event.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited