Clase FleetEngineDeliveryVehicleLocationProvider
Clase google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProvider
Proveedor de ubicación del vehículo de entrega
Esta clase extiende PollingLocationProvider
.
Para acceder, llama a const {FleetEngineDeliveryVehicleLocationProvider} = await google.maps.importLibrary("journeySharing")
. Consulta Bibliotecas de la API de Maps JavaScript.
Constructor | |
---|---|
FleetEngineDeliveryVehicleLocationProvider |
FleetEngineDeliveryVehicleLocationProvider(options) Parámetros:
Crea un nuevo proveedor de ubicación para un vehículo de entrega de Fleet Engine. |
Propiedades | |
---|---|
deliveryVehicleId |
Tipo:
string Es el ID del vehículo que observa este proveedor de ubicación. Establece este campo para hacer un seguimiento de un vehículo. |
shouldShowOutcomeLocations |
Tipo:
boolean optional De forma opcional, permite que los usuarios muestren la ubicación del resultado de la tarea. |
shouldShowTasks |
Tipo:
boolean optional De manera opcional, permite que los usuarios muestren las tareas recuperadas. |
staleLocationThresholdMillis |
Tipo:
number Este campo es de solo lectura. Umbral para la ubicación inactiva del vehículo. Si la última ubicación actualizada del vehículo es anterior a este umbral, no se mostrará. |
taskFilterOptions |
Muestra las opciones de filtro que se deben aplicar cuando se recuperan tareas. |
Heredado:
isPolling ,
pollingIntervalMillis
|
Métodos | |
---|---|
Heredado:
addListener
|
Eventos | |
---|---|
error |
function(event) Argumentos:
Es un evento que se activa cuando el proveedor de ubicación encuentra un error. |
update |
function(event) Argumentos:
Es un evento que se activa cuando finaliza una solicitud de actualización de datos de Fleet Engine. |
Heredado:
ispollingchange
|
Interfaz FleetEngineDeliveryVehicleLocationProviderOptions
Interfaz de google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderOptions
Opciones para el proveedor de ubicación del vehículo de entrega.
Propiedades | |
---|---|
authTokenFetcher |
Tipo:
AuthTokenFetcher Proporciona tokens web JSON para autenticar el cliente en Fleet Engine. |
projectId |
Tipo:
string El ID del proyecto del consumidor de la consola de Google Cloud |
activePolylineCustomization optional |
Tipo:
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional Personalización aplicada a la polilínea activa. Una polilínea activa corresponde a una parte de la ruta por la que el vehículo está circulando en ese momento. Usa este campo para especificar el diseño personalizado (como el color del polilínea) y la interactividad (como el manejo de clics).
|
deliveryVehicleId optional |
Tipo:
string optional Es el ID del vehículo de entrega al que se le hará un seguimiento inmediatamente después de que se cree una instancia del proveedor de ubicación. Si no se especifica, el proveedor de ubicación no comenzará a hacer un seguimiento de ningún vehículo. Usa FleetEngineDeliveryVehicleLocationProvider.deliveryVehicleId para establecer el ID y comenzar el seguimiento. |
deliveryVehicleMarkerCustomization optional |
Tipo:
(function(DeliveryVehicleMarkerCustomizationFunctionParams): void)|MarkerOptions optional Personalización aplicada al marcador de vehículo de entrega. Usa este campo para especificar estilos personalizados (como el ícono de marcador) y la interactividad (como el manejo de clics).
|
plannedStopMarkerCustomization optional |
Tipo:
(function(PlannedStopMarkerCustomizationFunctionParams): void)|MarkerOptions optional Personalización aplicada a un marcador de parada planificada. Usa este campo para especificar estilos personalizados (como el ícono de marcador) y la interactividad (como el manejo de clics).
|
pollingIntervalMillis optional |
Tipo:
number optional Es el tiempo mínimo entre la recuperación de actualizaciones de ubicación en milisegundos. Si tarda más de pollingIntervalMillis en recuperar una actualización de ubicación, la siguiente actualización de ubicación no se inicia hasta que finaliza la actual. Si estableces este valor en 0, se inhabilitan las actualizaciones de ubicación recurrentes. Se recupera una nueva actualización de ubicación si cambia alguno de los parámetros que observa el proveedor de ubicación. El intervalo de sondeo predeterminado es de 5,000 milisegundos, el intervalo mínimo. Si estableces el intervalo de sondeo en un valor inferior a cero, se usará 5000. |
remainingPolylineCustomization optional |
Tipo:
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional Personalización aplicada a la polilínea restante. Una polilínea restante corresponde a una parte de la ruta por la que el vehículo aún no comenzó a circular. Usa este campo para especificar el diseño personalizado (como el color del polilínea) y la interactividad (como el manejo de clics).
|
shouldShowOutcomeLocations optional |
Tipo:
boolean optional Es un valor booleano para mostrar o ocultar las ubicaciones de resultados de las tareas recuperadas. |
shouldShowTasks optional |
Tipo:
boolean optional Es un valor booleano para ocultar o mostrar tareas. Si estableces este valor en "false", se evitará que se llame al extremo ListTasks para recuperar las tareas. Solo se mostrarán las próximas paradas del vehículo. |
staleLocationThresholdMillis optional |
Tipo:
number optional Umbral para la ubicación inactiva del vehículo. Si la última ubicación actualizada del vehículo es anterior a este umbral, no se mostrará. El valor predeterminado es de 24 horas en milisegundos. Si el umbral es inferior a 0 o Infinito, se ignorará y la ubicación del vehículo no se considerará inactiva. |
takenPolylineCustomization optional |
Tipo:
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional Personalización aplicada a la polilínea tomada. Una polilínea recorrida corresponde a una parte de la ruta que el vehículo ya recorrió. Usa este campo para especificar el diseño personalizado (como el color del polilínea) y la interactividad (como el manejo de clics).
|
taskFilterOptions optional |
Tipo:
FleetEngineTaskFilterOptions optional Son las opciones de filtro que se aplican cuando se recuperan tareas. Las opciones pueden incluir el estado específico del vehículo, la hora y la tarea. |
taskMarkerCustomization optional |
Tipo:
(function(TaskMarkerCustomizationFunctionParams): void)|MarkerOptions optional Personalización aplicada a un marcador de tarea. Se renderiza un marcador de tarea en la ubicación planificada de cada tarea asignada al vehículo de entrega. Usa este campo para especificar estilos personalizados (como el ícono de marcador) y la interactividad (como el manejo de clics).
|
taskOutcomeMarkerCustomization optional |
Tipo:
function(TaskMarkerCustomizationFunctionParams): void optional Personalización aplicada a un marcador de resultado de la tarea. Se renderiza un marcador de resultado de la tarea en la ubicación real del resultado de cada tarea asignada al vehículo de entrega. Usa este campo para especificar estilos personalizados (como el ícono de marcador) y la interactividad (como el manejo de clics).
|
FleetEngineTaskFilterOptions
Interfaz de google.maps.journeySharing.FleetEngineTaskFilterOptions
Opciones de filtrado para las tareas en el proveedor de ubicación de vehículos de reparto
Propiedades | |
---|---|
completionTimeFrom optional |
Tipo:
Date optional Límite inferior exclusivo para la hora de finalización de la tarea. Se usa para filtrar las tareas que se completaron después de la hora especificada. |
completionTimeTo optional |
Tipo:
Date optional Es el límite superior exclusivo para el tiempo de finalización de la tarea. Se usa para filtrar tareas que se completaron antes de la hora especificada. |
state optional |
Tipo:
string optional Es el estado de la tarea. Los valores válidos son OPEN o CLOSED. |
FleetEngineDeliveryVehicleLocationProviderUpdateEvent
Interfaz de google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderUpdateEvent
Es el objeto de evento que se pasa al controlador de eventos cuando se activa el evento FleetEngineDeliveryVehicleLocationProvider.update
.
Propiedades | |
---|---|
completedVehicleJourneySegments optional |
Tipo:
Array<VehicleJourneySegment> optional Los segmentos de viaje que completó este vehículo. No se puede modificar. |
deliveryVehicle optional |
Tipo:
DeliveryVehicle optional Es la estructura de datos del vehículo de entrega que muestra la actualización. No se puede modificar. |
tasks optional |
Es la lista de tareas que entrega este vehículo de entrega. No se puede modificar. |
Clase FleetEngineDeliveryFleetLocationProvider
Clase google.maps.journeySharing.FleetEngineDeliveryFleetLocationProvider
Proveedor de ubicación de la flota de entrega.
Esta clase extiende PollingLocationProvider
.
Para acceder, llama a const {FleetEngineDeliveryFleetLocationProvider} = await google.maps.importLibrary("journeySharing")
. Consulta Bibliotecas de la API de Maps JavaScript.
Constructor | |
---|---|
FleetEngineDeliveryFleetLocationProvider |
FleetEngineDeliveryFleetLocationProvider(options) Parámetros:
Crea un nuevo proveedor de ubicación para los vehículos a los que se les hace un seguimiento con el motor de flota. |
Propiedades | |
---|---|
deliveryVehicleFilter |
Tipo:
string optional Es el filtro que se aplica cuando se recuperan los vehículos de entrega. |
locationRestriction |
Tipo:
LatLngBounds|LatLngBoundsLiteral optional Son los límites dentro de los cuales se realiza el seguimiento de los vehículos de entrega. Si no se establecen límites, no se hará un seguimiento de ningún vehículo de entrega. Para hacer un seguimiento de todos los vehículos de entrega, independientemente de su ubicación, establece límites equivalentes a todo el planeta. |
staleLocationThresholdMillis |
Tipo:
number Este campo es de solo lectura. Umbral para la ubicación inactiva del vehículo. Si la última ubicación actualizada del vehículo es anterior a este umbral, no se mostrará. |
Heredado:
isPolling ,
pollingIntervalMillis
|
Métodos | |
---|---|
Heredado:
addListener
|
Eventos | |
---|---|
update |
function(event) Argumentos:
Es un evento que se activa cuando finaliza una solicitud de actualización de datos de Fleet Engine. |
Heredado:
ispollingchange
|
Interfaz FleetEngineDeliveryFleetLocationProviderOptions
Interfaz de google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderOptions
Opciones para el proveedor de ubicación de la flota de entrega.
Propiedades | |
---|---|
authTokenFetcher |
Tipo:
AuthTokenFetcher Proporciona tokens web JSON para autenticar el cliente en Fleet Engine. |
projectId |
Tipo:
string El ID del proyecto del consumidor de la consola de Google Cloud |
deliveryVehicleFilter optional |
Tipo:
string optional Es una consulta de filtro que se aplica cuando se recuperan los vehículos de entrega. Este filtro se pasa directamente a Fleet Engine. Consulta ListDeliveryVehiclesRequest.filter para conocer los formatos admitidos. Ten en cuenta que los filtros válidos para los atributos deben tener el prefijo "attributes". Por ejemplo, attributes.x = "y" o attributes."x y" = "z" . |
deliveryVehicleMarkerCustomization optional |
Tipo:
function(DeliveryVehicleMarkerCustomizationFunctionParams): void optional Personalización aplicada a un marcador de vehículo de entrega. Usa este campo para especificar estilos personalizados (como el ícono de marcador) y la interactividad (como el manejo de clics).
|
locationRestriction optional |
Tipo:
LatLngBounds|LatLngBoundsLiteral optional Son los límites de latitud y longitud dentro de los cuales se debe hacer un seguimiento de los vehículos inmediatamente después de que se crea una instancia del proveedor de ubicación. Si no se establece, el proveedor de ubicación no comenzará a hacer un seguimiento de ningún vehículo. Usa FleetEngineDeliveryFleetLocationProvider.locationRestriction para establecer los límites y comenzar el seguimiento. Para hacer un seguimiento de todos los vehículos de entrega, independientemente de su ubicación, establece límites equivalentes a todo el planeta. |
staleLocationThresholdMillis optional |
Tipo:
number optional Umbral para la ubicación inactiva del vehículo. Si la última ubicación actualizada del vehículo es anterior a este umbral, no se mostrará. El valor predeterminado es de 24 horas en milisegundos. Si el umbral es inferior a cero o Infinity, se ignorará y la ubicación del vehículo no se considerará inactiva. |
FleetEngineDeliveryFleetLocationProviderUpdateEvent
Interfaz de google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderUpdateEvent
Es el objeto de evento que se pasa al controlador de eventos cuando se activa el evento FleetEngineDeliveryFleetLocationProvider.update
.
Propiedades | |
---|---|
deliveryVehicles optional |
Tipo:
Array<DeliveryVehicle> optional Es la lista de vehículos de entrega que muestra la consulta. No se puede modificar. |