Classe DistanceMatrixService
Classe google.maps.DistanceMatrixService
Service permettant de calculer les distances entre plusieurs points de départ et destinations.
Accédez-y en appelant const {DistanceMatrixService} = await google.maps.importLibrary("routes")
. Consultez la section Bibliothèques de l'API Maps JavaScript.
Constructeur | |
---|---|
DistanceMatrixService |
DistanceMatrixService() Paramètres:aucun
Crée une instance d'un DistanceMatrixService qui envoie des requêtes de matrice de distance aux serveurs Google. |
Méthodes | |
---|---|
getDistanceMatrix |
getDistanceMatrix(request[, callback]) Paramètres:
Valeur renvoyée:
Promise<DistanceMatrixResponse> Envoie une requête Distance Matrix. |
Interface DistanceMatrixRequest
Interface google.maps.DistanceMatrixRequest
Requête Distance Matrix envoyée par DistanceMatrixService
contenant des tableaux de lieux de départ et de destination, ainsi que diverses options pour calculer 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 , à partir desquels calculer la distance et la durée. Obligatoire. |
origins |
Type:
Array<string|LatLng|LatLngLiteral|Place> Tableau contenant des chaînes d'adresse de départ, ou des objets LatLng ou Place , à partir desquels calculer la distance et la durée. Obligatoire. |
travelMode |
Type:
TravelMode Type de routage demandé. Obligatoire. |
avoidFerries optional |
Type:
boolean optional Si la valeur est true , le service Distance Matrix évite les ferries dans la mesure du possible. Facultatif. |
avoidHighways optional |
Type:
boolean optional Si la valeur est true , le service Distance Matrix est invité à éviter les autoroutes dans la mesure du possible. Facultatif. |
avoidTolls optional |
Type:
boolean optional Si la valeur est true , le service Distance Matrix évite 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 sur 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 de région utilisé comme biais pour les requêtes de géocodage. 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 où travelMode est TRANSIT. Cet objet n'aura aucun effet sur les autres modes de transport. |
unitSystem optional |
Type:
UnitSystem optional Système d'unités à utiliser de préférence pour afficher des distances. Facultatif. La valeur par défaut est "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, ainsi que d'une séquence de DistanceMatrixResponseRow
, une pour chaque adresse de départ correspondante.
Propriétés | |
---|---|
destinationAddresses |
Type:
Array<string> Adresses de destination formatées. |
originAddresses |
Type:
Array<string> Adresses d'expédition formatées. |
rows |
Lignes de la matrice, correspondant aux adresses de départ. |
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 de cet élément origine/destination. Cette propriété peut être non définie, car la distance peut être inconnue. |
duration |
Type:
Duration Durée de cette association origine-destination. Cette propriété peut être non définie, car la durée peut être inconnue. |
duration_in_traffic |
Type:
Duration Durée de cet appariement de l'origine et de la 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 disposant d'un forfait Premium lorsque drivingOptions est défini lors de la demande. |
fare |
Type:
TransitFare Tarif total pour cette combinaison d'origine-destination. Ne s'applique qu'aux requêtes de transports en commun. |
status |
État de cette association 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 de matrice de distances. Spécifiez-les par valeur ou en utilisant le nom de la constante. (par exemple, 'OK'
ou google.maps.DistanceMatrixStatus.OK
).
Accédez-y en appelant const {DistanceMatrixStatus} = await google.maps.importLibrary("routes")
. Consultez la section Bibliothèques de 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 essayez à nouveau 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 |
Une requête Distance Matrix n'a pas pu être traitée 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 concernant une association origine/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'
.
Accédez-y en appelant const {DistanceMatrixElementStatus} = await google.maps.importLibrary("routes")
. Consultez la section Bibliothèques de l'API Maps JavaScript.
Constantes | |
---|---|
NOT_FOUND |
Le point de départ et/ou la destination de cet élément n'ont pas pu être géocodés. |
OK |
La réponse contient un résultat valide. |
ZERO_RESULTS |
Aucun itinéraire n'a pu être identifié entre le point de départ et la destination. |