Classe DistanceMatrixService
classe
google.maps.DistanceMatrixService
bibliothèque "routes"
const {DistanceMatrixService} = await google.maps.importLibrary("routes");
Constructeur | |
|---|---|
DistanceMatrixService |
DistanceMatrixService()Paramètres : aucun
Crée une instance de DistanceMatrixService qui envoie des requêtes de matrice des distances aux serveurs Google. |
Méthodes | |
|---|---|
getDistanceMatrix |
getDistanceMatrix(request[, callback])Paramètres :
Valeur renvoyée :
Promise<DistanceMatrixResponse>Émet une requête de matrice des distances. |
Interface DistanceMatrixRequest
interface
google.maps.DistanceMatrixRequest
Requête de matrice des distances envoyée par DistanceMatrixService contenant des tableaux de lieux de départ et de destination, 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, à utiliser comme destinations pour calculer des distances et des durées. 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 :
TravelModeType de routage demandé. Obligatoire. |
avoidFerries
facultatif |
Type :
boolean optionalSi la valeur est true, indique au service Matrice des distances d'éviter les ferries dans la mesure du possible. Facultatif. |
avoidHighways
facultatif |
Type :
boolean optionalSi la valeur est true, indique au service Matrice des distances d'éviter les autoroutes dans la mesure du possible. Facultatif. |
avoidTolls
facultatif |
Type :
boolean optionalSi la valeur est true, indique au service Distance Matrix d'éviter les routes à péage dans la mesure du possible. Facultatif. |
drivingOptions
facultatif |
Type :
DrivingOptions optionalParamètres qui ne s'appliquent qu'aux requêtes où travelMode est DRIVING. Cet objet n'aura aucun effet sur les autres modes de transport. |
language
facultatif |
Type :
string optionalIdentifiant de la langue dans laquelle les résultats doivent être renvoyés, si possible. Consultez la liste des langues disponibles. |
region
facultatif |
Type :
string optionalCode 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
facultatif |
Type :
TransitOptions optionalParamètres qui ne s'appliquent qu'aux requêtes où travelMode est défini sur TRANSIT. Cet objet n'aura aucun effet sur les autres modes de transport. |
unitSystem
facultatif |
Type :
UnitSystem optionalSystème d'unités à utiliser pour afficher des distances. Facultatif. La valeur par défaut est "metric". |
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 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 |
Type :
Array<DistanceMatrixResponseRow>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 |
Type :
Array<DistanceMatrixResponseElement>É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 :
DistanceDistance pour cette paire point de départ-point de destination. Cette propriété peut être non définie, car la distance peut être inconnue. |
duration |
Type :
DurationDurée de cette association point de départ-destination. Cette propriété peut être non définie, car la durée peut être inconnue. |
duration_in_traffic |
Type :
DurationDuré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 lors de la requête. |
fare |
Type :
TransitFareTarif total pour cette combinaison origine-destination. Applicable uniquement aux requêtes de transports en commun. |
status |
Type :
DistanceMatrixElementStatusÉtat de cette association point de départ-destination. |
Constantes DistanceMatrixStatus
google.maps.DistanceMatrixStatus
bibliothèque "routes"
État de niveau supérieur de la requête en général, renvoyé par DistanceMatrixService une fois la requête de matrice des distances terminée. Spécifiez-les par valeur ou en utilisant le nom de la constante. Par exemple, 'OK' ou google.maps.DistanceMatrixStatus.OK.
Ces constantes peuvent également être utilisées comme des chaînes. En TypeScript, les littéraux de chaîne sont définis par le type DistanceMatrixStatusString.
const {DistanceMatrixStatus} = await google.maps.importLibrary("routes");
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 Matrice des distances 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
google.maps.DistanceMatrixElementStatus
bibliothèque "routes"
État au niveau de l'élément concernant une association origine-destination spécifique renvoyée par DistanceMatrixService à la fin d'une requête de matrice des distances. Ces valeurs sont spécifiées sous forme de chaînes, par exemple 'OK'.
Ces constantes peuvent également être utilisées comme des chaînes. En TypeScript, les littéraux de chaîne sont définis par le type DistanceMatrixElementStatusString.
const {DistanceMatrixElementStatus} = await google.maps.importLibrary("routes");
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. |