5 lines
17 KiB
JSON
5 lines
17 KiB
JSON
{
|
|
"id": "api/router/ActivatedRouteSnapshot",
|
|
"title": "ActivatedRouteSnapshot",
|
|
"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/ActivatedRouteSnapshot\", \"name\": \"ActivatedRouteSnapshot\" } }\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...#L251-L382\" 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#L251-L382\" 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=\"activatedroutesnapshot\">ActivatedRouteSnapshot<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/ActivatedRouteSnapshot#activatedroutesnapshot\"><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>Contains the information about a route associated with a component loaded in an\noutlet at a particular moment in time. ActivatedRouteSnapshot can also be used to\ntraverse the router state tree.</p>\n\n <p><a href=\"api/router/ActivatedRouteSnapshot#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/ActivatedRouteSnapshot\" class=\"code-anchor\">ActivatedRouteSnapshot</a> {\n <a class=\"code-anchor\" href=\"api/router/ActivatedRouteSnapshot#routeConfig\"><span class=\"member-name\">routeConfig</span>: Route | null</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRouteSnapshot#url\"><span class=\"member-name\">url</span>: UrlSegment[]</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRouteSnapshot#params\"><span class=\"member-name\">params</span>: Params</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRouteSnapshot#queryParams\"><span class=\"member-name\">queryParams</span>: Params</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRouteSnapshot#fragment\"><span class=\"member-name\">fragment</span>: string | null</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRouteSnapshot#data\"><span class=\"member-name\">data</span>: Data</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRouteSnapshot#outlet\"><span class=\"member-name\">outlet</span>: string</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRouteSnapshot#component\"><span class=\"member-name\">component</span>: Type<any> | string | null</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRouteSnapshot#root\"><span class=\"member-name\">root</span>: ActivatedRouteSnapshot</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRouteSnapshot#parent\"><span class=\"member-name\">parent</span>: ActivatedRouteSnapshot | null</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRouteSnapshot#firstChild\"><span class=\"member-name\">firstChild</span>: ActivatedRouteSnapshot | null</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRouteSnapshot#children\"><span class=\"member-name\">children</span>: ActivatedRouteSnapshot[]</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRouteSnapshot#pathFromRoot\"><span class=\"member-name\">pathFromRoot</span>: ActivatedRouteSnapshot[]</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRouteSnapshot#paramMap\"><span class=\"member-name\">paramMap</span>: ParamMap</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRouteSnapshot#queryParamMap\"><span class=\"member-name\">queryParamMap</span>: ParamMap</a>\n <a class=\"code-anchor\" href=\"api/router/ActivatedRouteSnapshot#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\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/ActivatedRouteSnapshot#description\"><i class=\"material-icons\">link</i></a></h2>\n <p>The following example initializes a component with route information extracted\nfrom the snapshot of the root node at the time of creation.</p>\n<code-example>\n@<a href=\"api/core/Component\" class=\"code-anchor\">Component</a>({templateUrl:'./my-component.html'})\nclass MyComponent {\n constructor(route: <a href=\"api/router/ActivatedRoute\" class=\"code-anchor\">ActivatedRoute</a>) {\n const id: string = route.snapshot.params.id;\n const url: string = route.snapshot.url.join('');\n const user = route.snapshot.data.user;\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/ActivatedRouteSnapshot#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=\"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=\"url\"></a>\n <code class=\"\"><span class=\"member-name\">url</span>: <a href=\"api/router/UrlSegment\" class=\"code-anchor\">UrlSegment</a>[]</code>\n </td>\n <td>\n \n <p>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>: <a href=\"api/router/Params\" class=\"code-anchor\">Params</a></code>\n </td>\n <td>\n \n <p>The matrix parameters scoped to this route.</p>\n\n <p>You can compute all params (or data) in the router state or to get params outside\nof an activated component by traversing the <code><a href=\"api/router/RouterState\" class=\"code-anchor\">RouterState</a></code> tree as in the following\nexample:</p>\n<code-example>\ncollectRouteParams(router: <a href=\"api/router/Router\" class=\"code-anchor\">Router</a>) {\n let params = {};\n let stack: <a href=\"api/router/ActivatedRouteSnapshot\" class=\"code-anchor\">ActivatedRouteSnapshot</a>[] = [router.routerState.snapshot.root];\n while (stack.length > 0) {\n const route = stack.pop()!;\n params = {...params, ...route.params};\n stack.push(...route.children);\n }\n return params;\n}\n</code-example>\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>: <a href=\"api/router/Params\" class=\"code-anchor\">Params</a></code>\n </td>\n <td>\n \n <p>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>: string | null</code>\n </td>\n <td>\n \n <p>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>: <a href=\"api/router/Data\" class=\"code-anchor\">Data</a></code>\n </td>\n <td>\n \n <p>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</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</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/ActivatedRouteSnapshot\" class=\"code-anchor\">ActivatedRouteSnapshot</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/ActivatedRouteSnapshot\" class=\"code-anchor\">ActivatedRouteSnapshot</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/ActivatedRouteSnapshot\" class=\"code-anchor\">ActivatedRouteSnapshot</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/ActivatedRouteSnapshot\" class=\"code-anchor\">ActivatedRouteSnapshot</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/ActivatedRouteSnapshot\" class=\"code-anchor\">ActivatedRouteSnapshot</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>: <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 \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>: <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 \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/ActivatedRouteSnapshot#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/ActivatedRouteSnapshot#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...#L376-L381\" 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#L376-L381\" 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/ActivatedRoute\n - api/router/ActivationEnd\n - api/router/ActivationStart\n - api/router/BaseRouteReuseStrategy\n - api/router/CanActivate\n - api/router/CanActivateChild\n - api/router/CanDeactivate\n - api/router/ChildActivationEnd\n - api/router/ChildActivationStart\n - api/router/Resolve\n - api/router/RouteReuseStrategy\n - api/router/RouterStateSnapshot\n - api/router/RunGuardsAndResolvers\n - guide/lazy-loading-ngmodules\n - guide/router\n - guide/router-tutorial-toh\n - start/start-routing\n-->\n<!-- links from this doc:\n - /api\n - api/core/Component\n - api/core/Type\n - api/router\n - api/router/ActivatedRoute\n - api/router/ActivatedRouteSnapshot#activatedroutesnapshot\n - api/router/ActivatedRouteSnapshot#children\n - api/router/ActivatedRouteSnapshot#component\n - api/router/ActivatedRouteSnapshot#data\n - api/router/ActivatedRouteSnapshot#description\n - api/router/ActivatedRouteSnapshot#firstChild\n - api/router/ActivatedRouteSnapshot#fragment\n - api/router/ActivatedRouteSnapshot#methods\n - api/router/ActivatedRouteSnapshot#outlet\n - api/router/ActivatedRouteSnapshot#paramMap\n - api/router/ActivatedRouteSnapshot#params\n - api/router/ActivatedRouteSnapshot#parent\n - api/router/ActivatedRouteSnapshot#pathFromRoot\n - api/router/ActivatedRouteSnapshot#properties\n - api/router/ActivatedRouteSnapshot#queryParamMap\n - api/router/ActivatedRouteSnapshot#queryParams\n - api/router/ActivatedRouteSnapshot#root\n - api/router/ActivatedRouteSnapshot#routeConfig\n - api/router/ActivatedRouteSnapshot#toString\n - api/router/ActivatedRouteSnapshot#tostring\n - api/router/ActivatedRouteSnapshot#url\n - api/router/Data\n - api/router/ParamMap\n - api/router/Params\n - api/router/Route\n - api/router/Router\n - api/router/RouterState\n - api/router/UrlSegment\n - https://github.com/angular/angular/edit/master/packages/router/src/router_state.ts?message=docs(router)%3A%20describe%20your%20change...#L251-L382\n - https://github.com/angular/angular/edit/master/packages/router/src/router_state.ts?message=docs(router)%3A%20describe%20your%20change...#L376-L381\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/router_state.ts#L251-L382\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/router_state.ts#L376-L381\n-->"
|
|
} |