Trip and Order Progress

Classe FleetEngineTripLocationProvider

classe google.maps.journeySharing.FleetEngineTripLocationProvider estende PollingLocationProvider, LocationProvider
biblioteca "journeySharing"

Provedor de localização da viagem.

const {FleetEngineTripLocationProvider} = await google.maps.importLibrary("journeySharing");
FleetEngineTripLocationProvider
FleetEngineTripLocationProvider(options)
Parâmetros:
Cria um novo provedor de localização para uma viagem do Fleet Engine.
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION(params)
Parâmetros:
Valor de retorno: nenhum
Função de personalização de polilinha que colore a polilinha ativa de acordo com a leitura de velocidade. Especifique essa função como FleetEngineTripLocationProviderOptions.activePolylineCustomization para renderizar uma polilinha que considera o trânsito para a polilinha ativa.
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION(params)
Parâmetros:
Valor de retorno: nenhum
Função de personalização de polilinha que colore o restante da polilinha de acordo com a leitura de velocidade. Especifique essa função como FleetEngineTripLocationProviderOptions.remainingPolylineCustomization para renderizar uma polilinha que considera o trânsito para o restante da polilinha.
tripId
Tipo: string
O ID da viagem que este provedor de localização observa. Defina esse campo para começar o acompanhamento.
Herdado: isPolling, pollingIntervalMillis
refresh
refresh()
Parâmetros: nenhum
Valor de retorno: void
Atualiza explicitamente o local rastreado.
Herdado: addListener
error
function(event)
Argumentos:
Evento que é acionado quando o provedor de localização encontra um erro.
update
function(event)
Argumentos:
Evento acionado quando uma solicitação de atualização de dados do Fleet Engine é concluída.
Herdado: ispollingchange

Interface FleetEngineTripLocationProviderOptions

interface google.maps.journeySharing.FleetEngineTripLocationProviderOptions

Opções para o provedor de localização da viagem.

authTokenFetcher
Fornece JSON Web Tokens para autenticar o cliente no Fleet Engine.
projectId
Tipo: string
O ID do projeto do consumidor no console do Google Cloud.
activePolylineCustomization
opcional
Personalização aplicada à polilinha ativa. Uma polilinha ativa corresponde a uma parte do trajeto que o veículo está percorrendo no momento.

Use esse campo para especificar o estilo personalizado (como a cor da polilinha) e a interatividade (como o processamento de cliques).
  • Se um objeto PolylineOptions for especificado, as mudanças indicadas nele serão aplicadas à polilinha depois que ela for criada, substituindo as opções padrão, se houver.
  • Se uma função for especificada, ela será invocada uma vez quando a polilinha for criada. Nessa invocação, o parâmetro isNew no objeto de parâmetros da função é definido como true. Além disso, essa função é invocada quando as coordenadas da polilinha mudam ou quando o provedor de localização recebe dados do Fleet Engine, independentemente de os dados correspondentes a essa polilinha terem mudado.

    Consulte TripPolylineCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e os usos deles.
