Class DirectionFinder

DirectionFinder

Permet de récupérer les itinéraires entre des lieux.
L'exemple ci-dessous montre comment utiliser cette classe pour obtenir l'itinéraire de Times Square à Central Park, en s'arrêtant d'abord au Lincoln Center, pour tracer les lieux et le trajet sur une carte, puis pour envoyer la carte par e-mail.

// Get the directions.
var directions = Maps.newDirectionFinder()
    .setOrigin('Times Square, New York, NY')
    .addWaypoint('Lincoln Center, New York, NY')
    .setDestination('Central Park, New York, NY')
    .setMode(Maps.DirectionFinder.Mode.DRIVING)
    .getDirections();
var route = directions.routes[0];

// Set up marker styles.
var markerSize = Maps.StaticMap.MarkerSize.MID;
var markerColor = Maps.StaticMap.Color.GREEN
var markerLetterCode = 'A'.charCodeAt();

// Add markers to the map.
var map = Maps.newStaticMap();
for (var i = 0; i < route.legs.length; i++) {
  var leg = route.legs[i];
  if (i == 0) {
    // Add a marker for the start location of the first leg only.
    map.setMarkerStyle(markerSize, markerColor, String.fromCharCode(markerLetterCode));
    map.addMarker(leg.start_location.lat, leg.start_location.lng);
    markerLetterCode++;
  }
  map.setMarkerStyle(markerSize, markerColor, String.fromCharCode(markerLetterCode));
  map.addMarker(leg.end_location.lat, leg.end_location.lng);
  markerLetterCode++;
}

// Add a path for the entire route.
map.addPath(route.overview_polyline.points);

// Send the map in an email.
var toAddress = Session.getActiveUser().getEmail();
MailApp.sendEmail(
  toAddress,
  'Directions',
  'Please open: ' + map.getMapUrl() + '&key=YOUR_API_KEY', {
    htmlBody: 'See below.<br/><img src="cid:mapImage">',
    inlineImages: {
      mapImage: Utilities.newBlob(map.getMapImage(), 'image/png')
    }
  }
);

Voir aussi

Méthodes

MéthodeType renvoyéBrève description
addWaypoint(latitude, longitude)DirectionFinderAjoute un point de cheminement que l'itinéraire doit traverser, à l'aide d'un point (lat/lng).
addWaypoint(address)DirectionFinderAjoute un point de cheminement par lequel l'itinéraire doit passer, à l'aide d'une adresse.
clearWaypoints()DirectionFinderEfface l'ensemble de points de cheminement actuel.
getDirections()ObjectRécupère l'itinéraire à l'aide du point de départ, de la destination et des autres options définies.
setAlternatives(useAlternatives)DirectionFinderDéfinit si les itinéraires alternatifs doivent être renvoyés ou non, plutôt que uniquement l'itinéraire le plus élevé (valeur par défaut : "false").
setArrive(time)DirectionFinderDéfinit l'heure d'arrivée souhaitée (le cas échéant).
setAvoid(avoid)DirectionFinderDétermine si certains types de restrictions doivent être évités.
setDepart(time)DirectionFinderDéfinit l'heure de départ souhaitée (le cas échéant).
setDestination(latitude, longitude)DirectionFinderDéfinit le lieu d'arrivée vers lequel calculer l'itinéraire, en utilisant un point (lat/lng).
setDestination(address)DirectionFinderDéfinit le lieu d'arrivée vers lequel calculer l'itinéraire, à l'aide d'une adresse.
setLanguage(language)DirectionFinderDéfinit la langue à utiliser pour l'itinéraire.
setMode(mode)DirectionFinderDéfinit le mode de transport (par défaut, en voiture).
setOptimizeWaypoints(optimizeOrder)DirectionFinderDétermine si l'itinéraire fourni doit être optimisé ou non en réorganisant les points de cheminement dans un ordre plus efficace (valeur par défaut : "false").
setOrigin(latitude, longitude)DirectionFinderDéfinit le point de départ à partir duquel l'itinéraire doit être calculé, à l'aide d'un point (lat/lng).
setOrigin(address)DirectionFinderDéfinit le point de départ à partir duquel calculer l'itinéraire, à l'aide d'une adresse.
setRegion(region)DirectionFinderDéfinit une région à utiliser lors de l'interprétation des noms de lieux.

