{ "id": "api/router/NavigationStart", "title": "NavigationStart", "contents": "\n\n
\n
\n
\n \n API > @angular/router\n
\n
\n mode_edit\n code\n
\n
\n \n
\n

NavigationStartlink

\n \n \n \n \n \n
\n \n \n\n
\n \n
\n

An event triggered when a navigation starts.

\n\n \n
\n \n \n \n
\n\nclass NavigationStart extends RouterEvent {\n constructor(id: number, url: string, navigationTrigger: \"imperative\" | \"popstate\" | \"hashchange\" = 'imperative', restoredState: { [k: string]: any; navigationId: number; } = null)\n navigationTrigger?: 'imperative' | 'popstate' | 'hashchange'\n restoredState?: {...}\n toString(): string\n\n // inherited from router/RouterEvent\n constructor(id: number, url: string)\n id: number\n url: string\n}\n\n\n \n \n\n
\n\n\n \n\n \n \n \n\n\n\n\n\n\n

Constructorlink

\n\n\n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n \n\n constructor(id: number, url: string, navigationTrigger: \"imperative\" | \"popstate\" | \"hashchange\" = 'imperative', restoredState: { [k: string]: any; navigationId: number; } = null)\n\n \n\n
Parameters
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n id\n number\n \n \n
\n \n url\n string\n \n \n
\n \n navigationTrigger\n \"imperative\" | \"popstate\" | \"hashchange\"\n

Optional. Default is 'imperative'.

\n \n
\n \n restoredState\n object\n

Optional. Default is null.

\n \n
\n\n \n\n\n \n\n \n
\n
\n\n\n\n\n
\n

Propertieslink

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
PropertyDescription
\n \n navigationTrigger?: 'imperative' | 'popstate' | 'hashchange'\n \n \n

Identifies the call or event that triggered the navigation.\nAn imperative trigger is a call to router.navigateByUrl() or router.navigate().

\n\n \n

See also:

\n \n \n
\n \n restoredState?: {\n [k: string]: any;\n navigationId: number;\n} | null\n \n \n

The navigation state that was previously supplied to the pushState call,\nwhen the navigation is triggered by a popstate event. Otherwise null.

\n\n

The state object is defined by NavigationExtras, and contains any\ndeveloper-defined state value, as well as a unique ID that\nthe router assigns to every router transition/navigation.

\n

From the perspective of the router, the router never \"goes back\".\nWhen the user clicks on the back button in the browser,\na new navigation ID is created.

\n

Use the ID in this previous-state object to differentiate between a newly created\nstate and one returned to by a popstate event, so that you can restore some\nremembered state, such as scroll position.

\n\n
\n
\n\n\n\n
\n

Methodslink

\n \n \n\n \n \n \n \n \n \n \n \n\n \n\n \n \n
\n
\n

\n toString()\n \n link

\n
\n mode_edit\n code\n
\n
\n
\n
\n \n\n toString(): string\n\n \n\n
Parameters
\n

There are no parameters.

\n\n \n
Returns
\n

string

\n\n \n\n\n \n\n \n
\n
\n\n \n
\n\n\n\n \n\n\n
\n
\n\n\n" }