MapQuest.js

L.mapquest.directionsControl(options)

A control that allows for drop in routing functionality, the control has start and destination inputs on the left hand side of the map. A user can either type in their route or click on the map to select their start and destination locations. Once a route is entered, the user is presented with primary and alternate routes along with route narratives on the left hand side below the inputs. The control also has buttons for changing directions between driving and walking, a button to add additional destinations, as well as the ability to change route options, like distance units or if you want to avoid specific types of roads.

Syntax

L.mapquest.key = 'KEY';
let map = L.mapquest.map('map', {
  center: [40.7128, -74.0059],
  layers: L.mapquest.tileLayer('map'),
  zoom: 14,
  zoomControl: false
});

let directionsControl = L.mapquest.directionsControl({
  className: '',
  directions: {
    options: {
      timeOverage: 25,
      doReverseGeocode: false,
    }
  },
  directionsLayer: {
    startMarker: {
      title: 'Drag to change location',
      draggable: true,
      icon: 'marker-start',
      iconOptions: {
        size: 'sm'
      }
    },
    endMarker: {
      draggable: true,
      title: 'Drag to change location',
      icon: 'marker-end',
      iconOptions: {
        size: 'sm'
      }
    },
    viaMarker: {
      title: 'Drag to change route'
    },
    routeRibbon: {
      showTraffic: true
    },
    alternateRouteRibbon: {
      showTraffic: true
    },
    paddingTopLeft: [450, 20],
    paddingBottomRight: [180, 20],
  },
  startInput: {
    compactResults: true,
    disabled: false,
    location: {},
    placeholderText: 'Starting point or click on the map...',
    geolocation: {
      enabled: true
    },
    clearTitle: 'Remove starting point'
  },
  endInput: {
    compactResults: true,
    disabled: false,
    location: {},
    placeholderText: 'Destination',
    geolocation: {
      enabled: true
    },
    clearTitle: 'Remove this destination'
  },
  addDestinationButton: {
    enabled: true,
    maxLocations: 10,
  },
  routeTypeButtons: {
    enabled: true,
  },
  reverseButton: {
    enabled: true,
  },
  optionsButton: {
    enabled: true,
  },
  routeSummary: {
    enabled: true,
    compactResults: false,
  },
  narrativeControl: {
    enabled: true,
    compactResults: false,
    interactive: true,
  }
}).addTo(map);

Parameters

