Classe DistanceMatrixService
google.maps.DistanceMatrixService
classe
biblioteca "routes"
const {DistanceMatrixService} = await google.maps.importLibrary("routes");
Construtor | |
|---|---|
DistanceMatrixService |
DistanceMatrixService()Parâmetros: nenhum
Cria uma nova instância de um DistanceMatrixService que envia consultas de matriz de distância para os servidores do Google. |
Métodos | |
|---|---|
getDistanceMatrix |
getDistanceMatrix(request[, callback])Parâmetros:
Valor de retorno:
Promise<DistanceMatrixResponse>Emite uma solicitação de matriz de distância. |
Interface DistanceMatrixRequest
Interface
google.maps.DistanceMatrixRequest
Uma consulta de matriz de distância enviada pelo DistanceMatrixService que contém matrizes de locais de origem e destino, além de várias opções para calcular métricas.
Propriedades | |
|---|---|
destinations |
Tipo:
Array<string|LatLng|LatLngLiteral|Place>Uma matriz que contém strings de endereço de destino ou objetos LatLng ou Place, usados como destino para calcular a distância e o tempo. Obrigatório. |
origins |
Tipo:
Array<string|LatLng|LatLngLiteral|Place>Uma matriz que contém strings de endereço de origem ou objetos LatLng ou Place, usados como origem para calcular a distância e o tempo. Obrigatório. |
travelMode |
Tipo:
TravelModeTipo de rota solicitada. Obrigatório. |
avoidFerries
opcional |
Tipo:
boolean optionalSe for true, instrui o serviço Matriz de Distância a evitar balsas sempre que possível. Opcional. |
avoidHighways
opcional |
Tipo:
boolean optionalSe for true, instrui o serviço Matriz de Distância a evitar rodovias sempre que possível. Opcional. |
avoidTolls
opcional |
Tipo:
boolean optionalSe for true, instrui o serviço Matriz de Distância a evitar vias com pedágio sempre que possível. Opcional. |
drivingOptions
opcional |
Tipo:
DrivingOptions optionalConfigurações que se aplicam apenas a solicitações em que travelMode é DRIVING. Esse objeto não terá efeito para outros meios de transporte. |
language
opcional |
Tipo:
string optionalUm identificador do idioma em que os resultados precisam ser retornados, quando possível. Consulte a lista de idiomas compatíveis. |
region
opcional |
Tipo:
string optionalCódigo de região utilizado como polarização para solicitações de geocodificação. O código de região aceita um valor de dois caracteres de ccTLD ("domínio de nível superior"). A maioria dos códigos ccTLD é idêntica aos códigos ISO 3166-1, com algumas exceções notáveis. Por exemplo, o ccTLD do Reino Unido é "uk" ( .co.uk), enquanto o código ISO 3166-1 é "gb" (tecnicamente para a entidade "Reino Unido da Grã-Bretanha e Irlanda do Norte"). |
transitOptions
opcional |
Tipo:
TransitOptions optionalConfigurações que se aplicam apenas a solicitações em que travelMode é TRANSIT. Esse objeto não terá efeito para outros meios de transporte. |
unitSystem
opcional |
Tipo:
UnitSystem optionalSistema de medidas escolhido para ser usado ao exibir a distância. Opcional. A opção padrão é métrica. |
Interface DistanceMatrixResponse
Interface
google.maps.DistanceMatrixResponse
A resposta a uma solicitação DistanceMatrixService, que consiste nos endereços de origem e destino formatados e em uma sequência de DistanceMatrixResponseRows, um para cada endereço de origem correspondente.
Propriedades | |
|---|---|
destinationAddresses |
Tipo:
Array<string>Os endereços de destino formatados. |
originAddresses |
Tipo:
Array<string>Os endereços de origem formatados. |
rows |
Tipo:
Array<DistanceMatrixResponseRow>As linhas da matriz, que correspondem aos endereços de origem. |
Interface DistanceMatrixResponseRow
Interface
google.maps.DistanceMatrixResponseRow
Uma linha da resposta a uma solicitação DistanceMatrixService, que consiste em uma sequência de DistanceMatrixResponseElements, uma para cada endereço de destino correspondente.
Propriedades | |
|---|---|
elements |
Os elementos da linha, que correspondem aos endereços de destino. |
Interface DistanceMatrixResponseElement
Interface
google.maps.DistanceMatrixResponseElement
Um único elemento de uma resposta a uma solicitação DistanceMatrixService, que contém a duração e a distância de uma origem até um destino.
Propriedades | |
|---|---|
distance |
Tipo:
DistanceA distância deste par de origem-destino. Esta propriedade pode ser indefinida quando a distância não for conhecida. |
duration |
Tipo:
DurationA duração deste par de origem-destino. Esta propriedade pode ser indefinida quando a duração não for conhecida. |
duration_in_traffic |
Tipo:
DurationA duração desse par de origem-destino, considerando as condições de trânsito indicadas pela propriedade trafficModel. Essa propriedade pode ser undefined, já que a duração pode ser desconhecida. Disponível apenas para clientes do Plano Premium quando drivingOptions é definido ao fazer a solicitação. |
fare |
Tipo:
TransitFareA tarifa total para esse par de origem e destino. Aplicável apenas a solicitações de transporte público. |
status |
O status deste par de origem-destino específico. |
Constantes DistanceMatrixStatus
google.maps.DistanceMatrixStatus
biblioteca de constantes
"routes"
O status de nível superior sobre a solicitação em geral retornado pela DistanceMatrixService após a conclusão de uma solicitação de matriz de distância. Especifique-os por valor ou usando o nome da constante. Por exemplo, 'OK' ou google.maps.DistanceMatrixStatus.OK.
Essas constantes também podem ser usadas como strings. No TypeScript, os literais de string são definidos pelo tipo DistanceMatrixStatusString.
const {DistanceMatrixStatus} = await google.maps.importLibrary("routes");
Constantes | |
|---|---|
INVALID_REQUEST |
A solicitação fornecida era inválida. |
MAX_DIMENSIONS_EXCEEDED |
A solicitação contém mais de 25 origens ou mais de 25 destinos. |
MAX_ELEMENTS_EXCEEDED |
O produto de origens e destinos excede o limite por consulta. |
OK |
A resposta contém um resultado válido. |
OVER_QUERY_LIMIT |
Um número excessivo de elementos foi solicitado dentro do prazo permitido. Tente novamente mais tarde. |
REQUEST_DENIED |
O serviço negou o uso do serviço Google Distance Matrix pela sua página da web. |
UNKNOWN_ERROR |
Não foi possível processar uma solicitação de matriz de distância devido a um erro no servidor. Se você tentar novamente, a solicitação poderá dar certo. |
Constantes DistanceMatrixElementStatus
google.maps.DistanceMatrixElementStatus
biblioteca de constantes
"routes"
O status no nível do elemento sobre um par de origem e destino específico retornado pelo DistanceMatrixService após a conclusão de uma solicitação de matriz de distância. Esses valores são especificados como strings, por exemplo, 'OK'.
Essas constantes também podem ser usadas como strings. No TypeScript, os literais de string são definidos pelo tipo DistanceMatrixElementStatusString.
const {DistanceMatrixElementStatus} = await google.maps.importLibrary("routes");
Constantes | |
|---|---|
NOT_FOUND |
A origem e/ou o destino do par não puderam ser geocodificados. |
OK |
A resposta contém um resultado válido. |
ZERO_RESULTS |
Nenhum trajeto foi encontrado entre a origem e o destino. |