Shipment Tracking

Classe FleetEngineShipmentLocationProvider

Classe google.maps.journeySharing.FleetEngineShipmentLocationProvider

Fournisseur de localisation de la livraison.

Cette classe étend PollingLocationProvider.

Accédez-y en appelant le const {FleetEngineShipmentLocationProvider} = await google.maps.importLibrary("journeySharing").
 Consultez Bibliothèques de l'API Maps JavaScript.
FleetEngineShipmentLocationProvider
FleetEngineShipmentLocationProvider(options)
Paramètres :
Crée un fournisseur de localisation pour le suivi des expéditions Fleet Engine.
trackingId
Type : string
ID de suivi de la tâche observée par ce fournisseur de localisation. Définissez ce champ pour commencer le suivi.
Hérité : isPolling, pollingIntervalMillis
refresh
refresh()
Paramètres : aucun
Valeur renvoyée : void
Actualise explicitement la position suivie.
Hérité : addListener
error
function(event)
Arguments : 
Événement déclenché lorsque le fournisseur de localisation rencontre une erreur.
update
function(event)
Arguments : 
Événement déclenché lorsqu'une demande de mise à jour des données Fleet Engine est terminée.
Hérité : ispollingchange

Interface FleetEngineShipmentLocationProviderOptions

Interface google.maps.journeySharing.FleetEngineShipmentLocationProviderOptions

Options pour le fournisseur de localisation de l'envoi.
authTokenFetcher
Fournit des jetons Web JSON pour authentifier le client auprès de Fleet Engine.
projectId
Type : string
ID du projet du consommateur dans la console Google Cloud.
activePolylineCustomization optional
Personnalisation appliquée à la polyligne active. Une polyligne active correspond à une partie de l'itinéraire que le véhicule est en train de parcourir.