• controlOptions optional Object

  An object containing key value options for the directions control.

  • className String optional

    A custom CSS class name to assign to the control.

  • directions Object optional

    An object containing key/values that control the Directions API request made by the control.

    • options
    • optimizeWaypoints

  • directionsLayer Object optional

    An object containing key/values that control the look and feel of the Directions Layer.

    • startMarker
    • endMarker
    • waypointMarker
    • viaMarker
    • routeRibbon
    • alternateRouteRibbon
    • paddingTopLeft
    • paddingBottomRight

  • startInput Object optional

    • compactResults A boolean that determines if the start input search ahead results are compact. Default is true.
    • disabled A boolean that determines if the start input is disabled. Default is false.
    • geolocation An object controlling the ability to get a user's geolocation from the input control.
    • • enabled Control the rendering of the geolocation button inside the input control. Default is true.
      • enableHighAccuracy Indicates the application would like to receive the best possible results. If true and if the device is able to provide a more accurate position, it will do so. Note that this can result in slower response times or increased power consumption (with a GPS chip on a mobile device for example). On the other hand, if false, the device can take the liberty to save resources by responding more quickly and/or using less power. Default is true.
      • maximumAge The maximum age in milliseconds of a possible cached position that is acceptable to return. If set to 0, it means that the device cannot use a cached position and must attempt to retrieve the real current position. Default is 60000.
    • location Pass in an advanced location object to set the input control to have a default location pre-populated.
    • placeholderText A string that controls the start input placeholder text. Default is 'Starting point or click on the map...'.

  • endInput Object optional

    • compactResults A boolean that determines if the end input search ahead results are compact. Default is true.
    • disabled A boolean that determines if the end input is disabled. Default is false.
    • geolocation An object controlling the ability to get a users geolocation from the input control.
    • • enabled Control the rendering of the geolocation button inside the input control. Default is true.
      • enableHighAccuracy Indicates the application would like to receive the best possible results. If true and if the device is able to provide a more accurate position, it will do so. Note that this can result in slower response times or increased power consumption (with a GPS chip on a mobile device for example). On the other hand, if false, the device can take the liberty to save resources by responding more quickly and/or using less power. Default is true.
      • maximumAge The maximum age in milliseconds of a possible cached position that is acceptable to return. If set to 0, it means that the device cannot use a cached position and must attempt to retrieve the real current position. Default is 60000.
    • location Pass in an advanced location object to set the input control to have a default location pre-populated.
    • placeholderText A string that controls the end input placeholder text. Default is 'Destination'.

  • addDestinationButton Object optional

    An object that controls configuration of the add destination button inside the directions control.

    • enabled A boolean that determines if the add destination button is rendered. Default is true.
    • maxLocations A integer that determines the number of destinations a user can add. Default is 10. Max is 25.

  • routeTypeButtons Object optional

    An object that controls configuration of the route type buttons inside the directions control.

    • enabled A boolean that determines if the route type buttons are rendered. Default is true.

  • reverseButton Object optional

    An object that controls configuration of the reverse button inside the directions control.

    • enabled A boolean that determines if the reverse button is rendered. Default is true.

  • optionsButton Object optional

    An object that controls configuration of the options button inside the directions control.

    • enabled A boolean that determines if the options button is rendered. Default is true.

  • routeSummary Object optional

    An object that controls configuration of the route summary control inside the directions control.

    • enabled A boolean that determines if the route summary control is rendered. Default is true.
    • compactResults A boolean that determines if a compact layout of the route summary should be used. Default is false.

  • narrativeControl Object optional

    An object that controls configuration of the narrative control inside the directions control.

    • enabled A boolean that determines if the narrative control is rendered. Default is true.
    • compactResults A boolean that determines if a compact layout of the route narrative should be used. Default is false.
    • interactive A boolean that determines if the control is interactive. When it is interactive, the narrative maneuvers are clickable and place via points and popups on the map. Default is true.

Functions

directionsControl.setStart(location)

Set the start location of the directions control. Pass in an advanced location object.

directionsControl.setStart({
  street: "1555 Blake St",
  city: "Denver",
  county: "Denver",
  state: "CO"
});

directionsControl.setFirstDestination(location)

Set the first destination location of the directions control. Pass in an advanced location object.

directionsControl.setFirstDestination({
  latLng: {
    lat: 39.750307,
    lng: -104.999472
  }
});

Basic Example

let directionsControl = L.mapquest.directionsControl().addTo(map);

Custom Style Example

let customDirectionsControl = L.mapquest.directionsControl({
  routeSummary: {
    enabled: true,
    compactResults: true,
  },
  narrativeControl: {
    enabled: true,
    compactResults: true,
  },
  directionsLayer: {
    startMarker: {
      icon: 'circle',
      iconOptions: {
        size: 'sm',
        primaryColor: '#1fc715',
        secondaryColor: '#1fc715',
        symbol: 'A'
      }
    },
    endMarker: {
      icon: 'circle',
      iconOptions: {
        size: 'sm',
        primaryColor: '#e9304f',
        secondaryColor: '#e9304f',
        symbol: 'B'
      }
    },
    waypointMarker: {
      icon: 'circle',
      iconOptions: {
        size: 'sm',
        primaryColor: '#ffffff',
        secondaryColor: '#ffffff',
      }
    },
    routeRibbon: {
      color: "#2aa6ce",
      opacity: 1.0,
      showTraffic: false
    }
  }
}).addTo(map);

Locked Destination Example

let map = L.mapquest.map('map', {
  center: [39.750307, -104.999472],
  layers: L.mapquest.tileLayer('map'),
  zoom: 14,
  zoomControl: false
});

let directionsControl = L.mapquest.directionsControl({
  endInput: {
    disabled: true,
    geolocation: {
      enabled: false
    }
  },
  addDestinationButton: {
    enabled: false
  }
}).addTo(map);

directionsControl.setFirstDestination({
  latLng: {
    lat: 39.750307,
    lng: -104.999472
  }
});