{
  "id": "api/common/ViewportScroller",
  "title": "ViewportScroller",
  "contents": "\n\n<article>\n  <div class=\"breadcrumb-container\">\n    <div class=\"breadcrumb\">\n      <script type=\"application/ld+json\">\n        {\n          \"@context\": \"http://schema.org\",\n          \"@type\": \"BreadcrumbList\",\n          \"itemListElement\": [\n            { \"@type\": \"ListItem\", \"position\": 1, \"item\": { \"@id\": \"https://angular.io//api\", \"name\": \"API\" } },\n            { \"@type\": \"ListItem\", \"position\": 2, \"item\": { \"@id\": \"https://angular.io/api/common\", \"name\": \"@angular/common\" } },\n            { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://angular.io/api/common/ViewportScroller\", \"name\": \"ViewportScroller\" } }\n          ]\n        }\n      </script>\n        <a href=\"/api\">API</a> > <a href=\"api/common\">@angular/common</a>\n    </div>\n    <div class=\"github-links\">\n  <a href=\"https://github.com/angular/angular/edit/master/packages/common/src/viewport_scroller.ts?message=docs(common)%3A%20describe%20your%20change...#L12-L62\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n  <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/src/viewport_scroller.ts#L12-L62\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n  </div>\n  \n  <header class=\"api-header\">\n    <h1 id=\"viewportscroller\">ViewportScroller<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/ViewportScroller#viewportscroller\"><i class=\"material-icons\">link</i></a></h1>\n    \n    <label class=\"api-type-label class\">class</label>\n    \n    \n    \n  </header>\n  \n  <aio-toc class=\"embedded\"></aio-toc>\n\n  <div class=\"api-body\">\n    \n  <section class=\"short-description\">\n    <p>Defines a scroll position manager. Implemented by <code>BrowserViewportScroller</code>.</p>\n\n    \n  </section>\n  \n  \n  \n  <section class=\"class-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\nabstract class <a href=\"api/common/ViewportScroller\" class=\"code-anchor\">ViewportScroller</a> {\n  <a class=\"code-anchor\" href=\"api/common/ViewportScroller#setOffset\">abstract <span class=\"member-name\">setOffset</span>(offset: [number, number] | (() => [number, number])): void</a>\n  <a class=\"code-anchor\" href=\"api/common/ViewportScroller#getScrollPosition\">abstract <span class=\"member-name\">getScrollPosition</span>(): [number, number]</a>\n  <a class=\"code-anchor\" href=\"api/common/ViewportScroller#scrollToPosition\">abstract <span class=\"member-name\">scrollToPosition</span>(position: [number, number]): void</a>\n  <a class=\"code-anchor\" href=\"api/common/ViewportScroller#scrollToAnchor\">abstract <span class=\"member-name\">scrollToAnchor</span>(anchor: string): void</a>\n  <a class=\"code-anchor\" href=\"api/common/ViewportScroller#setHistoryScrollRestoration\">abstract <span class=\"member-name\">setHistoryScrollRestoration</span>(scrollRestoration: \"auto\" | \"manual\"): void</a>\n}\n</code-example>\n\n  \n  \n\n</section>\n\n\n  \n\n  \n  \n  \n\n\n\n\n\n\n\n\n\n\n\n\n<section class=\"instance-methods\">\n  <h2 id=\"methods\">Methods<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/ViewportScroller#methods\"><i class=\"material-icons\">link</i></a></h2>\n  \n    <a id=\"setOffset\"></a>\n<table class=\"is-full-width method-table instance-method\">\n  <thead><tr><th>\n    <div class=\"with-github-links\">\n    <h3 id=\"setoffset\">\n      setOffset()\n      \n    <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/ViewportScroller#setoffset\"><i class=\"material-icons\">link</i></a></h3>\n    <div class=\"github-links\">\n  <a href=\"https://github.com/angular/angular/edit/master/packages/common/src/viewport_scroller.ts?message=docs(common)%3A%20describe%20your%20change...#L29-L36\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n  <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/src/viewport_scroller.ts#L29-L36\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n    </div>\n  </th></tr></thead>\n  <tbody>\n    <tr>\n      <td class=\"short-description\">\n        <p>Configures the top offset used when scrolling to an anchor.</p>\n\n      </td>\n    </tr>\n  \n    <tr>\n      <td>\n        <div class=\"overload-info\">\n  \n\n  <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\">abstract <span class=\"member-name\">setOffset</span>(offset: [number, number] | (() => [number, number])): void</code-example>\n\n  \n\n  <h6 class=\"no-anchor\" id=\"parameters\">Parameters</h6>\n  <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n  <tbody>\n  \n    <tr class=\"instance-method-overload-parameter\">\n      <td class=\"param-name\">\n        <a id=\"\"></a>\n        <code>offset</code>\n      </td>\n      <td class=\"param-type\"><code>[number, number] | (() => [number, number])</code></td>\n      <td class=\"param-description\">\n      <p>A position in screen coordinates (a tuple with x and y values)\nor a function that returns the top offset position.</p>\n\n      </td>\n    </tr>\n  </tbody>\n</table>\n\n  \n  <h6 class=\"no-anchor\" id=\"returns\">Returns</h6>\n  <p><code>void</code></p>\n\n  \n\n\n  \n\n  \n</div>\n      </td>\n    </tr>\n  \n\n  \n\n  \n    </tbody>\n</table>\n\n  \n    <a id=\"getScrollPosition\"></a>\n<table class=\"is-full-width method-table instance-method\">\n  <thead><tr><th>\n    <div class=\"with-github-links\">\n    <h3 id=\"getscrollposition\">\n      getScrollPosition()\n      \n    <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/ViewportScroller#getscrollposition\"><i class=\"material-icons\">link</i></a></h3>\n    <div class=\"github-links\">\n  <a href=\"https://github.com/angular/angular/edit/master/packages/common/src/viewport_scroller.ts?message=docs(common)%3A%20describe%20your%20change...#L37-L42\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n  <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/src/viewport_scroller.ts#L37-L42\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n    </div>\n  </th></tr></thead>\n  <tbody>\n    <tr>\n      <td class=\"short-description\">\n        <p>Retrieves the current scroll position.</p>\n\n      </td>\n    </tr>\n  \n    <tr>\n      <td>\n        <div class=\"overload-info\">\n  \n\n  <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\">abstract <span class=\"member-name\">getScrollPosition</span>(): [number, number]</code-example>\n\n  \n\n  <h6 class=\"no-anchor\" id=\"parameters-1\">Parameters</h6>\n  <p>There are no parameters.</p>\n\n  \n  <h6 class=\"no-anchor\" id=\"returns-1\">Returns</h6>\n  <p><code>[number, number]</code>: A position in screen coordinates (a tuple with x and y values).</p>\n\n  \n\n\n  \n\n  \n</div>\n      </td>\n    </tr>\n  \n\n  \n\n  \n    </tbody>\n</table>\n\n  \n    <a id=\"scrollToPosition\"></a>\n<table class=\"is-full-width method-table instance-method\">\n  <thead><tr><th>\n    <div class=\"with-github-links\">\n    <h3 id=\"scrolltoposition\">\n      scrollToPosition()\n      \n    <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/ViewportScroller#scrolltoposition\"><i class=\"material-icons\">link</i></a></h3>\n    <div class=\"github-links\">\n  <a href=\"https://github.com/angular/angular/edit/master/packages/common/src/viewport_scroller.ts?message=docs(common)%3A%20describe%20your%20change...#L43-L48\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n  <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/src/viewport_scroller.ts#L43-L48\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n    </div>\n  </th></tr></thead>\n  <tbody>\n    <tr>\n      <td class=\"short-description\">\n        <p>Scrolls to a specified position.</p>\n\n      </td>\n    </tr>\n  \n    <tr>\n      <td>\n        <div class=\"overload-info\">\n  \n\n  <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\">abstract <span class=\"member-name\">scrollToPosition</span>(position: [number, number]): void</code-example>\n\n  \n\n  <h6 class=\"no-anchor\" id=\"parameters-2\">Parameters</h6>\n  <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n  <tbody>\n  \n    <tr class=\"instance-method-overload-parameter\">\n      <td class=\"param-name\">\n        <a id=\"\"></a>\n        <code>position</code>\n      </td>\n      <td class=\"param-type\"><code>[number, number]</code></td>\n      <td class=\"param-description\">\n      <p>A position in screen coordinates (a tuple with x and y values).</p>\n\n      </td>\n    </tr>\n  </tbody>\n</table>\n\n  \n  <h6 class=\"no-anchor\" id=\"returns-2\">Returns</h6>\n  <p><code>void</code></p>\n\n  \n\n\n  \n\n  \n</div>\n      </td>\n    </tr>\n  \n\n  \n\n  \n    </tbody>\n</table>\n\n  \n    <a id=\"scrollToAnchor\"></a>\n<table class=\"is-full-width method-table instance-method\">\n  <thead><tr><th>\n    <div class=\"with-github-links\">\n    <h3 id=\"scrolltoanchor\">\n      scrollToAnchor()\n      \n    <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/ViewportScroller#scrolltoanchor\"><i class=\"material-icons\">link</i></a></h3>\n    <div class=\"github-links\">\n  <a href=\"https://github.com/angular/angular/edit/master/packages/common/src/viewport_scroller.ts?message=docs(common)%3A%20describe%20your%20change...#L49-L54\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n  <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/src/viewport_scroller.ts#L49-L54\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n    </div>\n  </th></tr></thead>\n  <tbody>\n    <tr>\n      <td class=\"short-description\">\n        <p>Scrolls to an anchor element.</p>\n\n      </td>\n    </tr>\n  \n    <tr>\n      <td>\n        <div class=\"overload-info\">\n  \n\n  <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\">abstract <span class=\"member-name\">scrollToAnchor</span>(anchor: string): void</code-example>\n\n  \n\n  <h6 class=\"no-anchor\" id=\"parameters-3\">Parameters</h6>\n  <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n  <tbody>\n  \n    <tr class=\"instance-method-overload-parameter\">\n      <td class=\"param-name\">\n        <a id=\"\"></a>\n        <code>anchor</code>\n      </td>\n      <td class=\"param-type\"><code>string</code></td>\n      <td class=\"param-description\">\n      <p>The ID of the anchor element.</p>\n\n      </td>\n    </tr>\n  </tbody>\n</table>\n\n  \n  <h6 class=\"no-anchor\" id=\"returns-3\">Returns</h6>\n  <p><code>void</code></p>\n\n  \n\n\n  \n\n  \n</div>\n      </td>\n    </tr>\n  \n\n  \n\n  \n    </tbody>\n</table>\n\n  \n    <a id=\"setHistoryScrollRestoration\"></a>\n<table class=\"is-full-width method-table instance-method\">\n  <thead><tr><th>\n    <div class=\"with-github-links\">\n    <h3 id=\"sethistoryscrollrestoration\">\n      setHistoryScrollRestoration()\n      \n    <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/common/ViewportScroller#sethistoryscrollrestoration\"><i class=\"material-icons\">link</i></a></h3>\n    <div class=\"github-links\">\n  <a href=\"https://github.com/angular/angular/edit/master/packages/common/src/viewport_scroller.ts?message=docs(common)%3A%20describe%20your%20change...#L55-L61\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n  <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/src/viewport_scroller.ts#L55-L61\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n    </div>\n  </th></tr></thead>\n  <tbody>\n    <tr>\n      <td class=\"short-description\">\n        <p>Disables automatic scroll restoration provided by the browser.\nSee also <a href=\"https://developers.google.com/web/updates/2015/09/history-api-scroll-restoration\">window.history.scrollRestoration\ninfo</a>.</p>\n\n      </td>\n    </tr>\n  \n    <tr>\n      <td>\n        <div class=\"overload-info\">\n  \n\n  <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\">abstract <span class=\"member-name\">setHistoryScrollRestoration</span>(scrollRestoration: \"auto\" | \"manual\"): void</code-example>\n\n  \n\n  <h6 class=\"no-anchor\" id=\"parameters-4\">Parameters</h6>\n  <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n  <tbody>\n  \n    <tr class=\"instance-method-overload-parameter\">\n      <td class=\"param-name\">\n        <a id=\"\"></a>\n        <code>scrollRestoration</code>\n      </td>\n      <td class=\"param-type\"><code>\"auto\" | \"manual\"</code></td>\n      <td class=\"param-description\">\n                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     \n                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               \n      </td>\n    </tr>\n  </tbody>\n</table>\n\n  \n  <h6 class=\"no-anchor\" id=\"returns-4\">Returns</h6>\n  <p><code>void</code></p>\n\n  \n\n\n  \n\n  \n</div>\n      </td>\n    </tr>\n  \n\n  \n\n  \n    </tbody>\n</table>\n\n  \n</section>\n\n\n\n  \n\n\n  </div>\n</article>\n\n<!-- links to this doc:\n - api/common\n - api/platform-server/ServerModule\n - api/router/ExtraOptions\n-->\n<!-- links from this doc:\n - /api\n - api/common\n - api/common/ViewportScroller#getScrollPosition\n - api/common/ViewportScroller#getscrollposition\n - api/common/ViewportScroller#methods\n - api/common/ViewportScroller#scrollToAnchor\n - api/common/ViewportScroller#scrollToPosition\n - api/common/ViewportScroller#scrolltoanchor\n - api/common/ViewportScroller#scrolltoposition\n - api/common/ViewportScroller#setHistoryScrollRestoration\n - api/common/ViewportScroller#setOffset\n - api/common/ViewportScroller#sethistoryscrollrestoration\n - api/common/ViewportScroller#setoffset\n - api/common/ViewportScroller#viewportscroller\n - https://developers.google.com/web/updates/2015/09/history-api-scroll-restoration\n - https://github.com/angular/angular/edit/master/packages/common/src/viewport_scroller.ts?message=docs(common)%3A%20describe%20your%20change...#L12-L62\n - https://github.com/angular/angular/edit/master/packages/common/src/viewport_scroller.ts?message=docs(common)%3A%20describe%20your%20change...#L29-L36\n - https://github.com/angular/angular/edit/master/packages/common/src/viewport_scroller.ts?message=docs(common)%3A%20describe%20your%20change...#L37-L42\n - https://github.com/angular/angular/edit/master/packages/common/src/viewport_scroller.ts?message=docs(common)%3A%20describe%20your%20change...#L43-L48\n - https://github.com/angular/angular/edit/master/packages/common/src/viewport_scroller.ts?message=docs(common)%3A%20describe%20your%20change...#L49-L54\n - https://github.com/angular/angular/edit/master/packages/common/src/viewport_scroller.ts?message=docs(common)%3A%20describe%20your%20change...#L55-L61\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/src/viewport_scroller.ts#L12-L62\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/src/viewport_scroller.ts#L29-L36\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/src/viewport_scroller.ts#L37-L42\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/src/viewport_scroller.ts#L43-L48\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/src/viewport_scroller.ts#L49-L54\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/common/src/viewport_scroller.ts#L55-L61\n-->"
}