NavGraph

Kotlin |Java

open class NavGraph : NavDestination, MutableIterable<NavDestination!>

kotlin.Any
↳	androidx.navigation.NavDestination
	↳	androidx.navigation.NavGraph

Known Direct Subclasses

DynamicGraphNavigator.DynamicNavGraph

The NavGraph for dynamic features.

NavGraph is a collection of NavDestination nodes fetchable by ID.

A NavGraph serves as a 'virtual' destination: while the NavGraph itself will not appear on the back stack, navigating to the NavGraph will cause the starting destination to be added to the back stack.

Summary

Public constructors
`<init>(@NonNull navGraphNavigator: Navigator<out NavGraph!>)` Construct a new NavGraph.

Public methods
Unit	`addAll(@NonNull other: NavGraph)` Add all destinations from another collection to this one.
Unit	`addDestination(@NonNull node: NavDestination)` Adds a destination to this NavGraph.
Unit	`addDestinations(@NonNull nodes: MutableCollection<NavDestination!>)` Adds multiple destinations to this NavGraph.
Unit	`addDestinations(@NonNull vararg nodes: NavDestination!)` Adds multiple destinations to this NavGraph.
Unit	`clear()` Clear all destinations from this navigation graph.
NavDestination?	`findNode(@IdRes resid: Int)` Finds a destination in the collection by ID.
Int	`getStartDestination()` Returns the starting destination for this NavGraph.
MutableIterator<NavDestination!>	`iterator()`
open Unit	`onInflate(@NonNull context: Context, @NonNull attrs: AttributeSet)`
Unit	`remove(@NonNull node: NavDestination)` Remove a given destination from this NavGraph
Unit	`setStartDestination(@IdRes startDestId: Int)` Sets the starting destination for this NavGraph.
open String	`toString()`

Inherited functions

From class NavDestination

