Cette page a été traduite par l'API Cloud Translation.

Class DirectionFinder

Permet de récupérer des itinéraires entre des lieux.
L'exemple ci-dessous montre comment utiliser cette classe pour obtenir un itinéraire de Times Square à Central Park, qui s'arrête d'abord au Lincoln Center, trace les emplacements et le chemin sur une carte, puis envoie la carte dans un 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

API Google Directions

Méthodes

Méthode	Type renvoyé	Brève description
`addWaypoint(latitude, longitude)`	`DirectionFinder`	Ajoute un point de cheminement que l'itinéraire doit traverser, en utilisant un point (lat/lng).
`addWaypoint(address)`	`DirectionFinder`	Ajoute un point de cheminement que l'itinéraire doit traverser, à l'aide d'une adresse.
`clearWaypoints()`	`DirectionFinder`	Efface l'ensemble actuel de points de cheminement.
`getDirections()`	`Object`	Récupère l'itinéraire à l'aide du point de départ, de la destination et d'autres options définies.
`setAlternatives(useAlternatives)`	`DirectionFinder`	Détermine si d'autres itinéraires doivent être affichés, et pas seulement les itinéraires les plus élevés. route (la valeur par défaut est "false").
`setArrive(time)`	`DirectionFinder`	Définit l'heure d'arrivée souhaitée (le cas échéant).
`setAvoid(avoid)`	`DirectionFinder`	Détermine si certains types de restrictions doivent être évités.
`setDepart(time)`	`DirectionFinder`	Définit l'heure de départ souhaitée (le cas échéant).
`setDestination(latitude, longitude)`	`DirectionFinder`	Définit la position d'arrivée pour laquelle l'itinéraire doit être calculé, en utilisant un point (lat/lng).
`setDestination(address)`	`DirectionFinder`	Définit le lieu d'arrivée pour lequel calculer l'itinéraire, à l'aide d'une adresse.
`setLanguage(language)`	`DirectionFinder`	Définit la langue à utiliser pour l'itinéraire.
`setMode(mode)`	`DirectionFinder`	Définit le mode de transport (en voiture, par défaut).
`setOptimizeWaypoints(optimizeOrder)`	`DirectionFinder`	Détermine si l'itinéraire fourni doit être optimisé ou non en réorganisant les points de cheminement dans un ordre efficace (valeur par défaut "false").
`setOrigin(latitude, longitude)`	`DirectionFinder`	Définit le point de départ à partir duquel l'itinéraire doit être calculé, en utilisant un point (lat/lng).
`setOrigin(address)`	`DirectionFinder`	Définit le point de départ à partir duquel l'itinéraire doit être calculé, à l'aide d'une adresse.
`setRegion(region)`	`DirectionFinder`	Définit la 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, en utilisant un point (lat/lng).

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

Paramètres

Nom	Type	Description
`latitude`	`Number`	Latitude du point de cheminement.
`longitude`	`Number`	Longitude du point de cheminement.

Renvois

DirectionFinder : objet DirectionFinder permettant de faciliter le chaînage d'appels.

`addWaypoint(address)`

Ajoute un point de cheminement que l'itinéraire doit traverser, à 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

Nom	Type	Description
`address`	`String`	Adresse.

Renvois

DirectionFinder : objet DirectionFinder permettant de faciliter le chaînage d'appels.

`clearWaypoints()`

Efface l'ensemble actuel de points de cheminement.

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

Renvois

DirectionFinder : objet DirectionFinder pour faciliter le chaînage d'appels

`getDirections()`

Récupère l'itinéraire à l'aide du point de départ, de la destination et d'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 correspondant, comme décrit ici.

Voir aussi

API Google Directions

`setAlternatives(useAlternatives)`

Détermine si d'autres itinéraires doivent être affichés, et pas seulement les itinéraires les plus élevés. route (la valeur par défaut est "false"). Si la valeur est "true", le tableau routes de l'objet obtenu peut contenant plusieurs entrées.

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

Paramètres

Nom	Type	Description
`useAlternatives`	`Boolean`	"true" pour renvoyer d'autres itinéraires, "false" dans le cas contraire

Renvois

DirectionFinder : objet DirectionFinder pour faciliter 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

Nom	Type	Description
`time`	`Date`	l'heure d'arrivée

Renvois

DirectionFinder : objet DirectionFinder pour faciliter le chaînage d'appels

Voir aussi

API Google Directions

`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

Nom	Type	Description
`avoid`	`String`	une valeur constante de `Avoid`

Renvois

DirectionFinder : objet DirectionFinder pour faciliter le chaînage d'appels

Voir aussi

API Google Directions

`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

Nom	Type	Description
`time`	`Date`	l'heure de départ

Renvois

DirectionFinder : objet DirectionFinder permettant de faciliter le chaînage d'appels.

Voir aussi

API Google Directions

`setDestination(latitude, longitude)`

Définit la position d'arrivée pour laquelle l'itinéraire doit être calculé, 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

Nom	Type	Description
`latitude`	`Number`	La latitude du lieu d'arrivée
`longitude`	`Number`	la longitude du lieu d'arrivée

Renvois

DirectionFinder : objet DirectionFinder pour faciliter le chaînage d'appels

`setDestination(address)`

Définit le lieu d'arrivée pour 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

Nom	Type	Description
`address`	`String`	l'adresse d'arrivée

Renvois

DirectionFinder : objet DirectionFinder pour faciliter 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

Nom	Type	Description
`language`	`String`	un identifiant de langue BCP-47

Renvois

DirectionFinder : objet DirectionFinder pour faciliter le chaînage d'appels

Voir aussi

Langues acceptées dans les API Google Maps

`setMode(mode)`

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

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

Paramètres

Nom	Type	Description
`mode`	`String`	une valeur constante de `Mode`

Renvois

DirectionFinder : objet DirectionFinder pour faciliter le chaînage d'appels

Voir aussi

API Google Directions

`setOptimizeWaypoints(optimizeOrder)`

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

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

Paramètres

Nom	Type	Description
`optimizeOrder`	`Boolean`	"true" pour optimiser la commande, ou "false" dans le cas contraire

Renvois

DirectionFinder : objet DirectionFinder pour faciliter le chaînage d'appels

Voir aussi

API Google Directions

`setOrigin(latitude, longitude)`

Définit le point de départ à partir duquel l'itinéraire doit être calculé, en utilisant 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

Nom	Type	Description
`latitude`	`Number`	La latitude du point de départ
`longitude`	`Number`	la longitude du lieu de départ

Renvois

DirectionFinder : objet DirectionFinder permettant de faciliter le chaînage d'appels

`setOrigin(address)`

Définit le point de départ à partir duquel l'itinéraire doit être calculé, à 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

Nom	Type	Description
`address`	`String`	l'adresse de départ

Renvois

DirectionFinder : instance DirectionFinder pour faciliter le chaînage d'appels

`setRegion(region)`

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

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

Paramètres

Nom	Type	Description
`region`	`String`	le code de région à utiliser

Renvois

DirectionFinder : objet DirectionFinder pour faciliter le chaînage d'appels

Voir aussi

API Google Directions