Viam SDK
    Preparing search index...

    Interface NavigateRouteOptions

    Options for Navigation.navigateRoute. Set either routeName (a saved route) or waypoints (an inline list).

    interface NavigateRouteOptions {
        loop?: boolean;
        routeName?: string;
        startIndex?: number;
        startNearest?: boolean;
        wait?: boolean;
        waypoints?: PlainMessage<navigationApi.Waypoint>[];
    }
    Index
    loop? routeName? startIndex? startNearest? wait? waypoints?
    loop?: boolean

    Loop the route. Defaults to false.

    routeName?: string

    The name of a saved route.

    startIndex?: number

    The index to start from. Defaults to 0.

    startNearest?: boolean

    Start from the nearest waypoint instead, overriding startIndex.

    wait?: boolean

    With loop, only return once stopped. Defaults to false.

    waypoints?: PlainMessage<navigationApi.Waypoint>[]

    An inline list of waypoints.

    Settings
    Member Visibility

    On This Page
    Properties