Documentation détaillée

addWaypoint(latitude, longitude)

Ajoute un point de cheminement que l'itinéraire doit traverser, à l'aide d'un point (lat/lng).

// Creates a DirectionFinder with a wapoint at Lincoln Center.
var directionFinder = Maps.newDirectionFinder().addWaypoint(40.772628, -73.984243);

Paramètres

NomTypeDescription
latitudeNumberLatitude du point de cheminement.
longitudeNumberLongitude du point de cheminement.

Renvois

DirectionFinder : objet DirectionFinder qui facilite le chaînage d'appels.


addWaypoint(address)

Ajoute un point de cheminement par lequel l'itinéraire doit passer, à l'aide d'une adresse.

// Creates a DirectionFinder with a wapoint at Lincoln Center.
var directionFinder = Maps.newDirectionFinder().addWaypoint('Lincoln Center, New York, NY');

Paramètres

NomTypeDescription
addressStringAdresse.

Renvois

DirectionFinder : objet DirectionFinder qui facilite le chaînage d'appels.


clearWaypoints()

Efface l'ensemble de points de cheminement actuel.

var directionFinder = Maps.newDirectionFinder()
// ...
// Do something interesting here ...
// ...
// Remove all waypoints added with addWaypoint().
directionFinder.clearWaypoints();

Renvois

DirectionFinder : objet DirectionFinder qui facilite le chaînage d'appels


getDirections()

Récupère l'itinéraire à l'aide du point de départ, de la destination et des autres options définies.

// Logs how long it would take to walk from Times Square to Central Park.
var directions = Maps.newDirectionFinder()
    .setOrigin('Times Square, New York, NY')
    .setDestination('Central Park, New York, NY')
    .setMode(Maps.DirectionFinder.Mode.WALKING)
    .getDirections();
Logger.log(directions.routes[0].legs[0].duration.text);

Renvois

Object : objet JSON contenant l'ensemble des itinéraires pour l'itinéraire, comme décrit ici.

Voir aussi


setAlternatives(useAlternatives)

Définit si les itinéraires alternatifs doivent être renvoyés ou non, plutôt que uniquement l'itinéraire le plus élevé (valeur par défaut : "false"). Si la valeur est "true", le tableau routes de l'objet obtenu peut contenir plusieurs entrées.

// Creates a DirectionFinder with alernative routes enabled.
var directionFinder = Maps.newDirectionFinder().setAlternatives(true);

Paramètres

NomTypeDescription
useAlternativesBoolean"true" pour renvoyer d'autres routes, "false" dans le cas contraire

Renvois

DirectionFinder : objet DirectionFinder qui facilite le chaînage d'appels


setArrive(time)

Définit l'heure d'arrivée souhaitée (le cas échéant).

// Creates a DirectionFinder with an arrival time of 2 hours from now.
var now = new Date();
var arrive = new Date(now.getTime() + (2 * 60 * 60 * 1000));
var directionFinder = Maps.newDirectionFinder().setArrive(arrive);

Paramètres

NomTypeDescription
timeDatel'heure d'arrivée

Renvois

DirectionFinder : objet DirectionFinder qui facilite le chaînage d'appels

Voir aussi


setAvoid(avoid)

Détermine si certains types de restrictions doivent être évités.

// Creates a DirectionFinder that avoid highways.
var directionFinder = Maps.newDirectionFinder().setAvoid(Maps.DirectionFinder.Avoid.HIGHWAYS);

Paramètres

NomTypeDescription
avoidStringune valeur constante de Avoid

Renvois

DirectionFinder : objet DirectionFinder qui facilite le chaînage d'appels

Voir aussi


setDepart(time)

Définit l'heure de départ souhaitée (le cas échéant).

// Creates a DirectionFinder with a departure time of 1 hour from now.
var now = new Date();
var depart = new Date(now.getTime() + (1 * 60 * 60 * 1000));
var directionFinder = Maps.newDirectionFinder().setDepart(depart);

