Trip and Order Progress

Clase FleetEngineTripLocationProvider

class google.maps.journeySharing.FleetEngineTripLocationProvider extends PollingLocationProvider, LocationProvider
library "journeySharing"

Proveedor de ubicación del viaje

const {FleetEngineTripLocationProvider} = await google.maps.importLibrary("journeySharing");
FleetEngineTripLocationProvider
FleetEngineTripLocationProvider(options)
Parámetros:
Crea un nuevo proveedor de ubicación para un viaje de Fleet Engine.
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION(params)
Parámetros:
Valor de retorno: Ninguno
Es la función de personalización de polilíneas que colorea la polilínea activa según su lectura de velocidad. Especifica esta función como FleetEngineTripLocationProviderOptions.activePolylineCustomization para renderizar una polilínea que tenga en cuenta el tráfico para la polilínea activa.
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION(params)
Parámetros:
Valor de retorno: Ninguno
Función de personalización de polilíneas que colorea la polilínea restante según su lectura de velocidad Especifica esta función como FleetEngineTripLocationProviderOptions.remainingPolylineCustomization para renderizar una polilínea que tenga en cuenta el tráfico para la polilínea restante.
tripId
Tipo: string
Es el ID del viaje que observa este proveedor de ubicación. Establece este campo para comenzar el seguimiento.
Heredado: isPolling, pollingIntervalMillis
refresh
refresh()
Parámetros: Ninguno
Valor de retorno: void
Actualiza de forma explícita la ubicación registrada.
Heredado: addListener
error
function(event)
Argumentos:
Es el evento que se activa cuando el proveedor de ubicación encuentra un error.
update
function(event)
Argumentos:
Es el evento que se activa cuando finaliza una solicitud de actualización de datos de Fleet Engine.
Heredado: ispollingchange

Interfaz FleetEngineTripLocationProviderOptions

interfaz google.maps.journeySharing.FleetEngineTripLocationProviderOptions

Son las opciones para el proveedor de ubicación del viaje.

authTokenFetcher
Proporciona tokens web JSON para autenticar el cliente en Fleet Engine.
projectId
Tipo: string
Es el ID del proyecto del consumidor de la consola de Google Cloud.
activePolylineCustomization
opcional
Es la personalización que se aplica a la polilínea activa. Una polilínea activa corresponde a una parte de la ruta que el vehículo está recorriendo en ese momento.

Usa este campo para especificar un estilo personalizado (como el color de la polilínea) y la interactividad (como el control de clics).
  • Si se especifica un objeto PolylineOptions, los cambios que se indiquen en él se aplicarán a la polilínea después de que se cree, lo que reemplazará sus opciones predeterminadas si existen.
  • Si se especifica una función, se invoca una vez cuando se crea la polilínea. (En esta invocación, el parámetro isNew del objeto de parámetros de la función se establece en true). Además, esta función se invoca cuando cambian las coordenadas de la polilínea o cuando el proveedor de ubicación recibe datos de Fleet Engine, independientemente de si cambiaron los datos correspondientes a esta polilínea.

    Consulta TripPolylineCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
