Clase FleetEngineDeliveryVehicleLocationProvider
class
google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProvider
extends PollingLocationProvider, LocationProvider
library "journeySharing"
Proveedor de ubicación de vehículos de entrega
const {FleetEngineDeliveryVehicleLocationProvider} = await google.maps.importLibrary("journeySharing");
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:
stringEs 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 optionalDe manera opcional, permite que los usuarios muestren la ubicación del resultado de la tarea. |
shouldShowTasks |
Tipo:
boolean optionalDe manera opcional, permite que los usuarios muestren las tareas recuperadas. |
staleLocationThresholdMillis |
Tipo:
numberEste campo es de solo lectura. Es el umbral para la ubicación de un vehículo inactivo. Si la última ubicación actualizada del vehículo es anterior a este umbral, no se mostrará el vehículo. |
taskFilterOptions |
Devuelve las opciones de filtro que se aplicarán cuando se recuperen las tareas. |
Heredado:
isPolling,
pollingIntervalMillis
| |
Métodos | |
|---|---|
Heredado:
addListener
|
Eventos | |
|---|---|
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 FleetEngineDeliveryVehicleLocationProviderOptions
interfaz
google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderOptions
Son las opciones para el proveedor de ubicación del vehículo de entrega.
Propiedades | |
|---|---|
authTokenFetcher |
Tipo:
AuthTokenFetcherProporciona tokens web JSON para autenticar el cliente en Fleet Engine. |
projectId |
Tipo:
stringEs el ID del proyecto del consumidor de la consola de Google Cloud. |
activePolylineCustomization
opcional |
Tipo:
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optionalEs 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).
|
deliveryVehicleId
opcional |
Tipo:
string optionalEs el ID del vehículo de entrega del que se 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 inicia el seguimiento de ningún vehículo. Usa FleetEngineDeliveryVehicleLocationProvider.deliveryVehicleId para establecer el ID y comenzar el seguimiento. |
deliveryVehicleMarkerCustomization
opcional |
Tipo:
(function(DeliveryVehicleMarkerCustomizationFunctionParams): void)|Es la personalización que se aplica al marcador del vehículo de entrega. Usa este campo para especificar un estilo personalizado (como el ícono de marcador) y la interactividad (como el control de clics).
|
plannedStopMarkerCustomization
opcional |
Tipo:
(function(PlannedStopMarkerCustomizationFunctionParams): void)|Es la personalización que se aplica a un marcador de parada planificada. Usa este campo para especificar un estilo personalizado (como el ícono de marcador) y la interactividad (como el control de clics).
|
pollingIntervalMillis
opcional |
Tipo:
number optionalEs 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 |
Tipo:
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optionalSe 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).
|
shouldShowOutcomeLocations
opcional |
Tipo:
boolean optionalEs un valor booleano para mostrar o, bien, ocultar las ubicaciones de los resultados de las tareas recuperadas. |
shouldShowTasks
opcional |
Tipo:
boolean optionalEs un valor booleano para mostrar u ocultar tareas. Si se establece en falso, se evitará que se llame al extremo ListTasks para recuperar las tareas. Solo se mostrarán las próximas paradas del vehículo. |
staleLocationThresholdMillis
opcional |
Tipo:
number optionalEs el umbral para la ubicación de un vehículo inactivo. Si la última ubicación actualizada del vehículo es anterior a este umbral, no se mostrará el vehículo. El valor predeterminado es de 24 horas en milisegundos. Si el umbral es menor que 0 o Infinity, se ignorará el umbral y la ubicación del vehículo no se considerará inactiva. |
takenPolylineCustomization
opcional |
Tipo:
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optionalEs 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).
|
taskFilterOptions
opcional |
Tipo:
FleetEngineTaskFilterOptions optionalSon las opciones de filtro que se aplicarán cuando se recuperen las tareas. Las opciones pueden incluir un vehículo, una hora y un estado de la tarea específicos. |
taskMarkerCustomization
opcional |
Tipo:
(function(TaskMarkerCustomizationFunctionParams): void)|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 un estilo personalizado (como el ícono de marcador) y la interactividad (como el control de clics).
|
taskOutcomeMarkerCustomization
opcional |
Tipo:
function(TaskMarkerCustomizationFunctionParams): void optionalPersonalización aplicada a un marcador de resultado de 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 un estilo personalizado (como el ícono de marcador) y la interactividad (como el control de clics).
|
Interfaz FleetEngineTaskFilterOptions
interfaz
google.maps.journeySharing.FleetEngineTaskFilterOptions
Son las opciones de filtrado para las tareas en el proveedor de ubicación de vehículos de entrega.
Propiedades | |
|---|---|
completionTimeFrom
opcional |
Tipo:
Date optionalEs el límite inferior exclusivo para el tiempo de finalización de la tarea. Se usa para filtrar las tareas que se completaron después de la hora especificada. |
completionTimeTo
opcional |
Tipo:
Date optionalEs el límite superior exclusivo para la hora de finalización de la tarea. Se usa para filtrar las tareas que se completaron antes de la hora especificada. |
state
opcional |
Tipo:
string optionalEs el estado de la tarea. Los valores válidos son OPEN o CLOSED. |
Interfaz FleetEngineDeliveryVehicleLocationProviderUpdateEvent
interfaz
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
opcional |
Tipo:
Array<VehicleJourneySegment> optionalSon los tramos del viaje que completó este vehículo. No se puede modificar. |
deliveryVehicle
opcional |
Tipo:
DeliveryVehicle optionalEs la estructura de datos del vehículo de entrega que devuelve la actualización. No se puede modificar. |
tasks
opcional |
Es la lista de tareas que entrega este vehículo de entrega. No se puede modificar. |
Clase FleetEngineDeliveryFleetLocationProvider
class
google.maps.journeySharing.FleetEngineDeliveryFleetLocationProvider
extends PollingLocationProvider, LocationProvider
library "journeySharing"
Proveedor de ubicación de la flota de entrega
const {FleetEngineDeliveryFleetLocationProvider} = await google.maps.importLibrary("journeySharing");
Constructor | |
|---|---|
FleetEngineDeliveryFleetLocationProvider |
FleetEngineDeliveryFleetLocationProvider(options)Parámetros:
Crea un nuevo proveedor de ubicación para los vehículos a los que Fleet Engine hace un seguimiento. |
Propiedades | |
|---|---|
deliveryVehicleFilter |
Tipo:
string optionalEs el filtro que se aplica cuando se recuperan los vehículos de entrega. |
locationRestriction |
Tipo:
LatLngBounds|LatLngBoundsLiteral optionalSon los límites dentro de los cuales se deben seguir los vehículos de entrega. Si no se establecen límites, no se hará un seguimiento de los vehículos de entrega. Para hacer un seguimiento de todos los vehículos de entrega, independientemente de su ubicación, establece límites equivalentes a toda la Tierra. |
staleLocationThresholdMillis |
Tipo:
numberEste campo es de solo lectura. Es el umbral para la ubicación de un vehículo inactivo. Si la última ubicación actualizada del vehículo es anterior a este umbral, no se mostrará el vehículo. |
Heredado:
isPolling,
pollingIntervalMillis
| |
Métodos | |
|---|---|
Heredado:
addListener
|
Eventos | |
|---|---|
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 FleetEngineDeliveryFleetLocationProviderOptions
interfaz
google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderOptions
Opciones para el proveedor de ubicación de la flota de entrega.
Propiedades | |
|---|---|
authTokenFetcher |
Tipo:
AuthTokenFetcherProporciona tokens web JSON para autenticar el cliente en Fleet Engine. |
projectId |
Tipo:
stringEs el ID del proyecto del consumidor de la consola de Google Cloud. |
deliveryVehicleFilter
opcional |
Tipo:
string optionalEs 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
opcional |
Tipo:
function(DeliveryVehicleMarkerCustomizationFunctionParams): void optionalPersonalización aplicada a un marcador de vehículo de entrega. Usa este campo para especificar un estilo personalizado (como el ícono de marcador) y la interactividad (como el control de clics).
|
locationRestriction
opcional |
Tipo:
LatLngBounds|LatLngBoundsLiteral optionalSon los límites de latitud y longitud dentro de los cuales se deben seguir 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 toda la Tierra. |
staleLocationThresholdMillis
opcional |
Tipo:
number optionalEs el umbral para la ubicación de un vehículo inactivo. Si la última ubicación actualizada del vehículo es anterior a este umbral, no se mostrará el vehículo. El valor predeterminado es de 24 horas en milisegundos. Si el umbral es menor que cero o Infinity, se ignorará y la ubicación del vehículo no se considerará inactiva. |
Interfaz FleetEngineDeliveryFleetLocationProviderUpdateEvent
interfaz
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
opcional |
Tipo:
Array<DeliveryVehicle> optionalEs la lista de vehículos de entrega que devuelve la consulta. No se puede modificar. |