Paramètres

NomTypeDescription
timeDatel'heure de départ

Renvois

DirectionFinder : objet DirectionFinder qui facilite le chaînage d'appels.

Voir aussi


setDestination(latitude, longitude)

Définit le lieu d'arrivée vers lequel calculer l'itinéraire, en utilisant un point (lat/lng).

// Creates a DirectionFinder with the destination set to Central Park.
var directionFinder = Maps.newDirectionFinder().setDestination(40.777052, -73.975464);

Paramètres

NomTypeDescription
latitudeNumberla latitude du lieu d'arrivée ;
longitudeNumberLa longitude du lieu d'arrivée

Renvois

DirectionFinder : objet DirectionFinder qui facilite le chaînage d'appels


setDestination(address)

Définit le lieu d'arrivée vers lequel calculer l'itinéraire, à l'aide d'une adresse.

// Creates a DirectionFinder with the destination set to Central Park.
var directionFinder = Maps.newDirectionFinder().setDestination('Central Park, New York, NY');

Paramètres

NomTypeDescription
addressStringl'adresse d'arrivée

Renvois

DirectionFinder : objet DirectionFinder qui facilite le chaînage d'appels


setLanguage(language)

Définit la langue à utiliser pour l'itinéraire.

// Creates a DirectionFinder with the language set to French.
var directionFinder = Maps.newDirectionFinder().setLanguage('fr');

Paramètres

NomTypeDescription
languageStringun identifiant de langue BCP-47

Renvois

DirectionFinder : objet DirectionFinder qui facilite le chaînage d'appels

Voir aussi


setMode(mode)

Définit le mode de transport (par défaut, en voiture).

// Creates a DirectionFinder with the mode set to walking.
var directionFinder = Maps.newDirectionFinder().setMode(Maps.DirectionFinder.Mode.WALKING);

Paramètres

NomTypeDescription
modeStringune valeur constante de Mode

Renvois

DirectionFinder : objet DirectionFinder qui facilite le chaînage d'appels

Voir aussi


setOptimizeWaypoints(optimizeOrder)

Détermine si l'itinéraire fourni doit être optimisé ou non en réorganisant les points de cheminement dans un ordre plus efficace (valeur par défaut : "false").

// Creates a DirectionFinder with wapoint optimization enabled.
var directionFinder = Maps.newDirectionFinder().setOptimizeWaypoints(true);

Paramètres

NomTypeDescription
optimizeOrderBoolean"true" pour optimiser l'ordre, ou "false" dans le cas contraire

Renvois

DirectionFinder : objet DirectionFinder qui facilite le chaînage d'appels

Voir aussi


setOrigin(latitude, longitude)

Définit le point de départ à partir duquel l'itinéraire doit être calculé, à l'aide d'un point (lat/lng).

// Creates a DirectionFinder with the origin set to Times Square.
var directionFinder = Maps.newDirectionFinder().setOrigin(40.759011, -73.984472);

Paramètres

NomTypeDescription
latitudeNumberla latitude du point de départ
longitudeNumberLa longitude du lieu de départ

Renvois

DirectionFinder : objet DirectionFinder qui facilite le chaînage d'appels


setOrigin(address)

Définit le point de départ à partir duquel calculer l'itinéraire, à l'aide d'une adresse.

// Creates a DirectionFinder with the origin set to Times Square.
var directionFinder = Maps.newDirectionFinder().setOrigin('Times Square, New York, NY');

Paramètres

NomTypeDescription
addressStringl'adresse de départ

Renvois

DirectionFinder : instance DirectionFinder qui facilite le chaînage d'appels.


setRegion(region)

Définit une région à utiliser lors de l'interprétation des noms de lieux. Les codes des régions acceptés correspondent aux ccTLD pris en charge par Google Maps. Par exemple, le code de région "uk" correspond à "maps.google.co.uk".

// Creates a DirectionFinder with the region set to France.
var directionFinder = Maps.newDirectionFinder().setRegion('fr');

Paramètres

NomTypeDescription
regionStringle code régional à utiliser

Renvois

DirectionFinder : objet DirectionFinder qui facilite le chaînage d'appels

Voir aussi