Usage

The NextBillion.ai Flutter Navigation SDK empowers you to integrate advanced navigation capabilities into your Flutter application. Follow these steps to utilize the SDK effectively:

NB Maps

If you need to use Map-related functions, such as displaying a Map widget, please refer to our Flutter Maps Plugin Documentation.

Fetch routes

To request routes, use RouteRequestParams with NBNavigation. For supported parameters, please refer to Navigation API documentation.

Create the RouteRequestParams object with the required parameters:

1RouteRequestParams requestParams = RouteRequestParams(
2 origin: origin,
3 destination: dest,
4 // waypoints: [waypoint1, waypoint2],
5 // language: 'en',
6 // alternatives: true,
7 // overview: ValidOverview.simplified,
8 // avoid: [SupportedAvoid.toll, SupportedAvoid.ferry],
9 // option: SupportedOption.flexible,
10 // unit: SupportedUnits.imperial,
11 // mode: ValidModes.car,
12 // geometryType: SupportedGeometry.polyline,
13 );

Fetch routes

Use NBNavigation.fetchRoute() to fetch routes with the specified requestParams, and get the route response DirectionsRouteResponse, the response will contain the route info.

1DirectionsRouteResponse response = await NBNavigation.fetchRoute(requestParams);

Draw routes

After obtaining the routes, you can draw routes on the map view using NavNextBillionMap. Ensure you have the NextbillionMapController created in the onMapCreated callback of the NBMap widget. Refer to Flutter Maps Plugin documentation for more information.

Create NavNextBillionMap with NextbillionMapController in NBMap widget’s onStyleLoaded callback:

1void _onMapCreated(NextbillionMapController controller) {
2 this.controller = controller;
3}
4
5void _onStyleLoaded() async {
6 if (controller != null) {
7 navNextBillionMap = await NavNextBillionMap.create(controller!);
8 }
9 }

Draw routes

Once you have the NavNextBillionMap instance, draw the routes on the map view:

1await navNextBillionMap.drawRoute(routes);

Clear routes

To remove the drawn routes from the map view, use clearRoute():

1 navNextBillionMap.clearRoute();

Toggle Alternative Route Visibility

You can toggle the visibility of alternative routes on the map:

1 navNextBillionMap.toggleAlternativeVisibilityWith(visible);

Toggle Route DurationSymbol Visibility

Toggle the visibility of the route duration symbol on the map:

1 navNextBillionMap.toggleDurationSymbolVisibilityWith(visible);

Add RouteSelected Listener.

You can add route switching listener in the onMapClick callback:

1onMapClick(Point<double> point, LatLng coordinates) {
2 navNextBillionMap.addRouteSelectedListener(coordinates, (selectedRouteIndex) {})
3}

Start navigation

To initiate navigation, use NavigationLauncherConfig. The following properties can be configured as per your preference:

  • route: The selected route for directions

  • routes: A list of available routes

  • themeMode: The theme mode for navigation UI, default value is system

    • system: follows system theme mode

    • light: applies light theme

    • dark: applies dark theme

  • locationLayerRenderMode: The rendering mode for the location layer, default value is LocationLayerRenderMode.GPS.

  • shouldSimulateRoute: Whether to simulate the route during navigation, default value is false.

  • enableDissolvedRouteLine: Whether to enable the dissolved route line during navigation, default value is true.

  • navigationMapStyleUrl: Indicates the map style in the Navigation view. Its priority is higher than the navViewMapStyle of (CustomNavigationViewLight, CustomNavigationViewDark) set in the styles.xml for Android and the mapStyleURL of (customDayStyle, customNightStyle) set in the AppDelegate for iOS.

1NavigationLauncherConfig config = NavigationLauncherConfig(route: routes.first, routes: routes, shouldSimulateRoute: true);
2
3NBNavigation.startNavigation(config);

Launch Embedded NavigationView

NBNavigationView is a customizable navigation view widget designed to provide seamless navigation experiences in your Flutter application. It offers various configuration options to cater to different navigation requirements, such as theme modes, location layer render modes, and custom styles.

1const NBNavigationView({
2 super.key,
3 required this.navigationOptions,
4 this.onNavigationViewReady,
5 this.onProgressChange,
6 this.onNavigationCancelling,
7 this.onArriveAtWaypoint,
8 this.onRerouteFromLocation,
9});

Parameters

By utilizing the NavigationLauncherConfig class, you can customize the navigation experience to meet your specific needs, from theme settings to location layer modes and custom styles.

  • navigationOptions (required): This parameter provides the necessary configuration for the navigation view.
  • onNavigationViewReady: A callback that is triggered when the navigation view is ready.
  • onProgressChange: A callback that is triggered when there is a change in the navigation progress.
  • onNavigationCancelling: A callback that is triggered when navigation is being canceled.
  • onArriveAtWaypoint: A callback that is triggered when arriving at a waypoint.
  • onRerouteFromLocation: A callback that is triggered when rerouting from a specific location.

Example Usage

1NBNavigationView(
2 navigationOptions: NavigationLauncherConfig(
3 route: selectedRoute,
4 routes: allRoutes,
5 themeMode: NavigationThemeMode.system,
6 ),
7 onNavigationViewReady: (controller) {
8 // Handle navigation view ready
9 },
10 onProgressChange: (progress) {
11 // Handle progress change
12 },
13 onNavigationCancelling: () {
14 // Handle navigation canceling
15 },
16 onArriveAtWaypoint: (waypoint) {
17 // Handle arriving at waypoint
18 },
19 onRerouteFromLocation: (location) {
20 // Handle rerouting from location
21 },
22);
docs-image