Classe JourneySharingMapView
Classe
google.maps.journeySharing.JourneySharingMapView
A visualização de mapa.
Acesse ligando para const {JourneySharingMapView} = await google.maps.importLibrary("journeySharing")
.
Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
---|---|
JourneySharingMapView |
JourneySharingMapView(options) Parâmetros:
Instancia uma visualização de mapa. |
Propriedades | |
---|---|
automaticViewportMode |
Este campo é somente leitura. Modo de janela de visualização automática. |
element |
Tipo:
Element Este campo é somente leitura. O elemento DOM que apoia a visualização. |
enableTraffic |
Tipo:
boolean Ativa ou desativa a camada de trânsito. |
locationProviders |
Tipo:
Array<LocationProvider> optional Este campo é somente leitura. Fontes de locais rastreados a serem mostrados na visualização do mapa de rastreamento. Para adicionar ou remover provedores de local, use os métodos JourneySharingMapView.addLocationProvider e JourneySharingMapView.removeLocationProvider . |
map |
Tipo:
Map Este campo é somente leitura. O objeto de mapa contido na visualização do mapa. |
mapOptions |
Tipo:
MapOptions Este campo é somente leitura. As opções de mapa transmitidas para o mapa pela visualização. |
|
Tipo:
LocationProvider optional Este campo é somente leitura. Uma fonte de locais rastreados a serem mostrados na visualização do mapa de rastreamento. |
|
Tipo:
MarkerSetup Configura opções para um marcador de local de destino. Invocado sempre que um novo marcador de destino é renderizado. Se você especificar uma função, ela poderá e deverá modificar o campo defaultMarkerOptions da entrada, que contém um objeto google.maps.MarkerOptions, e retorná-lo como markerOptions no objeto MarkerSetupOptions de saída. Especificar um objeto MarkerSetupOptions tem o mesmo efeito que especificar uma função que retorna esse objeto estático. Não reutilize o mesmo objeto MarkerSetupOptions em diferentes funções MarkerSetup ou valores estáticos, nem o mesmo objeto google.maps.MarkerOptions para a chave markerOptions em diferentes objetos MarkerSetupOptions. Se "markerOptions" não estiver definido ou for nulo, ele será substituído pelo padrão. Qualquer valor definido para "markerOptions.map" ou "markerOptions.position" será ignorado. |
|
Tipo:
MarkerSetup Configura opções para um marcador de local de origem. Invocado sempre que um novo marcador de origem é renderizado. Se você especificar uma função, ela poderá e deverá modificar o campo defaultMarkerOptions da entrada, que contém um objeto google.maps.MarkerOptions, e retorná-lo como markerOptions no objeto MarkerSetupOptions de saída. Especificar um objeto MarkerSetupOptions tem o mesmo efeito que especificar uma função que retorna esse objeto estático. Não reutilize o mesmo objeto MarkerSetupOptions em diferentes funções MarkerSetup ou valores estáticos, nem o mesmo objeto google.maps.MarkerOptions para a chave markerOptions em diferentes objetos MarkerSetupOptions. Se "markerOptions" não estiver definido ou for nulo, ele será substituído pelo padrão. Qualquer valor definido para "markerOptions.map" ou "markerOptions.position" será ignorado. |
|
Tipo:
MarkerSetup Configura opções para um marcador de local do resultado de uma tarefa. Invocado sempre que um novo marcador de local de resultado de tarefa é renderizado. Se você especificar uma função, ela poderá e deverá modificar o campo defaultMarkerOptions da entrada, que contém um objeto google.maps.MarkerOptions, e retorná-lo como markerOptions no objeto MarkerSetupOptions de saída. Especificar um objeto MarkerSetupOptions tem o mesmo efeito que especificar uma função que retorna esse objeto estático. Não reutilize o mesmo objeto MarkerSetupOptions em diferentes funções MarkerSetup ou valores estáticos, nem o mesmo objeto google.maps.MarkerOptions para a chave markerOptions em diferentes objetos MarkerSetupOptions. Se "markerOptions" não estiver definido ou for nulo, ele será substituído pelo padrão. Qualquer valor definido para "markerOptions.map" ou "markerOptions.position" será ignorado. |
|
Tipo:
MarkerSetup Configura opções para um marcador de local de tarefa sem sucesso. Invocado sempre que um novo marcador de tarefa sem sucesso é renderizado. Se você especificar uma função, ela poderá e deverá modificar o campo defaultMarkerOptions da entrada, que contém um objeto google.maps.MarkerOptions, e retorná-lo como markerOptions no objeto MarkerSetupOptions de saída. Especificar um objeto MarkerSetupOptions tem o mesmo efeito que especificar uma função que retorna esse objeto estático. Não reutilize o mesmo objeto MarkerSetupOptions em diferentes funções MarkerSetup ou valores estáticos, nem o mesmo objeto google.maps.MarkerOptions para a chave markerOptions em diferentes objetos MarkerSetupOptions. Se "markerOptions" não estiver definido ou for nulo, ele será substituído pelo padrão. Qualquer valor definido para "markerOptions.map" ou "markerOptions.position" será ignorado. |
|
Tipo:
MarkerSetup Configura opções para um marcador de localização de veículo. Invocado sempre que um novo marcador de veículo é renderizado. Se você especificar uma função, ela poderá e deverá modificar o campo defaultMarkerOptions da entrada, que contém um objeto google.maps.MarkerOptions, e retorná-lo como markerOptions no objeto MarkerSetupOptions de saída. Especificar um objeto MarkerSetupOptions tem o mesmo efeito que especificar uma função que retorna esse objeto estático. Não reutilize o mesmo objeto MarkerSetupOptions em diferentes funções MarkerSetup ou valores estáticos, nem o mesmo objeto google.maps.MarkerOptions para a chave markerOptions em diferentes objetos MarkerSetupOptions. Se "markerOptions" não estiver definido ou for nulo, ele será substituído pelo padrão. Qualquer valor definido para "markerOptions.map" ou "markerOptions.position" será ignorado. |
|
Tipo:
MarkerSetup Configura opções para um marcador de local de ponto de referência. Invocado sempre que um novo marcador de ponto de referência é renderizado. Se você especificar uma função, ela poderá e deverá modificar o campo defaultMarkerOptions da entrada, que contém um objeto google.maps.MarkerOptions, e retorná-lo como markerOptions no objeto MarkerSetupOptions de saída. Especificar um objeto MarkerSetupOptions tem o mesmo efeito que especificar uma função que retorna esse objeto estático. Não reutilize o mesmo objeto MarkerSetupOptions em diferentes funções MarkerSetup ou valores estáticos, nem o mesmo objeto google.maps.MarkerOptions para a chave markerOptions em diferentes objetos MarkerSetupOptions. Se "markerOptions" não estiver definido ou for nulo, ele será substituído pelo padrão. Qualquer valor definido para "markerOptions.map" ou "markerOptions.position" será ignorado. |
|
Tipo:
PolylineSetup Configura opções para uma polilinha de rota prevista. Invocado sempre que uma nova polilinha de trajeto previsto é renderizada. Se você especificar uma função, ela poderá e deverá modificar o campo defaultPolylineOptions da entrada, que contém um objeto google.maps.PolylineOptions, e retorná-lo como polylineOptions no objeto PolylineSetupOptions de saída. Especificar um objeto PolylineSetupOptions tem o mesmo efeito que especificar uma função que retorna esse objeto estático. Não reutilize o mesmo objeto PolylineSetupOptions em diferentes funções PolylineSetup ou valores estáticos, nem o mesmo objeto google.maps.PolylineOptions para a chave polylineOptions em diferentes objetos PolylineSetupOptions. Se "polylineOptions" ou "visible" não estiverem definidos ou forem nulos, eles serão substituídos pelo padrão. Todos os valores definidos para polylineOptions.map ou polylineOptions.path serão ignorados. |
|
Tipo:
PolylineSetup Configura opções para uma polilinha de rota feita. Invocado sempre que uma nova polilinha de rota percorrida é renderizada. Se você especificar uma função, ela poderá e deverá modificar o campo defaultPolylineOptions da entrada, que contém um objeto google.maps.PolylineOptions, e retorná-lo como polylineOptions no objeto PolylineSetupOptions de saída. Especificar um objeto PolylineSetupOptions tem o mesmo efeito que especificar uma função que retorna esse objeto estático. Não reutilize o mesmo objeto PolylineSetupOptions em diferentes funções PolylineSetup ou valores estáticos, nem o mesmo objeto google.maps.PolylineOptions para a chave polylineOptions em diferentes objetos PolylineSetupOptions. Todos os valores definidos para polylineOptions.map ou polylineOptions.path serão ignorados. Qualquer valor não definido ou nulo será substituído pelo padrão. |
|
Tipo:
MarkerSetup Configura opções para um marcador de local de ping. Invocado sempre que um novo marcador de ping é renderizado. Se você especificar uma função, ela poderá e deverá modificar o campo defaultMarkerOptions da entrada, que contém um objeto google.maps.MarkerOptions, e retorná-lo como markerOptions no objeto MarkerSetupOptions de saída. Especificar um objeto MarkerSetupOptions tem o mesmo efeito que especificar uma função que retorna esse objeto estático. Não reutilize o mesmo objeto MarkerSetupOptions em diferentes funções MarkerSetup ou valores estáticos, nem o mesmo objeto google.maps.MarkerOptions para a chave markerOptions em diferentes objetos MarkerSetupOptions. Se "markerOptions" não estiver definido ou for nulo, ele será substituído pelo padrão. Qualquer valor definido para "markerOptions.map" ou "markerOptions.position" será ignorado. |
|
Tipo:
MarkerSetup Configura opções para um marcador de local de tarefa concluída. Invocado sempre que um novo marcador de tarefa concluída é renderizado. Se você especificar uma função, ela poderá e deverá modificar o campo defaultMarkerOptions da entrada, que contém um objeto google.maps.MarkerOptions, e retorná-lo como markerOptions no objeto MarkerSetupOptions de saída. Especificar um objeto MarkerSetupOptions tem o mesmo efeito que especificar uma função que retorna esse objeto estático. Não reutilize o mesmo objeto MarkerSetupOptions em diferentes funções MarkerSetup ou valores estáticos, nem o mesmo objeto google.maps.MarkerOptions para a chave markerOptions em diferentes objetos MarkerSetupOptions. Se "markerOptions" não estiver definido ou for nulo, ele será substituído pelo padrão. Qualquer valor definido para "markerOptions.map" ou "markerOptions.position" será ignorado. |
|
Retorna os marcadores de destino, se houver. |
|
Retorna os marcadores de origem, se houver. |
|
Retorna os marcadores de tarefa concluída, se houver. |
|
Retorna os marcadores de resultado da tarefa, se houver. |
|
Retorna os marcadores de tarefas sem sucesso, se houver. |
|
Retorna os marcadores de veículo, se houver. |
|
Retorna os marcadores de ponto de parada, se houver. |
|
Retorna as polilines de rota previstas, se houver. |
|
Retorna as polilinhas da rota percorrida, se houver. |
Métodos | |
---|---|
addLocationProvider |
addLocationProvider(locationProvider) Parâmetros:
Valor de retorno:nenhum
Adiciona um provedor de local à visualização do mapa. Se o provedor de local já tiver sido adicionado, nenhuma ação será realizada. |
removeLocationProvider |
removeLocationProvider(locationProvider) Parâmetros:
Valor de retorno:nenhum
Remove um provedor de local da visualização do mapa. Se o provedor de local ainda não tiver sido adicionado à visualização do mapa, nenhuma ação será realizada. |
Interface JourneySharingMapViewOptions
Interface google.maps.journeySharing.JourneySharingMapViewOptions
Opções para a visualização de mapa.
Propriedades | |
---|---|
element |
Tipo:
Element O elemento DOM que apoia a visualização. Obrigatório. |
|
Tipo:
PolylineSetup optional Configura opções para uma polilinha de rota prevista. Invocado sempre que uma nova polilinha de trajeto previsto é renderizada. Se você especificar uma função, ela poderá e deverá modificar o campo defaultPolylineOptions da entrada, que contém um objeto google.maps.PolylineOptions, e retorná-lo como polylineOptions no objeto PolylineSetupOptions de saída. Especificar um objeto PolylineSetupOptions tem o mesmo efeito que especificar uma função que retorna esse objeto estático. Não reutilize o mesmo objeto PolylineSetupOptions em diferentes funções PolylineSetup ou valores estáticos, nem o mesmo objeto google.maps.PolylineOptions para a chave polylineOptions em diferentes objetos PolylineSetupOptions. Se "polylineOptions" ou "visible" não estiverem definidos ou forem nulos, eles serão substituídos pelo padrão. Todos os valores definidos para polylineOptions.map ou polylineOptions.path serão ignorados. |
automaticViewportMode optional |
Tipo:
AutomaticViewportMode optional Modo de janela de visualização automática. O valor padrão é FIT_ANTICIPATED_ROUTE, que permite que a visualização do mapa ajuste automaticamente a janela de visualização para ajustar marcadores de veículos, marcadores de localização e polilinhas de rotas previstas visíveis. Defina como "NONE" para desativar o ajuste automático. |
|
Tipo:
MarkerSetup optional Configura opções para um marcador de local de destino. Invocado sempre que um novo marcador de destino é renderizado. Se você especificar uma função, ela poderá e deverá modificar o campo defaultMarkerOptions da entrada, que contém um objeto google.maps.MarkerOptions, e retorná-lo como markerOptions no objeto MarkerSetupOptions de saída. Especificar um objeto MarkerSetupOptions tem o mesmo efeito que especificar uma função que retorna esse objeto estático. Não reutilize o mesmo objeto MarkerSetupOptions em diferentes funções MarkerSetup ou valores estáticos, nem o mesmo objeto google.maps.MarkerOptions para a chave markerOptions em diferentes objetos MarkerSetupOptions. Se "markerOptions" não estiver definido ou for nulo, ele será substituído pelo padrão. Qualquer valor definido para "markerOptions.map" ou "markerOptions.position" será ignorado. |
|
Tipo:
LocationProvider optional Uma fonte de locais rastreados a serem mostrados na visualização do mapa de rastreamento. Opcional. |
locationProviders optional |
Tipo:
Array<LocationProvider> optional Fontes de locais rastreados a serem mostrados na visualização do mapa de rastreamento. Opcional. |
mapOptions optional |
Tipo:
MapOptions optional Opções de mapa transmitidas para o construtor google.maps.Map. |
|
Tipo:
MarkerSetup optional Configura opções para um marcador de local de origem. Invocado sempre que um novo marcador de origem é renderizado. Se você especificar uma função, ela poderá e deverá modificar o campo defaultMarkerOptions da entrada, que contém um objeto google.maps.MarkerOptions, e retorná-lo como markerOptions no objeto MarkerSetupOptions de saída. Especificar um objeto MarkerSetupOptions tem o mesmo efeito que especificar uma função que retorna esse objeto estático. Não reutilize o mesmo objeto MarkerSetupOptions em diferentes funções MarkerSetup ou valores estáticos, nem o mesmo objeto google.maps.MarkerOptions para a chave markerOptions em diferentes objetos MarkerSetupOptions. Se "markerOptions" não estiver definido ou for nulo, ele será substituído pelo padrão. Qualquer valor definido para "markerOptions.map" ou "markerOptions.position" será ignorado. |
|
Tipo:
MarkerSetup optional Configura opções para um marcador de local de ping. Invocado sempre que um novo marcador de ping é renderizado. Se você especificar uma função, ela poderá e deverá modificar o campo defaultMarkerOptions da entrada, que contém um objeto google.maps.MarkerOptions, e retorná-lo como markerOptions no objeto MarkerSetupOptions de saída. Especificar um objeto MarkerSetupOptions tem o mesmo efeito que especificar uma função que retorna esse objeto estático. Não reutilize o mesmo objeto MarkerSetupOptions em diferentes funções MarkerSetup ou valores estáticos, nem o mesmo objeto google.maps.MarkerOptions para a chave markerOptions em diferentes objetos MarkerSetupOptions. Se "markerOptions" não estiver definido ou for nulo, ele será substituído pelo padrão. Qualquer valor definido para "markerOptions.map" ou "markerOptions.position" será ignorado. |
|
Tipo:
MarkerSetup optional Configura opções para um marcador de local de tarefa concluída. Invocado sempre que um novo marcador de tarefa concluída é renderizado. Se você especificar uma função, ela poderá e deverá modificar o campo defaultMarkerOptions da entrada, que contém um objeto google.maps.MarkerOptions, e retorná-lo como markerOptions no objeto MarkerSetupOptions de saída. Especificar um objeto MarkerSetupOptions tem o mesmo efeito que especificar uma função que retorna esse objeto estático. Não reutilize o mesmo objeto MarkerSetupOptions em diferentes funções MarkerSetup ou valores estáticos, nem o mesmo objeto google.maps.MarkerOptions para a chave markerOptions em diferentes objetos MarkerSetupOptions. Se "markerOptions" não estiver definido ou for nulo, ele será substituído pelo padrão. Qualquer valor definido para "markerOptions.map" ou "markerOptions.position" será ignorado. |
|
Tipo:
PolylineSetup optional Configura opções para uma polilinha de rota feita. Invocado sempre que uma nova polilinha de rota percorrida é renderizada. Se você especificar uma função, ela poderá e deverá modificar o campo defaultPolylineOptions da entrada, que contém um objeto google.maps.PolylineOptions, e retorná-lo como polylineOptions no objeto PolylineSetupOptions de saída. Especificar um objeto PolylineSetupOptions tem o mesmo efeito que especificar uma função que retorna esse objeto estático. Não reutilize o mesmo objeto PolylineSetupOptions em diferentes funções PolylineSetup ou valores estáticos, nem o mesmo objeto google.maps.PolylineOptions para a chave polylineOptions em diferentes objetos PolylineSetupOptions. Todos os valores definidos para polylineOptions.map ou polylineOptions.path serão ignorados. Qualquer valor não definido ou nulo será substituído pelo padrão. |
|
Tipo:
MarkerSetup optional Configura opções para um marcador de local do resultado de uma tarefa. Invocado sempre que um novo marcador de local de resultado de tarefa é renderizado. Se você especificar uma função, ela poderá e deverá modificar o campo defaultMarkerOptions da entrada, que contém um objeto google.maps.MarkerOptions, e retorná-lo como markerOptions no objeto MarkerSetupOptions de saída. Especificar um objeto MarkerSetupOptions tem o mesmo efeito que especificar uma função que retorna esse objeto estático. Não reutilize o mesmo objeto MarkerSetupOptions em diferentes funções MarkerSetup ou valores estáticos, nem o mesmo objeto google.maps.MarkerOptions para a chave markerOptions em diferentes objetos MarkerSetupOptions. Se "markerOptions" não estiver definido ou for nulo, ele será substituído pelo padrão. Qualquer valor definido para "markerOptions.map" ou "markerOptions.position" será ignorado. |
|
Tipo:
MarkerSetup optional Configura opções para um marcador de local de tarefa sem sucesso. Invocado sempre que um novo marcador de tarefa sem sucesso é renderizado. Se você especificar uma função, ela poderá e deverá modificar o campo defaultMarkerOptions da entrada, que contém um objeto google.maps.MarkerOptions, e retorná-lo como markerOptions no objeto MarkerSetupOptions de saída. Especificar um objeto MarkerSetupOptions tem o mesmo efeito que especificar uma função que retorna esse objeto estático. Não reutilize o mesmo objeto MarkerSetupOptions em diferentes funções MarkerSetup ou valores estáticos, nem o mesmo objeto google.maps.MarkerOptions para a chave markerOptions em diferentes objetos MarkerSetupOptions. Se "markerOptions" não estiver definido ou for nulo, ele será substituído pelo padrão. Qualquer valor definido para "markerOptions.map" ou "markerOptions.position" será ignorado. |
|
Tipo:
MarkerSetup optional Configura opções para um marcador de localização de veículo. Invocado sempre que um novo marcador de veículo é renderizado. Se você especificar uma função, ela poderá e deverá modificar o campo defaultMarkerOptions da entrada, que contém um objeto google.maps.MarkerOptions, e retorná-lo como markerOptions no objeto MarkerSetupOptions de saída. Especificar um objeto MarkerSetupOptions tem o mesmo efeito que especificar uma função que retorna esse objeto estático. Não reutilize o mesmo objeto MarkerSetupOptions em diferentes funções MarkerSetup ou valores estáticos, nem o mesmo objeto google.maps.MarkerOptions para a chave markerOptions em diferentes objetos MarkerSetupOptions. Se "markerOptions" não estiver definido ou for nulo, ele será substituído pelo padrão. Qualquer valor definido para "markerOptions.map" ou "markerOptions.position" será ignorado. |
|
Tipo:
MarkerSetup optional Configura opções para um marcador de local de ponto de referência. Invocado sempre que um novo marcador de ponto de referência é renderizado. Se você especificar uma função, ela poderá e deverá modificar o campo defaultMarkerOptions da entrada, que contém um objeto google.maps.MarkerOptions, e retorná-lo como markerOptions no objeto MarkerSetupOptions de saída. Especificar um objeto MarkerSetupOptions tem o mesmo efeito que especificar uma função que retorna esse objeto estático. Não reutilize o mesmo objeto MarkerSetupOptions em diferentes funções MarkerSetup ou valores estáticos, nem o mesmo objeto google.maps.MarkerOptions para a chave markerOptions em diferentes objetos MarkerSetupOptions. Se "markerOptions" não estiver definido ou for nulo, ele será substituído pelo padrão. Qualquer valor definido para "markerOptions.map" ou "markerOptions.position" será ignorado. |
Constantes AutomaticViewportMode
Constantes de google.maps.journeySharing.AutomaticViewportMode
Modo de janela de visualização automática.
Acesse ligando para const {AutomaticViewportMode} = await google.maps.importLibrary("journeySharing")
.
Consulte Bibliotecas na API Maps JavaScript.
Constantes | |
---|---|
FIT_ANTICIPATED_ROUTE |
Ajusta automaticamente a janela de visualização para caber nos marcadores e em todas as polilinhas de rota previstas visíveis. Esse é o padrão. |
NONE |
Não ajustar automaticamente a janela de visualização. |
Classe abstrata LocationProvider
Classe abstrata
google.maps.journeySharing.LocationProvider
Classe mãe de todos os provedores de localização.
Métodos | |
---|---|
addListener |
addListener(eventName, handler) Parâmetros:
Valor de retorno:
MapsEventListener Adiciona um MapsEventListener para um evento disparado por este provedor de local. Retorna um identificador para esse listener que pode ser usado com event.removeListener . |
Classe abstrata PollingLocationProvider
Classe abstrata
google.maps.journeySharing.PollingLocationProvider
Classe mãe de provedores de locais de votação.
Essa classe abstrata estende
LocationProvider
.
Propriedades | |
---|---|
isPolling |
Tipo:
boolean Verdadeiro se este provedor de localização estiver fazendo polling. Somente leitura. |
pollingIntervalMillis |
Tipo:
number Tempo mínimo entre a busca de atualizações de localização em milissegundos. Se levar mais de pollingIntervalMillis para buscar uma atualização de local, a próxima atualização não será iniciada até que a atual termine. Definir esse valor como 0, Infinity ou um valor negativo desativa as atualizações automáticas de local. Uma nova atualização de local é buscada uma vez se o parâmetro de ID de rastreamento (por exemplo, o ID de rastreamento do envio do provedor de local de envio) ou uma opção de filtragem (por exemplo, limites da janela de visualização ou filtros de atributos para provedores de local da frota) mudar. O intervalo de sondagem padrão e mínimo é de 5.000 milissegundos. Se você definir o intervalo de pesquisa como um valor positivo menor, 5.000 será armazenado e usado. |
Métodos | |
---|---|
Herdado:
addListener
|
Eventos | |
---|---|
ispollingchange |
function(event) Argumentos:
Evento acionado quando o estado de pesquisa do provedor de localizações é atualizado. Use PollingLocationProvider.isPolling para determinar o estado atual da pesquisa. |
Interface PollingLocationProviderIsPollingChangeEvent
Interface google.maps.journeySharing.PollingLocationProviderIsPollingChangeEvent
O objeto de evento transmitido ao manipulador de eventos quando o evento PollingLocationProvider.ispollingchange
é acionado.
Propriedades | |
---|---|
error optional |
Tipo:
Error optional O erro que causou a mudança no estado da pesquisa, se ela foi causada por um erro. Indefinido se a mudança de estado ocorreu devido a operações normais. |