Classe DirectionsService
Classe
google.maps.DirectionsService
Um serviço para calcular rotas entre dois ou mais lugares.
Acesse chamando const {DirectionsService} = await google.maps.importLibrary("routes")
. Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
---|---|
DirectionsService |
DirectionsService() Parâmetros:nenhum
Cria uma nova instância de um DirectionsService que envia consultas de trajeto aos servidores do Google. |
Métodos | |
---|---|
route |
route(request[, callback]) Parâmetros:
Valor de retorno:
Promise<DirectionsResult> Envia uma solicitação de pesquisa de rota. |
Interface DirectionsRequest
Interface
google.maps.DirectionsRequest
Uma consulta de trajeto a ser enviada para o DirectionsService
.
Propriedades | |
---|---|
destination |
Tipo:
string|LatLng|Place|LatLngLiteral Local de destino. Ele pode ser especificado como uma string a ser geocodificada, um LatLng ou um Place . Obrigatório. |
origin |
Tipo:
string|LatLng|Place|LatLngLiteral Local de origem. Ele pode ser especificado como uma string a ser geocodificada, um LatLng ou um Place . Obrigatório. |
travelMode |
Tipo:
TravelMode Tipo de rota solicitada. Obrigatório. |
avoidFerries optional |
Tipo:
boolean optional Se true , instrui o serviço Directions a evitar balsas sempre que possível. Opcional. |
avoidHighways optional |
Tipo:
boolean optional Se true , instrui o serviço de trajetos a evitar rodovias sempre que possível. Opcional. |
avoidTolls optional |
Tipo:
boolean optional Se true , instrui o serviço de direções a evitar vias com pedágio sempre que possível. Opcional. |
drivingOptions optional |
Tipo:
DrivingOptions optional Configurações que se aplicam apenas a solicitações em que travelMode é DRIVING . Esse objeto não vai ter efeito em outros modos de transporte. |
language optional |
Tipo:
string optional Um identificador de idioma para o idioma em que os resultados precisam ser retornados, quando possível. Consulte a lista de idiomas compatíveis. |
optimizeWaypoints optional |
Tipo:
boolean optional Se definido como true , o DirectionsService vai tentar reordenar os pontos intermediários fornecidos para minimizar o custo geral da rota. Se os pontos de passagem forem otimizados, inspecione DirectionsRoute.waypoint_order na resposta para determinar a nova ordem. |
provideRouteAlternatives optional |
Tipo:
boolean optional Indica se trajetos alternativos devem ser fornecidos ou não. Opcional. |
region optional |
Tipo:
string optional Código de região utilizado como polarização para solicitações de geocodificação. O código regional 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 ), e o código ISO 3166-1 é "gb" (tecnicamente, para a entidade "Reino Unido da Grã-Bretanha e Irlanda do Norte"). |
transitOptions optional |
Tipo:
TransitOptions optional Configurações que se aplicam apenas a solicitações em que travelMode é TRANSIT. Esse objeto não vai ter efeito em outros modos de transporte. |
unitSystem optional |
Tipo:
UnitSystem optional Padrão:o sistema de unidades usado no país de origem.
Sistema de medidas escolhido para ser usado ao exibir a distância. |
waypoints optional |
Tipo:
Array<DirectionsWaypoint> optional Matriz de pontos de referência intermediários. As rotas são calculadas da origem ao destino por meio de cada ponto de passagem nessa matriz. Consulte o guia para desenvolvedores para saber o número máximo de waypoints permitidos. Não são permitidos waypoints nas rotas de transporte público. Opcional. |
Constantes DirectionsStatus
Constantes
google.maps.DirectionsStatus
O status retornado pela DirectionsService
na conclusão de uma chamada para route()
. Especifique esses valores pelo valor ou usando o nome da constante. Por exemplo, 'OK'
ou google.maps.DirectionsStatus.OK
.
Acesse chamando const {DirectionsStatus} = await google.maps.importLibrary("routes")
. Consulte Bibliotecas na API Maps JavaScript.
Constantes | |
---|---|
INVALID_REQUEST |
O DirectionsRequest fornecido é inválido. |
MAX_WAYPOINTS_EXCEEDED |
Foram fornecidas muitas DirectionsWaypoint s no DirectionsRequest . Consulte o guia para desenvolvedores para saber o número máximo de waypoints permitidos. |
NOT_FOUND |
Não foi possível geocodificar a origem, o destino ou algum ponto de referência. |
OK |
A resposta contém um DirectionsResult válido. |
OVER_QUERY_LIMIT |
A página web ultrapassou o limite de solicitações em um período muito curto. |
REQUEST_DENIED |
A página web não tem permissão para usar o serviço de rotas. |
UNKNOWN_ERROR |
Não foi possível processar uma solicitação de rota devido a um erro no servidor. Se você tentar novamente, a solicitação poderá dar certo. |
ZERO_RESULTS |
Nenhum trajeto foi encontrado entre a origem e o destino. |
Interface DirectionsResult
Interface
google.maps.DirectionsResult
A resposta das rotas recuperada do servidor de rotas. É possível renderizar esses elementos usando um DirectionsRenderer
ou analisar e renderizar o objeto. É necessário exibir os avisos e direitos autorais conforme indicado nos Termos de Serviço da Plataforma Google Maps. Embora esse resultado seja "semelhante a JSON", ele não é estritamente JSON, porque inclui objetos LatLng
indiretamente.
Propriedades | |
---|---|
request |
Tipo:
DirectionsRequest A DirectionsRequest que gerou esse resultado. |
routes |
Tipo:
Array<DirectionsRoute> Uma matriz de DirectionsRoute s, cada uma com informações sobre os trechos e etapas que a compõem. Só haverá uma rota, a menos que DirectionsRequest tenha sido criado com provideRouteAlternatives definido como true . |
available_travel_modes optional |
Tipo:
Array<TravelMode> optional Contém uma matriz de meios de transporte disponíveis. Esse campo é retornado quando uma solicitação especifica um modo de transporte e não recebe resultados. A matriz contém os modos de transporte disponíveis nos países do determinado conjunto de pontos de referência. Esse campo não é retornado se um ou mais dos waypoints forem "via waypoints". |
geocoded_waypoints optional |
Tipo:
Array<DirectionsGeocodedWaypoint> optional Uma matriz de DirectionsGeocodedWaypoint s, cada uma com informações sobre a geocodificação da origem, do destino e dos waypoints. |
Classe DirectionsRenderer
Classe
google.maps.DirectionsRenderer
Renderiza rotas obtidas do DirectionsService
.
Essa classe estende
MVCObject
.
Acesse chamando const {DirectionsRenderer} = await google.maps.importLibrary("routes")
. Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
---|---|
DirectionsRenderer |
DirectionsRenderer([opts]) Parâmetros:
Cria o renderizador com as opções especificadas. As rotas podem ser renderizadas em um mapa (como sobreposições visuais) ou em um painel <div> (como instruções textuais). |
Métodos | |
---|---|
getDirections |
getDirections() Parâmetros:nenhum
Valor de retorno:
DirectionsResult Retorna o conjunto de rotas atual do renderizador. |
getMap |
getMap() Parâmetros:nenhum
Valor de retorno:
Map Retorna o mapa em que o DirectionsResult é renderizado. |
getPanel |
getPanel() Parâmetros:nenhum
Valor de retorno:
HTMLElement|null Retorna o painel <div> em que o DirectionsResult é renderizado. |
getRouteIndex |
getRouteIndex() Parâmetros:nenhum
Valor de retorno:
number Retorna o índice de rota atual (baseado em zero) em uso por este objeto DirectionsRenderer . |
setDirections |
setDirections(directions) Parâmetros:
Valor de retorno:nenhum
Defina o renderizador para usar o resultado do DirectionsService . A definição de um conjunto válido de rotas desse modo exibirá as rotas no mapa e painel designados do renderizador. |
setMap |
setMap(map) Parâmetros:
Valor de retorno:nenhum
Este método especifica o mapa no qual as rotas serão renderizadas. Passe null para remover as rotas do mapa. |
setOptions |
setOptions(options) Parâmetros:
Valor de retorno:nenhum
Muda as configurações de opções desse DirectionsRenderer após a inicialização. |
setPanel |
setPanel(panel) Parâmetros:
Valor de retorno:nenhum
Esse método renderiza as direções em um <div> . Transmita null para remover o conteúdo do painel. |
setRouteIndex |
setRouteIndex(routeIndex) Parâmetros:
Valor de retorno:nenhum
Defina o índice (baseado em zero) da rota no objeto DirectionsResult a ser renderizado. Por padrão, o primeiro trajeto na matriz será renderizado. |
Herdado:
addListener ,
bindTo ,
get ,
notify ,
set ,
setValues ,
unbind ,
unbindAll
|
Eventos | |
---|---|
directions_changed |
function() Argumentos: nenhum
Esse evento é acionado quando as direções renderizadas mudam, quando um novo DirectionsResult é definido ou quando o usuário termina de arrastar uma mudança no caminho das direções. |
Interface DirectionsRendererOptions
Interface
google.maps.DirectionsRendererOptions
Esse objeto define as propriedades que podem ser definidas em um objeto DirectionsRenderer
.
Propriedades | |
---|---|
directions optional |
Tipo:
DirectionsResult optional As direções a serem mostradas no mapa e/ou em um painel <div> , recuperadas como um objeto DirectionsResult de DirectionsService . |
draggable optional |
Tipo:
boolean optional Se true , permite que o usuário arraste e modifique os caminhos das rotas renderizadas por esse DirectionsRenderer . |
hideRouteList optional |
Tipo:
boolean optional Padrão:
false Essa propriedade indica se o renderizador precisa fornecer uma lista de rotas selecionável pelo usuário mostrada no painel de direções. |
infoWindow optional |
Tipo:
InfoWindow optional O InfoWindow em que as informações de texto são renderizadas quando um marcador é clicado. O conteúdo da janela de informações existente será substituído e sua posição movida. Se nenhuma janela de informações for especificada, o DirectionsRenderer vai criar e usar a própria janela de informações. Essa propriedade será ignorada se suppressInfoWindows for definido como true . |
map optional |
Tipo:
Map optional Mapa no qual exibir as rotas. |
markerOptions optional |
Tipo:
MarkerOptions optional Opções para os marcadores. Todos os marcadores renderizados pelo DirectionsRenderer vão usar essas opções. |
panel optional |
Tipo:
HTMLElement optional O <div> em que as etapas das direções serão exibidas. |
polylineOptions optional |
Tipo:
PolylineOptions optional Opções para as polilinhas. Todas as polilinhas renderizadas pelo DirectionsRenderer vão usar essas opções. |
preserveViewport optional |
Tipo:
boolean optional Padrão:
false Se essa opção for definida como true ou se o centro e o zoom do mapa nunca tiverem sido definidos, o mapa de entrada será centralizado e terá o zoom aplicado à caixa delimitadora desse conjunto de direções. |
routeIndex optional |
Tipo:
number optional O índice da rota no objeto DirectionsResult . O valor padrão é 0. |
suppressBicyclingLayer optional |
Tipo:
boolean optional Suprime a renderização do BicyclingLayer quando as rotas de bicicleta são solicitadas. |
suppressInfoWindows optional |
Tipo:
boolean optional Remove a renderização da janela de informações. |
suppressMarkers optional |
Tipo:
boolean optional Remove a renderização de marcadores. |
suppressPolylines optional |
Tipo:
boolean optional Remove a renderização de polilinhas. |
Interface DirectionsWaypoint
Interface
google.maps.DirectionsWaypoint
Um DirectionsWaypoint
representa um local entre a origem e o destino por onde a viagem precisa ser roteada.
Propriedades | |
---|---|
location optional |
Tipo:
string|LatLng|LatLngLiteral|Place optional Local do ponto de referência. Pode ser uma string de endereço, um LatLng ou um Place . Opcional. |
stopover optional |
Tipo:
boolean optional Padrão:
true Se true , indica que este waypoint é uma parada entre a origem e o destino. Isso divide o trajeto em duas partes. Se false , indica que o trajeto precisa passar por esse waypoint, mas não pode ser dividido em duas pernas. Isso é útil se você quiser criar uma rota em resposta ao usuário arrastando pontos de passagem em um mapa. |
Interface DirectionsGeocodedWaypoint
Interface
google.maps.DirectionsGeocodedWaypoint
Um único ponto de passagem geocodificado.
Propriedades | |
---|---|
partial_match optional |
Tipo:
boolean optional Indica se o geocodificador não retornou uma correspondência exata para o ponto de passagem original, mas conseguiu corresponder parte do endereço solicitado. |
place_id optional |
Tipo:
string optional O ID do lugar associado ao ponto de passagem. IDs de lugares identificam um local de modo exclusivo no banco de dados do Google Places e no Google Maps. Saiba mais sobre os IDs de lugar no guia para desenvolvedores da API Places. |
types optional |
Tipo:
Array<string> optional Uma matriz de strings que denotam o tipo do elemento geocodificado retornado. Para uma lista de strings possíveis, consulte a seção Tipos de componentes de endereço do guia para desenvolvedores. |
Interface DirectionsRoute
Interface
google.maps.DirectionsRoute
Uma única rota que contém um conjunto de trechos em um DirectionsResult
. Embora esse objeto seja "semelhante a JSON", ele não é estritamente JSON, porque inclui objetos LatLng
direta e indiretamente.
Propriedades | |
---|---|
bounds |
Tipo:
LatLngBounds Os limites para este trajeto. |
copyrights |
Tipo:
string O texto de direitos autorais a ser exibido para este trajeto. |
legs |
Tipo:
Array<DirectionsLeg> Uma matriz de DirectionsLeg s, cada uma contendo informações sobre as etapas das quais é composta. Haverá um trecho para cada waypoint ou destino de escala especificado. Assim, um trajeto sem waypoints com parada terá um DirectionsLeg , e um com um waypoint com parada terá dois. |
overview_path |
Uma matriz de LatLng s que representa todo o curso desta rota. O caminho é simplificado para se adequar a contextos onde é necessário um pequeno número de vértices (como os URLs da Google Static Maps API). |
overview_polyline |
Tipo:
string Uma representação codificada de polilinha do trajeto em overview_path. Essa polilinha é um caminho aproximado (suavizado) da rota resultante. |
summary |
Tipo:
string Contém uma breve descrição textual da rota, adequada para nomear e diferenciar a rota das alternativas. |
warnings |
Tipo:
Array<string> Avisos a serem exibidos quando estas rotas estiverem sendo mostradas. |
waypoint_order |
Tipo:
Array<number> Se optimizeWaypoints for definido como true , esse campo vai conter a permutação reordenada dos waypoints de entrada. Por exemplo, se a entrada for:Origem: Los Angeles Pontos de passagem: Dallas, Bangor, Phoenix Destino: Nova York e a saída otimizada for ordenada da seguinte forma: Origem: Los Angeles Pontos de passagem: Phoenix, Dallas, Bangor Destino: Nova York então esse campo será um Array contendo os valores [2, 0, 1]. A numeração dos pontos de referência é baseada em zero.Se algum dos pontos de passagem de entrada tiver stopover definido como false , esse campo vai ficar vazio, já que a otimização de trajeto não está disponível para essas consultas. |
fare optional |
Tipo:
TransitFare optional A tarifa total de toda a viagem de transporte público. Aplicável apenas a solicitações de transporte público. |
Interface DirectionsLeg
Interface
google.maps.DirectionsLeg
Um único trecho que consiste em um conjunto de etapas em um DirectionsResult
. Alguns campos no trecho podem não ser retornados para todas as solicitações. Embora esse resultado seja "semelhante a JSON", ele não é estritamente JSON, porque inclui objetos LatLng
direta e indiretamente.
Propriedades | |
---|---|
end_address |
Tipo:
string O endereço do destino deste trecho. O conteúdo precisa ser lido no estado em que se encontra. Não analise o endereço formatado de maneira programática. |
end_location |
Tipo:
LatLng O DirectionsService calcula rotas entre locais usando a opção de transporte mais próxima (geralmente uma estrada) do ponto inicial e final. end_location indica o destino geocodificado real, que pode ser diferente da end_location da última etapa se, por exemplo, a estrada não estiver perto do destino deste trecho. |
start_address |
Tipo:
string O endereço da origem deste trecho. O conteúdo precisa ser lido no estado em que se encontra. Não analise o endereço formatado de maneira programática. |
start_location |
Tipo:
LatLng O DirectionsService calcula rotas entre locais usando a opção de transporte mais próxima (geralmente uma estrada) do ponto inicial e final. start_location indica a origem geocodificada real, que pode ser diferente da start_location da primeira etapa se, por exemplo, a estrada não estiver perto da origem deste trecho. |
steps |
Tipo:
Array<DirectionsStep> Uma matriz de DirectionsStep s, cada uma contendo informações sobre as etapas individuais desse trecho. |
|
Tipo:
Array<?> Informações sobre a velocidade do trânsito ao longo do trecho. |
via_waypoints |
Uma matriz de waypoints sem escala ao longo desta etapa, que foram especificados na solicitação original. Descontinuado em trajetos alternativos. A 3.27 será a última versão da API que adiciona Ao usar o serviço de direções para implementar rotas arrastáveis, é recomendável desativar o arrasto de trajetos alternativos. Somente o trajeto principal deve ser arrastável. Os usuários podem arrastar o trajeto principal até que ele corresponda a um trajeto alternativo. |
arrival_time optional |
Tipo:
Time optional Um horário de chegada estimado para este trecho. Aplicável apenas a solicitações de TRANSIT. |
departure_time optional |
Tipo:
Time optional Um horário de partida estimado para este trecho. Aplicável apenas a solicitações de TRANSIT. |
distance optional |
Tipo:
Distance optional A distância total coberta por este trecho. Esta propriedade pode ser indefinida quando a distância não for conhecida. |
duration optional |
Tipo:
Duration optional A duração total deste trecho. Essa propriedade pode ser undefined , porque a duração pode ser desconhecida. |
duration_in_traffic optional |
Tipo:
Duration optional A duração total desse trecho, considerando as condições de trânsito indicadas pela propriedade trafficModel . Essa propriedade pode ser undefined , porque a duração pode ser desconhecida. |
Interface DirectionsStep
Interface
google.maps.DirectionsStep
Um único DirectionsStep
em um DirectionsResult
. Alguns campos podem ser undefined
. Embora esse objeto seja "semelhante a JSON", ele não é estritamente JSON, porque inclui objetos LatLng
diretamente.
Propriedades | |
---|---|
encoded_lat_lngs |
Tipo:
string Uma representação codificada de polilinha da etapa. Esse é um caminho aproximado (suavizado) da etapa. |
end_location |
Tipo:
LatLng O local final desta etapa. |
|
Tipo:
LatLng O local final desta etapa. |
instructions |
Tipo:
string Instruções para esta etapa. |
|
Uma sequência de LatLng s que descreve o curso dessa etapa. Esse é um caminho aproximado (suavizado) da etapa. |
maneuver |
Tipo:
string Contém a ação a ser realizada na etapa atual ( turn-left , merge , straight etc.). Os valores estão sujeitos a mudanças, e novos valores podem ser introduzidos sem aviso prévio. |
path |
Uma sequência de LatLng s que descreve o curso dessa etapa. Esse é um caminho aproximado (suavizado) da etapa. |
start_location |
Tipo:
LatLng O local inicial desta etapa. |
|
Tipo:
LatLng O local inicial desta etapa. |
travel_mode |
Tipo:
TravelMode O modo de viagem usado nesta etapa. |
distance optional |
Tipo:
Distance optional A distância coberta por esta etapa. Essa propriedade pode ser undefined , porque a distância pode ser desconhecida. |
duration optional |
Tipo:
Duration optional O tempo normalmente necessário para a execução desta etapa, em segundos e no formato de texto. Essa propriedade pode ser undefined , porque a duração pode ser desconhecida. |
|
Tipo:
DirectionsPolyline optional Contém um objeto com uma única propriedade, "pontos", que contém uma representação da polilinha codificada da etapa. Essa polilinha é um caminho aproximado (suavizado) da etapa. |
steps optional |
Tipo:
Array<DirectionsStep> optional Subetapas desta etapa. Especificado para trechos não de transporte público das rotas de transporte público. |
transit optional |
Tipo:
TransitDetails optional Detalhes específicos sobre essa etapa. Essa propriedade será indefinida, a menos que o modo de deslocamento dessa etapa seja TRANSIT . |
transit_details optional |
Tipo:
TransitDetails optional Detalhes relacionados a esta etapa se o modo de viagem for TRANSIT . |
Interface DirectionsPolyline
Interface
google.maps.DirectionsPolyline
Um objeto que contém uma propriedade points
para descrever a polilinha de um DirectionsStep
.
Propriedades | |
---|---|
points |
Tipo:
string Uma polilinha codificada. |
Interface Place
Interface
google.maps.Place
Contém as informações necessárias para localizar, identificar ou descrever um lugar para um DirectionsRequest
ou DistanceMatrixRequest
. Nesse contexto, "lugar" significa uma empresa, um ponto de interesse ou uma localização geográfica. Para buscar informações sobre um lugar, consulte PlacesService
.
Propriedades | |
---|---|
location optional |
Tipo:
LatLng|LatLngLiteral optional O LatLng da entidade descrita por esse lugar. |
placeId optional |
Tipo:
string optional O ID do lugar (como uma empresa ou um ponto de interesse). O ID de lugar é um identificador exclusivo de um lugar no banco de dados do Google Maps. O placeId é a maneira mais precisa de identificar um lugar. Se possível, especifique placeId em vez de query . Um ID de lugar pode ser recuperado de qualquer solicitação à API Places, como uma TextSearch. Os IDs de lugar também podem ser recuperados de solicitações à API Geocoding. Para mais informações, consulte a visão geral dos IDs de lugar. |
query optional |
Tipo:
string optional Uma consulta de pesquisa que descreve o lugar (como uma empresa ou um ponto de interesse). Um exemplo de consulta é "Quay, Upper Level, Overseas Passenger Terminal 5 Hickson Road, The Rocks NSW". Se possível, especifique placeId em vez de query . A API não garante a precisão da resolução da string de consulta para um lugar. Se placeId e query forem fornecidos, um erro vai ocorrer. |
Constantes TravelMode
Constantes
google.maps.TravelMode
Os meios de transporte válidos que podem ser especificados em um DirectionsRequest
, bem como os meios de transporte retornados em um DirectionsStep
. Especifique esses valores pelo valor ou usando o nome da constante. Por exemplo, 'BICYCLING'
ou google.maps.TravelMode.BICYCLING
.
Acesse chamando const {TravelMode} = await google.maps.importLibrary("routes")
. Consulte Bibliotecas na API Maps JavaScript.
Constantes | |
---|---|
BICYCLING |
Especifica uma solicitação de rotas de ciclismo. |
DRIVING |
Especifica uma solicitação de rotas de carro. |
TRANSIT |
Especifica uma solicitação de trajeto de transporte público. |
WALKING |
Especifica uma solicitação de rotas a pé. |
Interface DrivingOptions
Interface
google.maps.DrivingOptions
Configura o DirectionsRequest
quando o modo de viagem está definido como DRIVING
.
Propriedades | |
---|---|
departureTime |
Tipo:
Date O horário de partida desejado para a rota, especificado como um objeto Date . O objeto Date mede o tempo em milissegundos desde 1º de janeiro de 1970. É preciso especificar esse valor para que um DrivingOptions seja válido. O horário de partida precisa ser definido como o horário atual ou algum horário no futuro. Seu valor não pode estar no passado. |
trafficModel optional |
Tipo:
TrafficModel optional A suposição preferencial a ser usada ao prever a duração no trânsito. O padrão é BEST_GUESS . |
Constantes do TrafficModel
Constantes
google.maps.TrafficModel
As suposições a serem usadas ao prever a duração no trânsito. Especificado como parte de um DirectionsRequest
ou DistanceMatrixRequest
. Especifique esses valores pelo valor ou usando o nome da constante. Por exemplo, 'bestguess'
ou google.maps.TrafficModel.BEST_GUESS
.
Acesse chamando const {TrafficModel} = await google.maps.importLibrary("routes")
. Consulte Bibliotecas na API Maps JavaScript.
Constantes | |
---|---|
BEST_GUESS |
Use dados históricos de trânsito para estimar melhor o tempo gasto no trânsito. |
OPTIMISTIC |
Use dados históricos de tráfego para fazer uma estimativa otimista da duração do tráfego. |
PESSIMISTIC |
Use dados históricos de tráfego para fazer uma estimativa pessimista da duração do tráfego. |
Interface TransitOptions
Interface
google.maps.TransitOptions
O objeto TransitOptions a ser incluído em um DirectionsRequest
quando o modo de transporte estiver definido como TRANSIT.
Propriedades | |
---|---|
arrivalTime optional |
Tipo:
Date optional O horário de chegada desejado para o trajeto, especificado como um objeto Date. O objeto Date mede o tempo em milissegundos desde 1º de janeiro de 1970. Se o horário de chegada é especificado, o horário de partida é ignorado. |
departureTime optional |
Tipo:
Date optional O horário de partida desejado para o trajeto, especificado como um objeto Date. O objeto Date mede o tempo em milissegundos desde 1º de janeiro de 1970. Se nem o horário de partida nem o de chegada forem especificados, o horário será considerado "agora". |
modes optional |
Tipo:
Array<TransitMode> optional Um ou mais meios de transporte preferidos, como ônibus ou trem. Se nenhuma preferência for fornecida, a API vai retornar o melhor trajeto padrão. |
routingPreference optional |
Tipo:
TransitRoutePreference optional Uma preferência que pode influenciar a escolha da rota de transporte público, como caminhar menos. Se nenhuma preferência for fornecida, a API vai retornar o melhor trajeto padrão. |
Constantes TransitMode
Constantes
google.maps.TransitMode
O modo de transporte público válido, por exemplo, ônibus, que pode ser especificado em um TransitOptions
. Especifique esses valores pelo valor ou usando o nome da constante. Por exemplo, 'BUS'
ou google.maps.TransitMode.BUS
.
Acesse chamando const {TransitMode} = await google.maps.importLibrary("routes")
. Consulte Bibliotecas na API Maps JavaScript.
Constantes | |
---|---|
BUS |
Especifica o ônibus como o meio de transporte preferido. |
RAIL |
Especifica o trem como o meio de transporte preferido. |
SUBWAY |
Especifica o metrô como o meio de transporte preferido. |
TRAIN |
Especifica o trem como o meio de transporte preferido. |
TRAM |
Especifica o bonde como o meio de transporte preferido. |
Constantes TransitRoutePreference
Constantes
google.maps.TransitRoutePreference
O tipo de trajeto de transporte público válido que pode ser especificado em um TransitOptions
. Especifique esses valores pelo valor ou usando o nome da constante. Por exemplo, 'LESS_WALKING'
ou google.maps.TransitRoutePreference.LESS_WALKING
.
Acesse chamando const {TransitRoutePreference} = await google.maps.importLibrary("routes")
. Consulte Bibliotecas na API Maps JavaScript.
Constantes | |
---|---|
FEWER_TRANSFERS |
Especifica que o trajeto calculado precisa preferir um número limitado de transferências. |
LESS_WALKING |
Especifica que o trajeto calculado deve preferir pouca caminhada. |
Interface TransitFare
Interface
google.maps.TransitFare
Uma tarifa de um DirectionsRoute
que consiste em valor e moeda.
Propriedades | |
---|---|
currency |
Tipo:
string Um código de moeda ISO 4217 que indica a moeda em que a tarifa é expressa. |
value |
Tipo:
number O valor numérico da tarifa, expresso no currency fornecido. |
Interface TransitDetails
Interface
google.maps.TransitDetails
Detalhes sobre a partida, a chegada e o modo de transporte usado nesta etapa.
Propriedades | |
---|---|
arrival_stop |
Tipo:
TransitStop A parada de chegada desta etapa de transporte público. |
arrival_time |
Tipo:
Time O horário de chegada desta etapa, especificado como um objeto Time. |
departure_stop |
Tipo:
TransitStop A parada de partida dessa etapa de transporte público. |
departure_time |
Tipo:
Time O horário de partida desta etapa, especificado como um objeto Time. |
headsign |
Tipo:
string A direção de deslocamento nessa linha, conforme marcada no veículo ou no ponto de partida. |
headway |
Tipo:
number O número esperado de segundos entre veículos equivalentes nessa parada. |
line |
Tipo:
TransitLine Detalhes sobre a linha de transporte público usada nesta etapa. |
num_stops |
Tipo:
number O número de paradas nesta etapa. Esse número inclui a parada de chegada, mas não a de partida. |
trip_short_name |
Tipo:
string O texto que aparece nos horários e mostradores para identificar uma viagem de transporte público aos passageiros, por exemplo, identificar os números dos trens em viagens em trens metropolitanos. O texto identifica exclusivamente uma viagem em um dia de serviço. |
Interface TransitStop
Interface
google.maps.TransitStop
Detalhes sobre uma estação ou parada de transporte público.
Propriedades | |
---|---|
location |
Tipo:
LatLng O local da parada. |
name |
Tipo:
string O nome dessa parada de transporte público. |
Interface TransitLine
Interface
google.maps.TransitLine
Informações sobre a linha de transporte público que opera esta etapa de transporte público.
Propriedades | |
---|---|
agencies |
Tipo:
Array<TransitAgency> A empresa de transporte público que opera essa linha. |
color |
Tipo:
string A cor normalmente usada na sinalização dessa linha de transporte público, representada como uma string hexadecimal. |
icon |
Tipo:
string O URL de um ícone associado a essa linha. |
name |
Tipo:
string O nome completo dessa linha de transporte, por exemplo, "8 Avenue Local". |
short_name |
Tipo:
string O nome abreviado dessa linha de transporte público, por exemplo, "E". |
text_color |
Tipo:
string A cor do texto normalmente usada na sinalização dessa linha de transporte público, representada como uma string hexadecimal. |
url |
Tipo:
string O URL da agência específico dessa linha de transporte público. |
vehicle |
Tipo:
TransitVehicle O tipo de veículo usado, por exemplo, trem ou ônibus. |
Interface TransitAgency
Interface
google.maps.TransitAgency
Informações sobre uma empresa que opera uma linha de transporte público.
Propriedades | |
---|---|
name |
Tipo:
string O nome da empresa de transporte público. |
phone |
Tipo:
string O número de telefone da empresa de transporte público. |
url |
Tipo:
string O URL da empresa de transporte público. |
Interface TransitVehicle
Interface
google.maps.TransitVehicle
Informações sobre o veículo que opera em uma linha de transporte público.
Propriedades | |
---|---|
icon |
Tipo:
string Um URL de um ícone que corresponde ao tipo de veículo usado nessa linha. |
local_icon |
Tipo:
string Um URL de um ícone que corresponde ao tipo de veículo usado nessa região, em vez do ícone mais geral. |
name |
Tipo:
string Um nome para esse tipo de TransitVehicle, por exemplo, "Trem" ou "Ônibus". |
type |
Tipo:
VehicleType O tipo de veículo usado, por exemplo, trem, ônibus ou balsa. |
Constantes VehicleType
Constantes
google.maps.VehicleType
Valores possíveis para tipos de veículo.
Acesse chamando const {VehicleType} = await google.maps.importLibrary("routes")
. Consulte Bibliotecas na API Maps JavaScript.
Constantes | |
---|---|
BUS |
Ônibus |
CABLE_CAR |
Um veículo que opera por meio de um cabo, normalmente terrestre. Bondes aéreos podem ser do tipo GONDOLA_LIFT . |
COMMUTER_TRAIN |
Trem metropolitano. |
FERRY |
Balsa. |
FUNICULAR |
Um veículo puxado por cabo em declives acentuados. |
GONDOLA_LIFT |
Um bonde aéreo. |
HEAVY_RAIL |
Vagões pesados. |
HIGH_SPEED_TRAIN |
Trem de alta velocidade. |
INTERCITY_BUS |
Ônibus intermunicipal. |
METRO_RAIL |
Veículo leve sobre trilhos. |
MONORAIL |
Monotrilho. |
OTHER |
Outros veículos. |
RAIL |
Trem |
SHARE_TAXI |
O táxi compartilhado é uma espécie de ônibus que pode deixar e pegar passageiros em qualquer ponto do trajeto. Geralmente, o táxi compartilhado usa veículos de micro-ônibus. |
SUBWAY |
Veículo leve subterrâneo. |
TRAM |
Veículo leve acima do chão. |
TROLLEYBUS |
Ônibus elétrico. |
Constantes do UnitSystem
Constantes
google.maps.UnitSystem
Os sistemas de unidades válidos que podem ser especificados em um DirectionsRequest
.
Acesse chamando const {UnitSystem} = await google.maps.importLibrary("core")
. Consulte Bibliotecas na API Maps JavaScript.
Constantes | |
---|---|
IMPERIAL |
Especifica que as distâncias no DirectionsResult precisam ser expressas em unidades imperiais. |
METRIC |
Especifica que as distâncias no DirectionsResult precisam ser expressas em unidades métricas. |
Interface Distance
Interface
google.maps.Distance
Uma representação da distância como um valor numérico e uma string de exibição.
Propriedades | |
---|---|
text |
Tipo:
string Uma representação em string do valor da distância, usando o UnitSystem especificado na solicitação. |
value |
Tipo:
number A distância em metros. |
Interface Duration
Interface
google.maps.Duration
Uma representação da duração como um valor numérico e uma string de exibição.
Propriedades | |
---|---|
text |
Tipo:
string Uma string que representa o valor da duração. |
value |
Tipo:
number A duração em segundos. |
Interface Time
Interface
google.maps.Time
Uma representação do tempo como um objeto Date, uma string localizada e um fuso horário.
Propriedades | |
---|---|
text |
Tipo:
string Uma string que representa o valor do horário. O tempo é exibido no fuso horário da parada do transporte público. |
time_zone |
Tipo:
string O fuso horário em que a parada está localizada. O valor é o nome do fuso horário conforme definido no banco de dados de fusos horários da IANA, por exemplo, "America/New_York". |
value |
Tipo:
Date O horário da partida ou da chegada, especificado como um objeto Date do JavaScript. |
Constantes DirectionsTravelMode
Constantes
google.maps.DirectionsTravelMode
Constantes de DirectionsUnitSystem
Constantes
google.maps.DirectionsUnitSystem