Type Alias UseRouteParams

Parameters for the useRoute hook

type UseRouteParams = {
    destinations: Coordinate[];
    options?: RouteConfiguration | readonly RouteConfiguration[];
    origin: Coordinate | UserLocation | null;
}

Index

Properties

destinations options? origin

Properties

destinations

destinations: Coordinate[]

The possible end points of the route. The route goes to whichever is closest

`Optional`options

options?: RouteConfiguration | readonly RouteConfiguration[]

Optional configuration for route calculation, or a list of configurations to calculate one route for each

origin

origin: Coordinate | UserLocation | null

The starting point of the route, or UserLocation to start from the user as they move. Set to null to clear the route