Directions Service for Web

Last updated: 6/14/2023

The class DirectionsService is used to request routes from one point to another. The minimal required input is an origin and a destination.

This example shows how to setup and execute a query for a Route:

const externalDirectionsProvider = new mapsindoors.directions.GoogleMapsProvider();
const miDirectionsServiceInstance = new mapsindoors.services.DirectionsService(externalDirectionsProvider);

const routeParameters = {
  origin: { lat: 38.897389429704695, lng: -77.03740973527613, floor: 0 }, // Oval Office, The White House
  destination: { lat: 38.897579747054046, lng: -77.03658652944773, floor: 1 } // Blue Room, The White House
};

miDirectionsServiceInstance.getRoute(routeParameters).then(directionsResult => {
  console.log(directionsResult);
});

For more information, see the reference documentation.

Change Transportation Mode

In MapsIndoors, the transportation mode is referred to as travel mode. There are four travel modes, walking, bicycling, driving and transit (public transportation). The travel modes generally applies for outdoor navigation. Indoor navigation calculations are based on walking travel mode.

Set travel mode on your request using the travelMode property on routeParameters:

const routeParameters = {
  origin: { lat: 38.897389429704695, lng: -77.03740973527613, floor: 0 }, // Oval Office, The White House
  destination: { lat: 38.897579747054046, lng: -77.03658652944773, floor: 1 }, // Blue Room, The White House
  travelMode: 'WALKING'
};

Please note that not all map providers support pubic transportation as travel mode.

Route Restrictions

Avoiding Stairs and Steps

For a wheelchair user or a user with physical disabilities it may be relevant to request a Route that avoids stairs and steps.

Set avoid stairs on your request using the avoidStairs property on routeParameters:

const routeParameters = {
  origin: { lat: 38.897389429704695, lng: -77.03740973527613, floor: 0 }, // Oval Office, The White House
  destination: { lat: 38.897579747054046, lng: -77.03658652944773, floor: 1 }, // Blue Room, The White House
  avoidStairs: 'true'
};

App User Role Restrictions

In the MapsIndoors CMS it is possible to restrict certain ways in the Route Network to be used by users of certain Roles.

It is possible to get the available Roles with help of the SolutionsService:

mapsindoors.services.SolutionsService.getUserRoles().then(userRoles => {
  console.log(userRoles);
});

For more information, see the reference documentation.

User Roles can be set on a global level using mapsindoors.MapsIndoors.setUserRoles().

mapsindoors.MapsIndoors.setUserRoles(['myUserRoleId']);

For more information, see the reference documentation.

This will affect all following Directions requests as well as search queries with LocationsService.

Transit Departure and Arrival Time

Set a departure date or an arrival date on the route using the transitOptions property. It will only make sense to set one of these properties at a time.

const departureDate = new Date(new Date().getTime() + 30*60000); // 30 minutes from now

const routeParameters = {
  origin: { lat: 38.897389429704695, lng: -77.03740973527613, floor: 0 }, // Oval Office, The White House
  destination: { lat: 38.897579747054046, lng: -77.03658652944773, floor: 1 }, // Blue Room, The White House
  travelMode: 'TRANSIT',
  transitOptions: {
    departureTime: departureDate
  }
};

For more information about available options on the transitOption object, see google.com/maps/documentation.