`Unit`	`addArgument(@NonNull argumentName: String, @NonNull argument: NavArgument)` Sets an argument type for an argument name
`Unit`	`addDeepLink(@NonNull uriPattern: String)` Add a deep link to this destination. Matching Uris sent to `NavController#handleDeepLink(Intent)` or `NavController#navigate(Uri)` will trigger navigating to this destination. In addition to a direct Uri match, the following features are supported: Uris without a scheme are assumed as http and https. For example, `www.example.com` will match `http://www.example.com` and `https://www.example.com`. Placeholders in the form of `{placeholder_name}` matches 1 or more characters. The String value of the placeholder will be available in the arguments `Bundle` with a key of the same name. For example, `http://www.example.com/users/{id}` will match `http://www.example.com/users/4`. The `.*` wildcard can be used to match 0 or more characters. These Uris can be declared in your navigation XML files by adding one or more `<deepLink app:uri="uriPattern" />` elements as a child to your destination. Deep links added in navigation XML files will automatically replace instances of `${applicationId}` with the applicationId of your app. Programmatically added deep links should use `Context#getPackageName()` directly when constructing the uriPattern.
`Unit`	`addDeepLink(@NonNull navDeepLink: NavDeepLink)` Add a deep link to this destination. Uris that match the given `NavDeepLink` uri sent to `NavController#handleDeepLink(Intent)` or `NavController#navigate(NavDeepLinkRequest)` will trigger navigating to this destination. In addition to a direct Uri match, the following features are supported: Uris without a scheme are assumed as http and https. For example, `www.example.com` will match `http://www.example.com` and `https://www.example.com`. Placeholders in the form of `{placeholder_name}` matches 1 or more characters. The String value of the placeholder will be available in the arguments `Bundle` with a key of the same name. For example, `http://www.example.com/users/{id}` will match `http://www.example.com/users/4`. The `.` wildcard can be used to match 0 or more characters. These Uris can be declared in your navigation XML files by adding one or more `<deepLink app:uri="uriPattern" />` elements as a child to your destination. Custom actions and mimetypes are also supported by `NavDeepLink` and can be declared in your navigation XML files by adding `<app:action="android.intent.action.SOME_ACTION" />` or `<app:mimetype="type/subtype" />` as part of your deepLink declaration. Deep link Uris, actions, and mimetypes added in navigation XML files will automatically replace instances of `${applicationId}` with the applicationId of your app. Programmatically added deep links should use `Context#getPackageName()` directly when constructing the uriPattern. When matching deep links for calls to `NavController#handleDeepLink(Intent)` or `NavController#navigate(NavDeepLinkRequest)` the order of precedence is as follows: the deep link with the most matching arguments will be chosen, followed by the deep link with a matching action, followed by the best matching mimeType (e.i. when matching mimeType image/jpg: image/ > \/jpg > \/*).
`NavAction?`	`getAction(@IdRes id: Int)` Returns the destination ID for a given action. This will recursively check the `parent` of this destination if the action destination is not found in this destination.
`MutableMap<String!, NavArgument!>`	`getArguments()` Get the arguments supported by this destination. Returns a read-only map of argument names to `NavArgument` objects that can be used to check the type, default value and nullability of the argument. To add and remove arguments for this NavDestination use `addArgument(String, NavArgument)` and `removeArgument(String)`.
`Int`	`getId()` Returns the destination's unique ID. This should be an ID resource generated by the Android resource system.
`CharSequence?`	`getLabel()` Gets the descriptive label of this destination.
`String`	`getNavigatorName()` Returns the name associated with this destination's `Navigator`.
`NavGraph?`	`getParent()` Gets the `NavGraph` that contains this destination. This will be set when a destination is added to a NavGraph via `NavGraph#addDestination`.
`Boolean`	`hasDeepLink(@NonNull deepLink: Uri)` Checks the given deep link `Uri`, and determines whether it matches a Uri pattern added to the destination by a call to `addDeepLink(String)` . It returns `true` if the deep link is a valid match, and `false` otherwise. This should be called prior to `NavController#navigate(Uri)` to ensure the deep link can be navigated to.
`Boolean`	`hasDeepLink(@NonNull deepLinkRequest: NavDeepLinkRequest)` Checks the given `NavDeepLinkRequest`, and determines whether it matches a `NavDeepLink` added to the destination by a call to `addDeepLink(NavDeepLink)`. It returns `true` if the request is a valid match, and `false` otherwise. This should be called prior to `NavController#navigate(NavDeepLinkRequest)` to ensure the deep link can be navigated to.
`Class<out C>`	`parseClassFromName(@NonNull context: Context, @NonNull name: String, @NonNull expectedClassType: Class<out C>)` Parse the class associated with this destination from a raw name, generally extracted from the `android:name` attribute added to the destination's XML. This should be the class providing the visual representation of the destination that the user sees after navigating to this destination. This method does name -> Class caching and should be strongly preferred over doing your own parsing if your `Navigator` supports the `android:name` attribute to give consistent behavior across all Navigators.
`Unit`	`putAction(@IdRes actionId: Int, @IdRes destId: Int)` Sets a destination ID for an action ID.
`Unit`	`putAction(@IdRes actionId: Int, @NonNull action: NavAction)` Sets a destination ID for an action ID.
`Unit`	`removeAction(@IdRes actionId: Int)` Unsets the destination ID for an action ID.
`Unit`	`removeArgument(@NonNull argumentName: String)` Unsets the argument type for an argument name.
`Unit`	`setId(@IdRes id: Int)` Sets the destination's unique ID. This should be an ID resource generated by the Android resource system.
`Unit`	`setLabel(@Nullable label: CharSequence?)` Sets the descriptive label of this destination.

Extension functions

From androidx.navigation

operator Boolean	`NavGraph.contains(@IdRes id: Int)` Returns `true` if a destination with `id` is found in this navigation graph.
operator NavDestination	`NavGraph.get(@IdRes id: Int)` Returns the destination with `id`.
operator Unit	`NavGraph.minusAssign(node: NavDestination)` Removes `node` from this navigation graph.
operator Unit	`NavGraph.plusAssign(node: NavDestination)` Adds a destination to this NavGraph.
operator Unit	`NavGraph.plusAssign(other: NavGraph)` Add all destinations from another collection to this one.

Public constructors

<init>

NavGraph(@NonNull navGraphNavigator: Navigator<out NavGraph!>)

Construct a new NavGraph. This NavGraph is not valid until you add a destination and set the starting destination.

Parameters
`navGraphNavigator`	Navigator<out NavGraph!>: The `NavGraphNavigator` which this destination will be associated with. Generally retrieved via a `NavController`'s `NavigatorProvider#getNavigator(Class)` method.

Public methods

addAll

fun addAll(@NonNull other: NavGraph): Unit

Add all destinations from another collection to this one. As each destination has at most one parent, the destinations will be removed from the given NavGraph.

Parameters
`other`	NavGraph: collection of destinations to add. All destinations will be removed from this graph after being added to this graph.

addDestination

fun addDestination(@NonNull node: NavDestination): Unit

Adds a destination to this NavGraph. The destination must have an NavDestination#getId() id} set.

The destination must not have a parent set. If the destination is already part of a navigation graph, call remove(NavDestination) before calling this method.

Parameters
`node`	NavDestination: destination to add

addDestinations

fun addDestinations(@NonNull nodes: MutableCollection<NavDestination!>): Unit

Adds multiple destinations to this NavGraph. Each destination must have an NavDestination#getId() id} set.

Each destination must not have a parent set. If any destination is already part of a navigation graph, call remove(NavDestination) before calling this method.

Parameters
`nodes`	MutableCollection<NavDestination!>: destinations to add

addDestinations

fun addDestinations(@NonNull vararg nodes: NavDestination!): Unit

Adds multiple destinations to this NavGraph. Each destination must have an NavDestination#getId() id} set.

Each destination must not have a parent set. If any destination is already part of a navigation graph, call remove(NavDestination) before calling this method.

Parameters
`nodes`	NavDestination!: destinations to add

clear

fun clear(): Unit

Clear all destinations from this navigation graph.

findNode

@Nullable fun findNode(@IdRes resid: Int): NavDestination?

Finds a destination in the collection by ID. This will recursively check the parent of this navigation graph if node is not found in this navigation graph.

Parameters
`resid`	Int: ID to locate

Return
`NavDestination?`	the node with ID resid

getStartDestination

@IdRes fun getStartDestination(): Int

Returns the starting destination for this NavGraph. When navigating to the NavGraph, this destination is the one the user will initially see.

Return
`Int`

iterator

@NonNull fun iterator(): MutableIterator<NavDestination!>

onInflate

open fun onInflate(
    @NonNull context: Context, 
    @NonNull attrs: AttributeSet
): Unit

remove

fun remove(@NonNull node: NavDestination): Unit

Remove a given destination from this NavGraph

Parameters
`node`	NavDestination: the destination to remove.

setStartDestination

fun setStartDestination(@IdRes startDestId: Int): Unit

Sets the starting destination for this NavGraph.

Parameters
`startDestId`	Int: The id of the destination to be shown when navigating to this NavGraph.

toString

@NonNull open fun toString(): String