5 lines
18 KiB
JSON
5 lines
18 KiB
JSON
{
|
|
"id": "api/router/ActivatedRoute",
|
|
"title": "ActivatedRoute",
|
|
"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/router\", \"name\": \"@angular/router\" } },\n { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://angular.io/api/router/ActivatedRoute\", \"name\": \"ActivatedRoute\" } }\n ]\n }\n </script>\n <a href=\"/api\">API</a> > <a href=\"api/router\">@angular/router</a>\n </div>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/router/src/router_state.ts?message=docs(router)%3A%20describe%20your%20change...#L92-L197\" 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/router/src/router_state.ts#L92-L197\" 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=\"activatedroute\">ActivatedRoute<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/ActivatedRoute#activatedroute\"><i class=\"material-icons\">link</i></a></h1>\n \n <label class=\"api-type-label interface\">interface</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>Provides access to information about a route associated with a component\nthat is loaded in an outlet.\nUse to traverse the <code><a href=\"api/router/RouterState\" class=\"code-anchor\">RouterState</a></code> tree and extract information from nodes.</p>\n\n <p><a href=\"api/router/ActivatedRoute#description\">See more...</a></p>\n </section>\n \n \n <section class=\"interface-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\ninterface <a href=\"api/router/ActivatedRoute\" class=\"code-anchor\">ActivatedRoute</a> {\n <a class=\"code-anchor\" href=\"api/router/ActivatedRoute#snapshot\"><span class=\"member-name\">snapshot</span>: ActivatedRouteSnapshot</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRoute#url\"><span class=\"member-name\">url</span>: Observable<UrlSegment[]></a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRoute#params\"><span class=\"member-name\">params</span>: Observable<Params></a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRoute#queryParams\"><span class=\"member-name\">queryParams</span>: Observable<Params></a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRoute#fragment\"><span class=\"member-name\">fragment</span>: Observable<string | null></a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRoute#data\"><span class=\"member-name\">data</span>: Observable<Data></a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRoute#outlet\"><span class=\"member-name\">outlet</span>: string</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRoute#component\"><span class=\"member-name\">component</span>: Type<any> | string | null</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRoute#routeConfig\"><span class=\"member-name\">routeConfig</span>: Route | null</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRoute#root\"><span class=\"member-name\">root</span>: ActivatedRoute</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRoute#parent\"><span class=\"member-name\">parent</span>: ActivatedRoute | null</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRoute#firstChild\"><span class=\"member-name\">firstChild</span>: ActivatedRoute | null</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRoute#children\"><span class=\"member-name\">children</span>: ActivatedRoute[]</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRoute#pathFromRoot\"><span class=\"member-name\">pathFromRoot</span>: ActivatedRoute[]</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRoute#paramMap\"><span class=\"member-name\">paramMap</span>: Observable<ParamMap></a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRoute#queryParamMap\"><span class=\"member-name\">queryParamMap</span>: Observable<ParamMap></a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRoute#toString\"><span class=\"member-name\">toString</span>(): string</a>\n}\n</code-example>\n\n \n \n\n\n \n \n\n</section>\n\n \n<section class=\"see-also\">\n <h2 id=\"see-also\">See also<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/ActivatedRoute#see-also\"><i class=\"material-icons\">link</i></a></h2>\n <ul>\n \n <li><p><a href=\"guide/router#getting-route-information\">Getting route information</a></p>\n</li>\n </ul>\n</section>\n\n\n \n \n<section class=\"description\">\n <h2 id=\"description\">Description<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/ActivatedRoute#description\"><i class=\"material-icons\">link</i></a></h2>\n <p>The following example shows how to construct a component using information from a\ncurrently activated route.</p>\n<code-example path=\"router/activated-route/module.ts\" region=\"activated-route\" header=\"activated-route.component.ts\">\nimport {<a href=\"api/core/Component\" class=\"code-anchor\">Component</a>} from '@angular/core';\n/* . . . */\nimport {<a href=\"api/router/ActivatedRoute\" class=\"code-anchor\">ActivatedRoute</a>} from '@angular/router';\nimport {Observable} from 'rxjs';\nimport {map} from 'rxjs/operators';\n/* . . . */\n\n@<a href=\"api/core/Component\" class=\"code-anchor\">Component</a>({\n/* . . . */\n})\nexport class ActivatedRouteComponent {\n constructor(route: <a href=\"api/router/ActivatedRoute\" class=\"code-anchor\">ActivatedRoute</a>) {\n const id: Observable<string> = route.params.pipe(map(p => p.id));\n const url: Observable<string> = route.url.pipe(map(segments => segments.join('')));\n // route.data includes both `data` and `resolve`\n const user = route.data.pipe(map(d => d.user));\n }\n}\n\n</code-example>\n\n \n</section>\n\n \n<section class=\"instance-properties\">\n <h2 id=\"properties\">Properties<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/ActivatedRoute#properties\"><i class=\"material-icons\">link</i></a></h2>\n <table class=\"is-full-width list-table property-table\">\n <thead>\n <tr>\n <th>Property</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"snapshot\"></a>\n <code class=\"\"><span class=\"member-name\">snapshot</span>: <a href=\"api/router/ActivatedRouteSnapshot\" class=\"code-anchor\">ActivatedRouteSnapshot</a></code>\n </td>\n <td>\n \n <p>The current snapshot of this route</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"url\"></a>\n <code class=\"\"><span class=\"member-name\">url</span>: Observable<<a href=\"api/router/UrlSegment\" class=\"code-anchor\">UrlSegment</a>[]></code>\n </td>\n <td>\n \n <p>An observable of the URL segments matched by this route.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"params\"></a>\n <code class=\"\"><span class=\"member-name\">params</span>: Observable<<a href=\"api/router/Params\" class=\"code-anchor\">Params</a>></code>\n </td>\n <td>\n \n <p>An observable of the matrix parameters scoped to this route.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"queryParams\"></a>\n <code class=\"\"><span class=\"member-name\">queryParams</span>: Observable<<a href=\"api/router/Params\" class=\"code-anchor\">Params</a>></code>\n </td>\n <td>\n \n <p>An observable of the query parameters shared by all the routes.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"fragment\"></a>\n <code class=\"\"><span class=\"member-name\">fragment</span>: Observable<string | null></code>\n </td>\n <td>\n \n <p>An observable of the URL fragment shared by all the routes.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"data\"></a>\n <code class=\"\"><span class=\"member-name\">data</span>: Observable<<a href=\"api/router/Data\" class=\"code-anchor\">Data</a>></code>\n </td>\n <td>\n \n <p>An observable of the static and resolved data of this route.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"outlet\"></a>\n <code class=\"\"><span class=\"member-name\">outlet</span>: string</code>\n </td>\n <td>\n \n <p>The outlet name of the route, a constant.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"component\"></a>\n <code class=\"\"><span class=\"member-name\">component</span>: <a href=\"api/core/Type\" class=\"code-anchor\">Type</a><any> | string | null</code>\n </td>\n <td>\n \n <p>The component of the route, a constant.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"routeConfig\"></a>\n <code class=\"\"><span class=\"member-name\">routeConfig</span>: <a href=\"api/router/Route\" class=\"code-anchor\">Route</a> | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>The configuration used to match this route.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"root\"></a>\n <code class=\"\"><span class=\"member-name\">root</span>: <a href=\"api/router/ActivatedRoute\" class=\"code-anchor\">ActivatedRoute</a></code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>The root of the router state.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"parent\"></a>\n <code class=\"\"><span class=\"member-name\">parent</span>: <a href=\"api/router/ActivatedRoute\" class=\"code-anchor\">ActivatedRoute</a> | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>The parent of this route in the router state tree.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"firstChild\"></a>\n <code class=\"\"><span class=\"member-name\">firstChild</span>: <a href=\"api/router/ActivatedRoute\" class=\"code-anchor\">ActivatedRoute</a> | null</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>The first child of this route in the router state tree.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"children\"></a>\n <code class=\"\"><span class=\"member-name\">children</span>: <a href=\"api/router/ActivatedRoute\" class=\"code-anchor\">ActivatedRoute</a>[]</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>The children of this route in the router state tree.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"pathFromRoot\"></a>\n <code class=\"\"><span class=\"member-name\">pathFromRoot</span>: <a href=\"api/router/ActivatedRoute\" class=\"code-anchor\">ActivatedRoute</a>[]</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>The path from the root of the router state tree to this route.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"paramMap\"></a>\n <code class=\"\"><span class=\"member-name\">paramMap</span>: Observable<<a href=\"api/router/ParamMap\" class=\"code-anchor\">ParamMap</a>></code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>An Observable that contains a map of the required and optional parameters\nspecific to the route.\nThe map supports retrieving single and multiple values from the same parameter.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"queryParamMap\"></a>\n <code class=\"\"><span class=\"member-name\">queryParamMap</span>: Observable<<a href=\"api/router/ParamMap\" class=\"code-anchor\">ParamMap</a>></code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>An Observable that contains a map of the query parameters available to all routes.\nThe map supports retrieving single and multiple values from the query parameter.</p>\n\n \n </td>\n </tr>\n \n </tbody>\n </table>\n</section>\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/router/ActivatedRoute#methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"toString\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"tostring\">\n toString()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/ActivatedRoute#tostring\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/router/src/router_state.ts?message=docs(router)%3A%20describe%20your%20change...#L193-L196\" 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/router/src/router_state.ts#L193-L196\" 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 \n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">toString</span>(): string</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters\">Parameters</h6>\n <p>There are no parameters.</p>\n\n \n <h6 class=\"no-anchor\" id=\"returns\">Returns</h6>\n <p><code>string</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 </div>\n</article>\n\n<!-- links to this doc:\n - api/router\n - api/router/ActivatedRouteSnapshot\n - api/router/OutletContext\n - api/router/Route\n - api/router/RouterLink\n - api/router/RouterLinkWithHref\n - api/router/RouterOutlet\n - api/router/RouterOutletContract\n - api/router/RouterState\n - api/router/UrlCreationOptions\n - guide/deprecations\n - guide/lazy-loading-ngmodules\n - guide/observables-in-angular\n - guide/router\n - guide/router-tutorial-toh\n - guide/testing-components-scenarios\n - guide/upgrade\n - start/start-data\n - start/start-routing\n - tutorial/toh-pt5\n - tutorial/toh-pt6\n-->\n<!-- links from this doc:\n - /api\n - api/core/Component\n - api/core/Type\n - api/router\n - api/router/ActivatedRoute#activatedroute\n - api/router/ActivatedRoute#children\n - api/router/ActivatedRoute#component\n - api/router/ActivatedRoute#data\n - api/router/ActivatedRoute#description\n - api/router/ActivatedRoute#firstChild\n - api/router/ActivatedRoute#fragment\n - api/router/ActivatedRoute#methods\n - api/router/ActivatedRoute#outlet\n - api/router/ActivatedRoute#paramMap\n - api/router/ActivatedRoute#params\n - api/router/ActivatedRoute#parent\n - api/router/ActivatedRoute#pathFromRoot\n - api/router/ActivatedRoute#properties\n - api/router/ActivatedRoute#queryParamMap\n - api/router/ActivatedRoute#queryParams\n - api/router/ActivatedRoute#root\n - api/router/ActivatedRoute#routeConfig\n - api/router/ActivatedRoute#see-also\n - api/router/ActivatedRoute#snapshot\n - api/router/ActivatedRoute#toString\n - api/router/ActivatedRoute#tostring\n - api/router/ActivatedRoute#url\n - api/router/ActivatedRouteSnapshot\n - api/router/Data\n - api/router/ParamMap\n - api/router/Params\n - api/router/Route\n - api/router/RouterState\n - api/router/UrlSegment\n - guide/router#getting-route-information\n - https://github.com/angular/angular/edit/master/packages/router/src/router_state.ts?message=docs(router)%3A%20describe%20your%20change...#L193-L196\n - https://github.com/angular/angular/edit/master/packages/router/src/router_state.ts?message=docs(router)%3A%20describe%20your%20change...#L92-L197\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/router_state.ts#L193-L196\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/router_state.ts#L92-L197\n-->"
|
|
} |