Utilisez ce champ pour spécifier un style personnalisé (comme la couleur de la polyligne) et l'interactivité (comme la gestion des clics).
  • Si un objet PolylineOptions est spécifié, les modifications qu'il contient sont appliquées à la polyligne après sa création, en écrasant ses options par défaut si elles existent.
  • Si une fonction est spécifiée, elle est appelée une fois lors de la création de la polyligne. (Lors de cet appel, le paramètre isNew dans l'objet des paramètres de la fonction est défini sur true.) De plus, cette fonction est appelée lorsque les coordonnées de la polyligne changent ou lorsque le fournisseur de localisation reçoit des données de Fleet Engine, que les données correspondant à cette polyligne aient changé ou non.

    Consultez ShipmentPolylineCustomizationFunctionParams pour obtenir la liste des paramètres fournis et de leurs utilisations.
deliveryVehicleMarkerCustomization optional
Type : (function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Personnalisation appliquée au repère du véhicule de livraison.

Ce champ vous permet de spécifier un style personnalisé (comme une icône de repère) et une interactivité (comme la gestion des clics).
  • Si un objet MarkerOptions est spécifié, les modifications qu'il contient sont appliquées au repère après sa création, en remplaçant ses options par défaut, le cas échéant.
  • Si une fonction est spécifiée, elle est appelée une fois lorsque le repère est créé, avant d'être ajouté à la vue de la carte. (Lors de cet appel, le paramètre isNew dans l'objet des paramètres de la fonction est défini sur true.) De plus, cette fonction est appelée lorsque le fournisseur de localisation reçoit des données de Fleet Engine, que les données correspondant à ce repère aient changé ou non.

    Consultez ShipmentMarkerCustomizationFunctionParams pour obtenir la liste des paramètres fournis et de leurs utilisations.
destinationMarkerCustomization optional
Type : (function(ShipmentMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Personnalisation appliquée au repère de destination.

Ce champ vous permet de spécifier un style personnalisé (comme une icône de repère) et une interactivité (comme la gestion des clics).
  • Si un objet MarkerOptions est spécifié, les modifications qu'il contient sont appliquées au repère après sa création, en remplaçant ses options par défaut, le cas échéant.
  • Si une fonction est spécifiée, elle est appelée une fois lorsque le repère est créé, avant d'être ajouté à la vue de la carte. (Lors de cet appel, le paramètre isNew dans l'objet des paramètres de la fonction est défini sur true.) De plus, cette fonction est appelée lorsque le fournisseur de localisation reçoit des données de Fleet Engine, que les données correspondant à ce repère aient changé ou non.

    Consultez ShipmentMarkerCustomizationFunctionParams pour obtenir la liste des paramètres fournis et de leurs utilisations.
pollingIntervalMillis optional
Type : number optional
Durée minimale entre les récupérations des mises à jour de position, en millisecondes. Si la récupération d'une mise à jour de la position prend plus de pollingIntervalMillis, la mise à jour suivante n'est pas lancée tant que la mise à jour en cours n'est pas terminée.

Si vous définissez cette valeur sur 0, sur l'infini ou sur une valeur négative, les mises à jour automatiques de la position sont désactivées. Une nouvelle mise à jour de la position est récupérée une fois si le paramètre d'ID de suivi (par exemple, l'ID de suivi de la livraison du fournisseur de position de la livraison) ou une option de filtrage (par exemple, les limites de la fenêtre d'affichage ou les filtres d'attributs pour les fournisseurs de position de la flotte) sont modifiés.

L'intervalle d'interrogation par défaut et minimal est de 5 000 millisecondes. Si vous définissez l'intervalle d'interrogation sur une valeur positive inférieure, la valeur 5000 est stockée et utilisée.
remainingPolylineCustomization optional
Personnalisation appliquée à la polyligne restante. Une polyligne restante correspond à une partie de l'itinéraire que le véhicule n'a pas encore empruntée.

Utilisez ce champ pour spécifier un style personnalisé (comme la couleur de la polyligne) et l'interactivité (comme la gestion des clics).
  • Si un objet PolylineOptions est spécifié, les modifications qu'il contient sont appliquées à la polyligne après sa création, en écrasant ses options par défaut si elles existent.
  • Si une fonction est spécifiée, elle est appelée une fois lors de la création de la polyligne. (Lors de cet appel, le paramètre isNew dans l'objet des paramètres de la fonction est défini sur true.) De plus, cette fonction est appelée lorsque les coordonnées de la polyligne changent ou lorsque le fournisseur de localisation reçoit des données de Fleet Engine, que les données correspondant à cette polyligne aient changé ou non.

    Consultez ShipmentPolylineCustomizationFunctionParams pour obtenir la liste des paramètres fournis et de leurs utilisations.
takenPolylineCustomization optional
Personnalisation appliquée à la polyligne tracée. Une polyligne empruntée correspond à une partie de l'itinéraire que le véhicule a déjà parcourue.

Utilisez ce champ pour spécifier un style personnalisé (comme la couleur de la polyligne) et l'interactivité (comme la gestion des clics).
  • Si un objet PolylineOptions est spécifié, les modifications qu'il contient sont appliquées à la polyligne après sa création, en écrasant ses options par défaut si elles existent.
  • Si une fonction est spécifiée, elle est appelée une fois lors de la création de la polyligne. (Lors de cet appel, le paramètre isNew dans l'objet des paramètres de la fonction est défini sur true.) De plus, cette fonction est appelée lorsque les coordonnées de la polyligne changent ou lorsque le fournisseur de localisation reçoit des données de Fleet Engine, que les données correspondant à cette polyligne aient changé ou non.

    Consultez ShipmentPolylineCustomizationFunctionParams pour obtenir la liste des paramètres fournis et de leurs utilisations.
trackingId optional
Type : string optional
ID de suivi de la tâche à suivre immédiatement après l'instanciation du fournisseur de localisation. Si aucune tâche n'est spécifiée, le fournisseur de localisation ne commence à suivre aucune tâche. Utilisez FleetEngineShipmentLocationProvider.trackingId pour définir l'ID de suivi et commencer le suivi.

Interface FleetEngineShipmentLocationProviderUpdateEvent

Interface google.maps.journeySharing.FleetEngineShipmentLocationProviderUpdateEvent

Objet d'événement transmis au gestionnaire d'événements lorsque l'événement FleetEngineShipmentLocationProvider.update est déclenché.
taskTrackingInfo optional
Type : TaskTrackingInfo optional
Structure des informations de suivi des tâches renvoyées par la mise à jour. Non modifiable.