Classe DistanceMatrixService
Classe google.maps.DistanceMatrixService
Service permettant de calculer les distances entre plusieurs points de départ et destinations.
Pour y accéder, appelez const {DistanceMatrixService} = await google.maps.importLibrary("routes")
. Consultez Bibliothèques dans l'API Maps JavaScript.
Constructeur | |
---|---|
DistanceMatrixService |
DistanceMatrixService() Paramètres:aucun
Crée une instance de DistanceMatrixService qui envoie des requêtes Distance Matrix aux serveurs Google. |
Méthodes | |
---|---|
getDistanceMatrix |
getDistanceMatrix(request[, callback]) Paramètres:
Valeur renvoyée:
Promise<DistanceMatrixResponse> Émet une requête Distance Matrix. |
Interface DistanceMatrixRequest
Interface google.maps.DistanceMatrixRequest
Requête Distance Matrix envoyée par DistanceMatrixService
, qui contient des tableaux de points de départ et d'arrivée, ainsi que diverses options de calcul des métriques.
Propriétés | |
---|---|
destinations |
Type:
Array<string|LatLng|LatLngLiteral|Place> Tableau contenant des chaînes d'adresse de destination, ou des objets LatLng ou Place , en fonction desquels calculer des distances et des durées. Obligatoire. |
origins |
Type:
Array<string|LatLng|LatLngLiteral|Place> Tableau contenant des chaînes d'adresse du point de départ, ou des objets LatLng ou Place , à partir desquels calculer des distances et le temps. Obligatoire. |
travelMode |
Type:
TravelMode Type de routage demandé. Obligatoire. |
avoidFerries optional |
Type:
boolean optional Si la valeur est true , indique au service Distance Matrix d'éviter les ferries dans la mesure du possible. Facultatif. |
avoidHighways optional |
Type:
boolean optional Si la valeur est true , indique au service Distance Matrix d'éviter les autoroutes dans la mesure du possible. Facultatif. |
avoidTolls optional |
Type:
boolean optional Si la valeur est true , indique au service Distance Matrix d'éviter les routes à péage dans la mesure du possible. Facultatif. |
drivingOptions optional |
Type:
DrivingOptions optional Paramètres qui ne s'appliquent qu'aux requêtes pour lesquelles travelMode est DRIVING . Cet objet n'aura aucun effet pour les autres modes de transport. |
language optional |
Type:
string optional Identifiant de la langue dans laquelle les résultats doivent être renvoyés, si possible. Consultez la liste des langues disponibles. |
region optional |
Type:
string optional Code régional utilisé comme biais pour les requêtes de geocoding. Le code régional accepte une valeur ccTLD ("domaine de premier niveau") à deux caractères. La plupart des codes ccTLD sont identiques aux codes ISO 3166-1, à quelques exceptions près. Par exemple, le ccTLD du Royaume-Uni est "uk" ( .co.uk ), tandis que son code ISO 3166-1 est "gb" (techniquement pour l'entité "Royaume-Uni de Grande-Bretagne et d'Irlande du Nord"). |
transitOptions optional |
Type:
TransitOptions optional Paramètres qui ne s'appliquent qu'aux requêtes pour lesquelles travelMode correspond à TRANSIT. Cet objet n'aura aucun effet pour les autres modes de transport. |
unitSystem optional |
Type:
UnitSystem optional Système d'unités à utiliser pour l'affichage des distances. Facultatif (valeur par défaut : métrique). |
Interface DistanceMatrixResponse
Interface google.maps.DistanceMatrixResponse
Réponse à une requête DistanceMatrixService
, composée des adresses de départ et de destination mises en forme, et d'une séquence de DistanceMatrixResponseRow
, une pour chaque adresse de point de départ correspondante.
Propriétés | |
---|---|
destinationAddresses |
Type:
Array<string> Adresses de destination mises en forme. |
originAddresses |
Type:
Array<string> Adresses d'origine mises en forme. |
rows |
Lignes de la matrice, correspondant aux adresses d'origine. |
Interface DistanceMatrixResponseRow
Interface google.maps.DistanceMatrixResponseRow
Ligne de la réponse à une requête DistanceMatrixService
, composée d'une séquence de DistanceMatrixResponseElement
(une pour chaque adresse de destination correspondante).
Propriétés | |
---|---|
elements |
Éléments de la ligne, correspondant aux adresses de destination. |
Interface DistanceMatrixResponseElement
Interface google.maps.DistanceMatrixResponseElement
Élément unique d'une réponse à une requête DistanceMatrixService
, qui contient la durée et la distance entre un point de départ et une destination.
Propriétés | |
---|---|
distance |
Type:
Distance Distance pour cette association point de départ-destination. Cette propriété n'est peut-être pas définie, car la distance peut être inconnue. |
duration |
Type:
Duration Durée de l'association point de départ-destination. Cette propriété n'est peut-être pas définie, car la durée peut être inconnue. |
duration_in_traffic |
Type:
Duration Durée de cette association point de départ-destination, en tenant compte des conditions de circulation indiquées par la propriété trafficModel . Cette propriété peut être undefined , car la durée peut être inconnue. Disponible uniquement pour les clients du forfait Premium lorsque drivingOptions est défini au moment de la demande. |
fare |
Type:
TransitFare Tarif total pour cet accord point de départ-destination. Ne s'applique qu'aux requêtes de transports en commun. |
status |
État de cette association point de départ-destination spécifique. |
Constantes DistanceMatrixStatus
Constantes google.maps.DistanceMatrixStatus
État de premier niveau de la requête en général renvoyé par DistanceMatrixService
à la fin d'une requête Distance Matrix. Spécifiez-les à l'aide d'une valeur ou du nom de la constante. (par exemple, 'OK'
ou google.maps.DistanceMatrixStatus.OK
).
Pour y accéder, appelez const {DistanceMatrixStatus} = await google.maps.importLibrary("routes")
. Consultez Bibliothèques dans l'API Maps JavaScript.
Constantes | |
---|---|
INVALID_REQUEST |
La requête fournie n'était pas valide. |
MAX_DIMENSIONS_EXCEEDED |
La requête contient plus de 25 points de départ ou destinations. |
MAX_ELEMENTS_EXCEEDED |
Le produit du nombre de points de départ par le nombre de destinations dépasse la limite par requête. |
OK |
La réponse contient un résultat valide. |
OVER_QUERY_LIMIT |
Trop d'éléments ont été demandés au cours de la période autorisée. Si vous réessayez après un certain temps, la requête devrait aboutir. |
REQUEST_DENIED |
Le service a refusé l'utilisation du service Distance Matrix par votre page Web. |
UNKNOWN_ERROR |
Impossible de traiter une requête Distance Matrix en raison d'une erreur du serveur. Si vous essayez à nouveau, la requête pourrait aboutir. |
Constantes DistanceMatrixElementStatus
Constantes google.maps.DistanceMatrixElementStatus
État au niveau de l'élément pour une paire point de départ-destination spécifique renvoyée par DistanceMatrixService
à la fin d'une requête Distance Matrix. Ces valeurs sont spécifiées sous forme de chaînes (par exemple, 'OK'
).
Pour y accéder, appelez const {DistanceMatrixElementStatus} = await google.maps.importLibrary("routes")
. Consultez Bibliothèques dans l'API Maps JavaScript.
Constantes | |
---|---|
NOT_FOUND |
Impossible de géocoder le point de départ et/ou la destination de cet élément. |
OK |
La réponse contient un résultat valide. |
ZERO_RESULTS |
Aucun itinéraire trouvé entre le point de départ et la destination. |