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])): voidParameters
Returns
|
getScrollPosition() |
---|
Retrieves the current scroll position. |
abstract getScrollPosition(): [number, number]ParametersThere are no parameters. Returns
|
scrollToPosition() | |||
---|---|---|---|
Scrolls to a specified position. | |||
abstract scrollToPosition(position: [number, number]): voidParameters
Returns
|
scrollToAnchor() | |||
---|---|---|---|
Scrolls to an anchor element. | |||
abstract scrollToAnchor(anchor: string): voidParameters
Returns
|
setHistoryScrollRestoration() | |||
---|---|---|---|
Disables automatic scroll restoration provided by the browser. See also window.history.scrollRestoration info. | |||
abstract setHistoryScrollRestoration(scrollRestoration: "auto" | "manual"): voidParameters
Returns
|
© 2010–2020 Google, Inc.
Licensed under the Creative Commons Attribution License 4.0.
https://v9.angular.io/api/common/ViewportScroller