5 lines
13 KiB
JSON
5 lines
13 KiB
JSON
{
|
|
"id": "api/router/UrlSegmentGroup",
|
|
"title": "UrlSegmentGroup",
|
|
"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/UrlSegmentGroup\", \"name\": \"UrlSegmentGroup\" } }\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/url_tree.ts?message=docs(router)%3A%20describe%20your%20change...#L215-L255\" 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/url_tree.ts#L215-L255\" 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=\"urlsegmentgroup\">UrlSegmentGroup<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/UrlSegmentGroup#urlsegmentgroup\"><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>Represents the parsed URL segment group.</p>\n\n <p><a href=\"api/router/UrlSegmentGroup#description\">See more...</a></p>\n </section>\n \n \n \n <section class=\"class-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\nclass <a href=\"api/router/UrlSegmentGroup\" class=\"code-anchor\">UrlSegmentGroup</a> {\n <a class=\"code-anchor\" href=\"api/router/UrlSegmentGroup#constructor()\"><span class=\"member-name\">constructor</span>(segments: UrlSegment[], children: { [key: string]: UrlSegmentGroup; })</a>\n <a class=\"code-anchor\" href=\"api/router/UrlSegmentGroup#parent\"><span class=\"member-name\">parent</span>: UrlSegmentGroup | null</a>\n <a class=\"code-anchor\" href=\"api/router/UrlSegmentGroup#segments\"><span class=\"member-name\">segments</span>: UrlSegment[]</a>\n <a class=\"code-anchor\" href=\"api/router/UrlSegmentGroup#children\"><span class=\"member-name\">children</span>: {...}</a>\n <a class=\"code-anchor\" href=\"api/router/UrlSegmentGroup#numberOfChildren\"><span class=\"member-name\">numberOfChildren</span>: number</a>\n <a class=\"code-anchor\" href=\"api/router/UrlSegmentGroup#hasChildren\"><span class=\"member-name\">hasChildren</span>(): boolean</a>\n <a class=\"code-anchor\" href=\"api/router/UrlSegmentGroup#toString\"><span class=\"member-name\">toString</span>(): string</a>\n}\n</code-example>\n\n \n \n\n</section>\n\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/UrlSegmentGroup#description\"><i class=\"material-icons\">link</i></a></h2>\n <p>See <code><a href=\"api/router/UrlTree\" class=\"code-anchor\">UrlTree</a></code> for more information.</p>\n\n \n</section>\n\n \n\n\n\n\n\n\n<h2 id=\"constructor\">Constructor<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/UrlSegmentGroup#constructor\"><i class=\"material-icons\">link</i></a></h2>\n<a id=\"constructor()\"></a>\n<table class=\"is-full-width method-table constructor\">\n \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\">constructor</span>(segments: <a href=\"api/router/UrlSegment\" class=\"code-anchor\">UrlSegment</a>[], children: { [key: string]: <a href=\"api/router/UrlSegmentGroup\" class=\"code-anchor\">UrlSegmentGroup</a>; })</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table constructor-overload-parameters\">\n <tbody>\n \n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>segments</code>\n </td>\n <td class=\"param-type\"><code><a href=\"api/router/UrlSegment\" class=\"code-anchor\">UrlSegment</a>[]</code></td>\n <td class=\"param-description\">\n <p>The URL segments of this group. See <code><a href=\"api/router/UrlSegment\" class=\"code-anchor\">UrlSegment</a></code> for more information</p>\n \n </td>\n </tr>\n <tr class=\"constructor-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>children</code>\n </td>\n <td class=\"param-type\"><code>object</code></td>\n <td class=\"param-description\">\n <p>The list of children of this group</p>\n \n </td>\n </tr>\n </tbody>\n</table>\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\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/UrlSegmentGroup#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=\"parent\"></a>\n <code class=\"\"><span class=\"member-name\">parent</span>: <a href=\"api/router/UrlSegmentGroup\" class=\"code-anchor\">UrlSegmentGroup</a> | null</code>\n </td>\n <td>\n \n <p>The parent node in the url tree</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"segments\"></a>\n <code class=\"\"><span class=\"member-name\">segments</span>: <a href=\"api/router/UrlSegment\" class=\"code-anchor\">UrlSegment</a>[]</code>\n </td>\n <td>\n <span class=\"from-constructor\">Declared in Constructor</span>\n <p>The URL segments of this group. See <code><a href=\"api/router/UrlSegment\" class=\"code-anchor\">UrlSegment</a></code> for more information</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>: {\n [key: string]: <a href=\"api/router/UrlSegmentGroup\" class=\"code-anchor\">UrlSegmentGroup</a>;\n}</code>\n </td>\n <td>\n <span class=\"from-constructor\">Declared in Constructor</span>\n <p>The list of children of this group</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"numberOfChildren\"></a>\n <code class=\"\"><span class=\"member-name\">numberOfChildren</span>: number</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>Number of child segments</p>\n\n \n </td>\n </tr>\n \n </tbody>\n </table>\n</section>\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/router/UrlSegmentGroup#methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"hasChildren\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"haschildren\">\n hasChildren()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/router/UrlSegmentGroup#haschildren\"><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/url_tree.ts?message=docs(router)%3A%20describe%20your%20change...#L240-L244\" 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/url_tree.ts#L240-L244\" 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>Whether the segment has child segments</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\"><span class=\"member-name\">hasChildren</span>(): boolean</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\">Returns</h6>\n <p><code>boolean</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=\"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/UrlSegmentGroup#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/url_tree.ts?message=docs(router)%3A%20describe%20your%20change...#L250-L254\" 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/url_tree.ts#L250-L254\" 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-2\">Parameters</h6>\n <p>There are no parameters.</p>\n\n \n <h6 class=\"no-anchor\" id=\"returns-1\">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\n </div>\n</article>\n\n<!-- links to this doc:\n - api/router\n - api/router/UrlMatcher\n - api/router/UrlSegment\n - api/router/UrlTree\n-->\n<!-- links from this doc:\n - /api\n - api/router\n - api/router/UrlSegment\n - api/router/UrlSegmentGroup#children\n - api/router/UrlSegmentGroup#constructor\n - api/router/UrlSegmentGroup#constructor()\n - api/router/UrlSegmentGroup#description\n - api/router/UrlSegmentGroup#hasChildren\n - api/router/UrlSegmentGroup#haschildren\n - api/router/UrlSegmentGroup#methods\n - api/router/UrlSegmentGroup#numberOfChildren\n - api/router/UrlSegmentGroup#parent\n - api/router/UrlSegmentGroup#properties\n - api/router/UrlSegmentGroup#segments\n - api/router/UrlSegmentGroup#toString\n - api/router/UrlSegmentGroup#tostring\n - api/router/UrlSegmentGroup#urlsegmentgroup\n - api/router/UrlTree\n - https://github.com/angular/angular/edit/master/packages/router/src/url_tree.ts?message=docs(router)%3A%20describe%20your%20change...#L215-L255\n - https://github.com/angular/angular/edit/master/packages/router/src/url_tree.ts?message=docs(router)%3A%20describe%20your%20change...#L240-L244\n - https://github.com/angular/angular/edit/master/packages/router/src/url_tree.ts?message=docs(router)%3A%20describe%20your%20change...#L250-L254\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/url_tree.ts#L215-L255\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/url_tree.ts#L240-L244\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/router/src/url_tree.ts#L250-L254\n-->"
|
|
} |