Classe JourneySharingMapView
google.maps.journeySharing.JourneySharingMapView
classe
biblioteca "journeySharing"
A visualização de mapa.
const {JourneySharingMapView} = await google.maps.importLibrary("journeySharing");
Construtor | |
|---|---|
JourneySharingMapView |
JourneySharingMapView(options)Parâmetros:
Instancia uma visualização de mapa. |
Propriedades | |
|---|---|
automaticViewportMode |
Tipo:
AutomaticViewportModeEste campo é somente leitura. Modo de janela de visualização automática. |
element |
Tipo:
ElementEste campo é somente leitura. O elemento DOM que apoia a visualização. |
enableTraffic |
Tipo:
booleanAtiva ou desativa a camada de trânsito. |
locationProviders |
Tipo:
Array<LocationProvider> optionalEste campo é somente leitura. Fontes de locais rastreados que serão mostradas na visualização do mapa de rastreamento. Para adicionar ou remover provedores de localização, use os métodos JourneySharingMapView.addLocationProvider e JourneySharingMapView.removeLocationProvider. |
map |
Tipo:
MapEste campo é somente leitura. O objeto de mapa contido na visualização de mapa. |
mapOptions |
Tipo:
MapOptionsEste campo é somente leitura. As opções de mapa transmitidas ao mapa pela visualização de mapa. |
|
Tipo:
LocationProvider optionalEste campo é somente leitura. Uma fonte de locais rastreados para mostrar na visualização do mapa de rastreamento. |
|
Tipo:
MarkerSetupConfigura 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 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 ou valores estáticos de MarkerSetup, 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:
MarkerSetupConfigura as opções de 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 ou valores estáticos de MarkerSetup, 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:
MarkerSetupConfigura 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 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 ou valores estáticos de MarkerSetup, 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:
MarkerSetupConfigura as opções para um marcador de local de tarefa sem sucesso. Invocado sempre que um novo marcador de tarefa malsucedida é 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 ou valores estáticos de MarkerSetup, 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:
MarkerSetupConfigura as opções de um marcador de localização 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 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 ou valores estáticos de MarkerSetup, 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:
MarkerSetupConfigura as opções de um marcador de local de waypoint. Invocado sempre que um novo marcador de waypoint é 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 ou valores estáticos de MarkerSetup, 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:
PolylineSetupConfigura as opções de uma polilinha de trajeto antecipado. Invocado sempre que uma nova polilinha de trajeto antecipado é 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 ou valores estáticos de PolylineSetup, nem o mesmo objeto google.maps.PolylineOptions para a chave polylineOptions em diferentes objetos PolylineSetupOptions. Se polylineOptions ou visible não estiver definido ou for nulo, ele será substituído pelo padrão. Todos os valores definidos para polylineOptions.map ou polylineOptions.path serão ignorados. |
|
Tipo:
PolylineSetupConfigura as opções de uma polilinha de trajeto percorrido. Invocado sempre que uma nova polilinha de trajeto percorrido é 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 ou valores estáticos de PolylineSetup, 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:
MarkerSetupConfigura as opções de 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 ou valores estáticos de MarkerSetup, 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:
MarkerSetupConfigura as opções para um marcador de local de tarefa bem-sucedida. 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 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 ou valores estáticos de MarkerSetup, 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 tarefas bem-sucedidas, se houver. |
|
Retorna os marcadores de resultado da tarefa, se houver. |
|
Retorna os marcadores de tarefas malsucedidas, se houver. |
|
Retorna os marcadores de veículo, se houver. |
|
Retorna os marcadores de waypoint, se houver. |
|
Retorna as polilinhas de trajeto previstas, se houver. |
|
Retorna as polilinhas do trajeto percorrido, se houver. |
Métodos | |
|---|---|
addLocationProvider |
addLocationProvider(locationProvider)Parâmetros:
Valor de retorno: nenhum
Adiciona um provedor de localização à visualização do mapa. Se o provedor de localização já tiver sido adicionado, nenhuma ação será realizada. |
removeLocationProvider |
removeLocationProvider(locationProvider)Parâmetros:
Valor de retorno: nenhum
Remove um provedor de localização da visualização do mapa. Se o provedor de localização 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:
ElementO elemento DOM que apoia a visualização. Obrigatório. |
opcional |
Tipo:
PolylineSetup optionalConfigura as opções de uma polilinha de trajeto antecipado. Invocado sempre que uma nova polilinha de trajeto antecipado é 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 ou valores estáticos de PolylineSetup, nem o mesmo objeto google.maps.PolylineOptions para a chave polylineOptions em diferentes objetos PolylineSetupOptions. Se polylineOptions ou visible não estiver definido ou for nulo, ele será substituído pelo padrão. Todos os valores definidos para polylineOptions.map ou polylineOptions.path serão ignorados. |
automaticViewportMode
opcional |
Tipo:
AutomaticViewportMode optionalModo 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 incluir marcadores de veículos, marcadores de local e todas as polilinhas de trajeto previsto visíveis. Defina como NONE para desativar o ajuste automático. |
opcional |
Tipo:
MarkerSetup optionalConfigura 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 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 ou valores estáticos de MarkerSetup, 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. |
opcional |
Tipo:
LocationProvider optionalUma fonte de locais rastreados para mostrar na visualização do mapa de rastreamento. Opcional. |
locationProviders
opcional |
Tipo:
Array<LocationProvider> optionalFontes de locais rastreados que serão mostradas na visualização do mapa de rastreamento. Opcional. |
mapOptions
opcional |
Tipo:
MapOptions optionalOpções de mapa transmitidas para o construtor google.maps.Map. |
opcional |
Tipo:
MarkerSetup optionalConfigura as opções de 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 ou valores estáticos de MarkerSetup, 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. |
opcional |
Tipo:
MarkerSetup optionalConfigura as opções de 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 ou valores estáticos de MarkerSetup, 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. |
opcional |
Tipo:
MarkerSetup optionalConfigura as opções para um marcador de local de tarefa bem-sucedida. 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 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 ou valores estáticos de MarkerSetup, 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. |
opcional |
Tipo:
PolylineSetup optionalConfigura as opções de uma polilinha de trajeto percorrido. Invocado sempre que uma nova polilinha de trajeto percorrido é 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 ou valores estáticos de PolylineSetup, 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. |
opcional |
Tipo:
MarkerSetup optionalConfigura 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 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 ou valores estáticos de MarkerSetup, 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. |
opcional |
Tipo:
MarkerSetup optionalConfigura as opções para um marcador de local de tarefa sem sucesso. Invocado sempre que um novo marcador de tarefa malsucedida é 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 ou valores estáticos de MarkerSetup, 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. |
opcional |
Tipo:
MarkerSetup optionalConfigura as opções de um marcador de localização 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 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 ou valores estáticos de MarkerSetup, 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. |
opcional |
Tipo:
MarkerSetup optionalConfigura as opções de um marcador de local de waypoint. 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 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 ou valores estáticos de MarkerSetup, 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
google.maps.journeySharing.AutomaticViewportMode
biblioteca de constantes
"journeySharing"
Modo de janela de visualização automática.
Essas constantes também podem ser usadas como strings. No TypeScript, os literais de string são definidos pelo tipo AutomaticViewportModeString.
const {AutomaticViewportMode} = await google.maps.importLibrary("journeySharing");
Constantes | |
|---|---|
FIT_ANTICIPATED_ROUTE |
Ajuste automaticamente a janela de visualização para que os marcadores e as polilinhas de trajeto previstas fiquem 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:
MapsEventListenerAdiciona um MapsEventListener para um evento acionado por esse provedor de localização. Retorna um identificador para esse listener que pode ser usado com event.removeListener. |
Classe abstrata PollingLocationProvider
google.maps.journeySharing.PollingLocationProvider
abstract class
extends LocationProvider
Classe pai dos provedores de locais de votação.
Propriedades | |
|---|---|
isPolling |
Tipo:
booleanVerdadeiro se o provedor de localização estiver fazendo uma sondagem. Somente leitura. |
pollingIntervalMillis |
Tipo:
numberTempo mínimo entre as atualizações do local em milissegundos. Se levar mais de pollingIntervalMillis para buscar uma atualização de local, a próxima não será iniciada até que a atual seja concluída. Definir esse valor como 0, infinito ou um valor negativo desativa as atualizações automáticas de local. Uma nova atualização do local é buscada uma vez se o parâmetro do ID de rastreamento (por exemplo, o ID de rastreamento de remessa do provedor de localização de remessa) ou uma opção de filtragem (por exemplo, limites de janela de visualização ou filtros de atributos para provedores de localização de frota) mudar. O intervalo de sondagem padrão e mínimo é de 5.000 milissegundos. Se você definir o intervalo de sondagem 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 sondagem do provedor de localização é atualizado. Use PollingLocationProvider.isPolling para determinar o estado de sondagem atual. |
Interface PollingLocationProviderIsPollingChangeEvent
Interface
google.maps.journeySharing.PollingLocationProviderIsPollingChangeEvent
O objeto de evento transmitido ao manipulador de eventos quando o evento PollingLocationProvider.ispollingchange é acionado.
Propriedades | |
|---|---|
error
opcional |
Tipo:
Error optionalO erro que causou a mudança do estado de sondagem, se a mudança foi causada por um erro. Indefinido se a mudança de estado foi devido a operações normais. |