destinationMarkerCustomization
opcional
Tipo: (function(TripMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Personalização aplicada ao marcador de destino.

Use esse campo para especificar o estilo personalizado (como o ícone do marcador) e a interatividade (como o processamento de cliques).
  • Se um objeto MarkerOptions for especificado, as mudanças especificadas nele serão aplicadas ao marcador após a criação, substituindo as opções padrão, se houver.
  • Se uma função for especificada, ela será invocada uma vez quando o marcador for criado, antes de ser adicionado à visualização do mapa. Nessa invocação, o parâmetro isNew no objeto de parâmetros da função é definido como true. Além disso, essa função é invocada quando o provedor de localização recebe dados do Fleet Engine, independentemente de os dados correspondentes a esse marcador terem mudado ou não.

    Consulte TripMarkerCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e os usos deles.
originMarkerCustomization
opcional
Tipo: (function(TripMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Personalização aplicada ao marcador de origem.

Use esse campo para especificar o estilo personalizado (como o ícone do marcador) e a interatividade (como o processamento de cliques).
  • Se um objeto MarkerOptions for especificado, as mudanças especificadas nele serão aplicadas ao marcador após a criação, substituindo as opções padrão, se houver.
  • Se uma função for especificada, ela será invocada uma vez quando o marcador for criado, antes de ser adicionado à visualização do mapa. Nessa invocação, o parâmetro isNew no objeto de parâmetros da função é definido como true. Além disso, essa função é invocada quando o provedor de localização recebe dados do Fleet Engine, independentemente de os dados correspondentes a esse marcador terem mudado ou não.

    Consulte TripMarkerCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e os usos deles.
pollingIntervalMillis
opcional
Tipo: number optional
Tempo 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 desativa as atualizações de local recorrentes. Uma nova atualização do local é buscada se algum dos parâmetros observados pelo provedor de localização mudar.

O intervalo de sondagem padrão é de 5.000 milissegundos, que é o intervalo mínimo. Se você definir o intervalo de sondagem como um valor diferente de zero menor, 5000 será usado.
remainingPolylineCustomization
opcional
Personalização aplicada à polilinha restante. Uma polilinha restante corresponde a uma parte do trajeto que o veículo ainda não começou a percorrer.

Use esse campo para especificar o estilo personalizado (como a cor da polilinha) e a interatividade (como o processamento de cliques).
  • Se um objeto PolylineOptions for especificado, as mudanças indicadas nele serão aplicadas à polilinha depois que ela for criada, substituindo as opções padrão, se houver.
  • Se uma função for especificada, ela será invocada uma vez quando a polilinha for criada. Nessa invocação, o parâmetro isNew no objeto de parâmetros da função é definido como true. Além disso, essa função é invocada quando as coordenadas da polilinha mudam ou quando o provedor de localização recebe dados do Fleet Engine, independentemente de os dados correspondentes a essa polilinha terem mudado.

    Consulte TripPolylineCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e os usos deles.
takenPolylineCustomization
opcional
Personalização aplicada à polilinha percorrida. Uma polilinha percorrida corresponde a uma parte do trajeto que o veículo já percorreu.

Use esse campo para especificar o estilo personalizado (como a cor da polilinha) e a interatividade (como o processamento de cliques).
  • Se um objeto PolylineOptions for especificado, as mudanças indicadas nele serão aplicadas à polilinha depois que ela for criada, substituindo as opções padrão, se houver.
  • Se uma função for especificada, ela será invocada uma vez quando a polilinha for criada. Nessa invocação, o parâmetro isNew no objeto de parâmetros da função é definido como true. Além disso, essa função é invocada quando as coordenadas da polilinha mudam ou quando o provedor de localização recebe dados do Fleet Engine, independentemente de os dados correspondentes a essa polilinha terem mudado.

    Consulte TripPolylineCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e os usos deles.
tripId
opcional
Tipo: string optional
O ID da viagem a ser rastreado imediatamente após a instanciação do provedor de localização. Se não for especificado, o provedor de localização não vai começar a monitorar nenhuma viagem. Use FleetEngineTripLocationProvider.tripId para definir o ID e iniciar o monitoramento.
vehicleMarkerCustomization
opcional
Tipo: (function(TripMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Personalização aplicada ao marcador de veículo.

Use esse campo para especificar o estilo personalizado (como o ícone do marcador) e a interatividade (como o processamento de cliques).
  • Se um objeto MarkerOptions for especificado, as mudanças especificadas nele serão aplicadas ao marcador após a criação, substituindo as opções padrão, se houver.
  • Se uma função for especificada, ela será invocada uma vez quando o marcador for criado, antes de ser adicionado à visualização do mapa. Nessa invocação, o parâmetro isNew no objeto de parâmetros da função é definido como true. Além disso, essa função é invocada quando o provedor de localização recebe dados do Fleet Engine, independentemente de os dados correspondentes a esse marcador terem mudado ou não.

    Consulte TripMarkerCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e os usos deles.
waypointMarkerCustomization
opcional
Personalização aplicada a um marcador de waypoint.

Use esse campo para especificar o estilo personalizado (como o ícone do marcador) e a interatividade (como o processamento de cliques).
  • Se um objeto MarkerOptions for especificado, as mudanças especificadas nele serão aplicadas ao marcador após a criação, substituindo as opções padrão, se houver.
  • Se uma função for especificada, ela será invocada uma vez quando o marcador for criado, antes de ser adicionado à visualização do mapa. Nessa invocação, o parâmetro isNew no objeto de parâmetros da função é definido como true. Além disso, essa função é invocada quando o provedor de localização recebe dados do Fleet Engine, independentemente de os dados correspondentes a esse marcador terem mudado ou não.

    Consulte TripWaypointMarkerCustomizationFunctionParams para ver uma lista de parâmetros fornecidos e os usos deles.

Interface FleetEngineTripLocationProviderUpdateEvent

interface google.maps.journeySharing.FleetEngineTripLocationProviderUpdateEvent

O objeto de evento transmitido ao manipulador de eventos quando o evento FleetEngineTripLocationProvider.update é acionado.

trip
opcional
Tipo: Trip optional
A estrutura da viagem retornada pela atualização. Não modificável.