W3cubDocs

/Angular 10

ViewportScroller

class

Defines a scroll position manager. Implemented by BrowserViewportScroller.

abstract class ViewportScroller {
  abstract setOffset(offset: [number, number] | (() => [number, number])): void
  abstract getScrollPosition(): [number, number]
  abstract scrollToPosition(position: [number, number]): void
  abstract scrollToAnchor(anchor: string): void
  abstract setHistoryScrollRestoration(scrollRestoration: "auto" | "manual"): void
}

Methods

setOffset()

Configures the top offset used when scrolling to an anchor.

abstract setOffset(offset: [number, number] | (() => [number, number])): void

Parameters
offset [number, number] | (() => [number, number])

A position in screen coordinates (a tuple with x and y values) or a function that returns the top offset position.
Returns

void
getScrollPosition()

Retrieves the current scroll position.

abstract getScrollPosition(): [number, number]

Parameters

There are no parameters.

Returns

[number, number]: A position in screen coordinates (a tuple with x and y values).
scrollToPosition()

Scrolls to a specified position.

abstract scrollToPosition(position: [number, number]): void

Parameters
position [number, number]

A position in screen coordinates (a tuple with x and y values).
Returns

void
scrollToAnchor()

Scrolls to an anchor element.

abstract scrollToAnchor(anchor: string): void

Parameters
anchor string

The ID of the anchor element.
Returns

void
setHistoryScrollRestoration()

Disables automatic scroll restoration provided by the browser. See also window.history.scrollRestoration info.

abstract setHistoryScrollRestoration(scrollRestoration: "auto" | "manual"): void

Parameters
scrollRestoration "auto" | "manual"
Returns

void

© 2010–2020 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://v10.angular.io/api/common/ViewportScroller