Classe JourneySharingMapView
Classe
google.maps.journeySharing.JourneySharingMapView
A visualização de mapa.
Acesse chamando const {JourneySharingMapView} = await google.maps.importLibrary("journeySharing")
. Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
---|---|
JourneySharingMapView |
JourneySharingMapView(options) Parâmetros:
Cria uma visualização de mapa. |
Propriedades | |
---|---|
automaticViewportMode |
Este campo é somente leitura. Modo de visualização automático. |
element |
Tipo:
Element Este campo é somente leitura. O elemento DOM que oferece suporte à visualização. |
enableTraffic |
Tipo:
boolean Ativa ou desativa a camada de tráfego. |
locationProviders |
Tipo:
Array<LocationProvider> optional Este campo é somente leitura. Origens dos locais rastreados que vão aparecer 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 do 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 de mapa. |
|
Tipo:
LocationProvider optional Este campo é somente leitura. Uma origem de locais rastreados que será mostrada na visualização do mapa de rastreamento. |
|
Tipo:
MarkerSetup Configura as opções de 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 o retornar 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 ou valores estáticos de MarkerSetup e não reutilize 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 as 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 o retornar 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 ou valores estáticos de MarkerSetup e não reutilize 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 as opções para um marcador de local de resultado de 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 o retornar 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 ou valores estáticos de MarkerSetup e não reutilize 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 as opções para um marcador de local de tarefa sem sucesso. É invocado sempre que um novo marcador de tarefa com falha é 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 o retornar 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 ou valores estáticos de MarkerSetup e não reutilize 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 as opções para um marcador de local do 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 o retornar 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 ou valores estáticos de MarkerSetup e não reutilize 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 as opções de um marcador de local de ponto de passagem. É invocado sempre que um novo marcador de ponto de passagem é 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 o retornar 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 ou valores estáticos de MarkerSetup e não reutilize 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 as opções de uma poligonal de rota antecipada. É invocado sempre que uma nova polilinha de trajeto esperado é 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 o retornar 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 ou valores estáticos do PolylineSetup e não reutilize o mesmo objeto google.maps.PolylineOptions para a chave polylineOptions em diferentes objetos PolylineSetupOptions. Se polylineOptions ou visible forem definidos como nulos ou não forem definidos, eles serão substituídos pelo padrão. Todos os valores definidos para polylineOptions.map ou polylineOptions.path serão ignorados. |
|
Tipo:
PolylineSetup Configura as opções de uma polilinha de rota percorrida. É 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 o retornar 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 ou valores estáticos do PolylineSetup e não reutilize 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 as opções de um marcador de local de pinging. É 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 o retornar 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 ou valores estáticos de MarkerSetup e não reutilize 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 as opções para um marcador de local de tarefa bem-sucedido. É invocado sempre que um novo marcador de tarefa bem-sucedida é 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 o retornar 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 ou valores estáticos de MarkerSetup e não reutilize 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 tarefas bem-sucedidas, se houver. |
|
Retorna os marcadores de resultado da tarefa, se houver. |
|
Retorna os marcadores de tarefas com falha, se houver. |
|
Retorna os marcadores de veículo, se houver. |
|
Retorna os marcadores de ponto de passagem, se houver. |
|
Retorna as polilinhas de rota esperadas, se houver. |
|
Retorna as polilinhas de rota tomadas, 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 do mapa.
Propriedades | |
---|---|
element |
Tipo:
Element O elemento DOM que oferece suporte à visualização. Obrigatório. |
|
Tipo:
PolylineSetup optional Configura as opções de uma poligonal de rota antecipada. É invocado sempre que uma nova polilinha de trajeto esperado é 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 o retornar 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 ou valores estáticos do PolylineSetup e não reutilize o mesmo objeto google.maps.PolylineOptions para a chave polylineOptions em diferentes objetos PolylineSetupOptions. Se polylineOptions ou visible forem definidos como nulos ou não forem definidos, 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 visualização automático. O valor padrão é FIT_ANTICIPATED_ROUTE, que permite que a visualização do mapa ajuste automaticamente a viewport para se ajustar aos marcadores de veículo, marcadores de local e quaisquer polilinhas de rota antecipadas visíveis. Defina como NENHUM para desativar o ajuste automático. |
|
Tipo:
MarkerSetup optional Configura as opções de 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 o retornar 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 ou valores estáticos de MarkerSetup e não reutilize 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 origem de locais rastreados que será mostrada na visualização do mapa de rastreamento. Opcional. |
locationProviders optional |
Tipo:
Array<LocationProvider> optional Origens dos locais rastreados que vão aparecer 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 as 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 o retornar 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 ou valores estáticos de MarkerSetup e não reutilize 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 as opções de um marcador de local de pinging. É 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 o retornar 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 ou valores estáticos de MarkerSetup e não reutilize 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 as opções para um marcador de local de tarefa bem-sucedido. É invocado sempre que um novo marcador de tarefa bem-sucedida é 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 o retornar 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 ou valores estáticos de MarkerSetup e não reutilize 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 as opções de uma polilinha de rota percorrida. É 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 o retornar 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 ou valores estáticos do PolylineSetup e não reutilize 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 as opções para um marcador de local de resultado de 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 o retornar 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 ou valores estáticos de MarkerSetup e não reutilize 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 as opções para um marcador de local de tarefa sem sucesso. É invocado sempre que um novo marcador de tarefa com falha é 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 o retornar 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 ou valores estáticos de MarkerSetup e não reutilize 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 as opções para um marcador de local do 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 o retornar 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 ou valores estáticos de MarkerSetup e não reutilize 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 as opções de um marcador de local de ponto de passagem. É invocado sempre que um novo marcador de ponto de passagem é 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 o retornar 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 ou valores estáticos de MarkerSetup e não reutilize 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
google.maps.journeySharing.AutomaticViewportMode
Modo de visualização automático.
Acesse chamando 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 marcadores e polilinhas de trajeto antecipadas visíveis. Esse é o padrão. |
NONE |
Não ajuste a janela de visualização automaticamente. |
Classe abstrata LocationProvider
Classe
abstrata google.maps.journeySharing.LocationProvider
Classe mãe de todos os provedores de local.
Métodos | |
---|---|
addListener |
addListener(eventName, handler) Parâmetros:
Valor de retorno:
MapsEventListener Adiciona um MapsEventListener para um evento acionado por esse 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 dos provedores de locais de votação.
Essa classe abstrata estende
LocationProvider
.
Propriedades | |
---|---|
isPolling |
Tipo:
boolean Verdadeiro se o provedor de local estiver pesquisando. Somente leitura. |
pollingIntervalMillis |
Tipo:
number Tempo mínimo entre a busca de atualizações de local em milissegundos. Se levar mais tempo que pollingIntervalMillis para buscar uma atualização de local, a próxima atualização não será iniciada até que a atual seja concluída. 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 do envio) ou uma opção de filtragem (por exemplo, limites de viewport ou filtros de atributo para provedores de local da frota) mudar. O intervalo de pesquisa padrão e mínimo é de 5.000 milissegundos. Se você definir o intervalo de pesquisa como um valor positivo menor, 5000 será armazenado e usado. |
Métodos | |
---|---|
Herdado:
addListener
|
Eventos | |
---|---|
ispollingchange |
function(event) Argumentos:
Evento acionado quando o estado de pesquisa do provedor de local é atualizado. Use PollingLocationProvider.isPolling para determinar o estado atual da pesquisa. |
Interface PollingLocationProviderIsPollingChangeEvent
Interface
google.maps.journeySharing.PollingLocationProviderIsPollingChangeEvent
O objeto de evento transmitido ao gerenciador 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 a mudança no estado foi causada por um erro. Desconhecido se a mudança de estado foi devido a operações normais. |