destinationMarkerCustomization
opcional
Tipo: (function(TripMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Es la personalización que se aplica al marcador de destino.

Usa este campo para especificar un estilo personalizado (como el ícono de marcador) y la interactividad (como el control de clics).
  • Si se especifica un objeto MarkerOptions, los cambios que se indiquen en él se aplicarán al marcador después de que se haya creado, lo que reemplazará sus opciones predeterminadas si existen.
  • Si se especifica una función, se invoca una vez cuando se crea el marcador, antes de que se agregue a la vista de mapa. (En esta invocación, el parámetro isNew del objeto de parámetros de la función se establece en true). Además, esta función se invoca cuando el proveedor de ubicación recibe datos de Fleet Engine, independientemente de si cambiaron los datos correspondientes a este marcador.

    Consulta TripMarkerCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
originMarkerCustomization
opcional
Tipo: (function(TripMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Es la personalización que se aplica al marcador de origen.

Usa este campo para especificar un estilo personalizado (como el ícono de marcador) y la interactividad (como el control de clics).
  • Si se especifica un objeto MarkerOptions, los cambios que se indiquen en él se aplicarán al marcador después de que se haya creado, lo que reemplazará sus opciones predeterminadas si existen.
  • Si se especifica una función, se invoca una vez cuando se crea el marcador, antes de que se agregue a la vista de mapa. (En esta invocación, el parámetro isNew del objeto de parámetros de la función se establece en true). Además, esta función se invoca cuando el proveedor de ubicación recibe datos de Fleet Engine, independientemente de si cambiaron los datos correspondientes a este marcador.

    Consulta TripMarkerCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
pollingIntervalMillis
opcional
Tipo: number optional
Es el tiempo mínimo entre la recuperación de actualizaciones de ubicación, en milisegundos. Si se tarda más de pollingIntervalMillis en recuperar una actualización de ubicación, la siguiente actualización de ubicación no se iniciará hasta que finalice la actual.

Si estableces este valor en 0, se inhabilitarán las actualizaciones de ubicación recurrentes. Se recupera una nueva ubicación actualizada si cambia alguno de los parámetros que observa el proveedor de ubicación.

El intervalo de sondeo predeterminado es de 5,000 milisegundos, que es el intervalo mínimo. Si estableces el intervalo de sondeo en un valor más bajo que no sea cero, se usará 5000.
remainingPolylineCustomization
opcional
Se aplicó la personalización a la polilínea restante. Una polilínea restante corresponde a una parte de la ruta que el vehículo aún no comenzó a recorrer.

Usa este campo para especificar un estilo personalizado (como el color de la polilínea) y la interactividad (como el control de clics).
  • Si se especifica un objeto PolylineOptions, los cambios que se indiquen en él se aplicarán a la polilínea después de que se cree, lo que reemplazará sus opciones predeterminadas si existen.
  • Si se especifica una función, se invoca una vez cuando se crea la polilínea. (En esta invocación, el parámetro isNew del objeto de parámetros de la función se establece en true). Además, esta función se invoca cuando cambian las coordenadas de la polilínea o cuando el proveedor de ubicación recibe datos de Fleet Engine, independientemente de si cambiaron los datos correspondientes a esta polilínea.

    Consulta TripPolylineCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
takenPolylineCustomization
opcional
Es la personalización que se aplica a la polilínea tomada. Una polilínea tomada corresponde a una parte de la ruta que el vehículo ya recorrió.

Usa este campo para especificar un estilo personalizado (como el color de la polilínea) y la interactividad (como el control de clics).
  • Si se especifica un objeto PolylineOptions, los cambios que se indiquen en él se aplicarán a la polilínea después de que se cree, lo que reemplazará sus opciones predeterminadas si existen.
  • Si se especifica una función, se invoca una vez cuando se crea la polilínea. (En esta invocación, el parámetro isNew del objeto de parámetros de la función se establece en true). Además, esta función se invoca cuando cambian las coordenadas de la polilínea o cuando el proveedor de ubicación recibe datos de Fleet Engine, independientemente de si cambiaron los datos correspondientes a esta polilínea.

    Consulta TripPolylineCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
tripId
opcional
Tipo: string optional
Es el ID del viaje del que se debe hacer un seguimiento inmediatamente después de que se crea una instancia del proveedor de ubicación. Si no se especifica, el proveedor de ubicación no inicia el seguimiento de ningún viaje. Usa FleetEngineTripLocationProvider.tripId para establecer el ID y comenzar el seguimiento.
vehicleMarkerCustomization
opcional
Tipo: (function(TripMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Es la personalización que se aplica al marcador del vehículo.

Usa este campo para especificar un estilo personalizado (como el ícono de marcador) y la interactividad (como el control de clics).
  • Si se especifica un objeto MarkerOptions, los cambios que se indiquen en él se aplicarán al marcador después de que se haya creado, lo que reemplazará sus opciones predeterminadas si existen.
  • Si se especifica una función, se invoca una vez cuando se crea el marcador, antes de que se agregue a la vista de mapa. (En esta invocación, el parámetro isNew del objeto de parámetros de la función se establece en true). Además, esta función se invoca cuando el proveedor de ubicación recibe datos de Fleet Engine, independientemente de si cambiaron los datos correspondientes a este marcador.

    Consulta TripMarkerCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.
waypointMarkerCustomization
opcional
Personalización aplicada a un marcador de punto de referencia.

Usa este campo para especificar un estilo personalizado (como el ícono de marcador) y la interactividad (como el control de clics).
  • Si se especifica un objeto MarkerOptions, los cambios que se indiquen en él se aplicarán al marcador después de que se haya creado, lo que reemplazará sus opciones predeterminadas si existen.
  • Si se especifica una función, se invoca una vez cuando se crea el marcador, antes de que se agregue a la vista de mapa. (En esta invocación, el parámetro isNew del objeto de parámetros de la función se establece en true). Además, esta función se invoca cuando el proveedor de ubicación recibe datos de Fleet Engine, independientemente de si cambiaron los datos correspondientes a este marcador.

    Consulta TripWaypointMarkerCustomizationFunctionParams para obtener una lista de los parámetros proporcionados y sus usos.

Interfaz FleetEngineTripLocationProviderUpdateEvent

interfaz google.maps.journeySharing.FleetEngineTripLocationProviderUpdateEvent

Es el objeto de evento que se pasa al controlador de eventos cuando se activa el evento FleetEngineTripLocationProvider.update.

trip
opcional
Tipo: Trip optional
Es la estructura del viaje que devuelve la actualización. No se puede modificar.