Trip and Order Progress

FleetEngineTripLocationProvider class

Classe google.maps.journeySharing.FleetEngineTripLocationProvider

Fournisseur de localisation du trajet.

Cette classe étend PollingLocationProvider.

Accédez-y en appelant le const {FleetEngineTripLocationProvider} = await google.maps.importLibrary("journeySharing").
 Consultez Bibliothèques de l'API Maps JavaScript.
FleetEngineTripLocationProvider
FleetEngineTripLocationProvider(options)
Paramètres :
Crée un fournisseur de localisation pour un trajet Fleet Engine.
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION(params)
Paramètres :
Valeur renvoyée : aucune
Fonction de personnalisation des polylignes qui colore la polyligne active en fonction de sa vitesse de lecture. Spécifiez cette fonction comme FleetEngineTripLocationProviderOptions.activePolylineCustomization pour afficher une polyligne tenant compte du trafic pour la polyligne active.
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION(params)
Paramètres :
Valeur renvoyée : aucune
Fonction de personnalisation des polylignes qui colore la polyligne restante en fonction de la vitesse de lecture. Spécifiez cette fonction comme FleetEngineTripLocationProviderOptions.remainingPolylineCustomization pour afficher une polyligne tenant compte du trafic pour la polyligne restante.
tripId
Type : string
ID du trajet que ce fournisseur de localisation observe. 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 FleetEngineTripLocationProviderOptions

Interface google.maps.journeySharing.FleetEngineTripLocationProviderOptions

Options pour le fournisseur de localisation du trajet.
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
Type : (function(TripPolylineCustomizationFunctionParams): void)|PolylineOptions 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 TripPolylineCustomizationFunctionParams pour obtenir la liste des paramètres fournis et de leurs utilisations.
destinationMarkerCustomization optional
Type : (function(TripMarkerCustomizationFunctionParams): 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 TripMarkerCustomizationFunctionParams pour obtenir la liste des paramètres fournis et de leurs utilisations.
originMarkerCustomization optional
Type : (function(TripMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Personnalisation appliquée au repère d'origine.

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 TripMarkerCustomizationFunctionParams 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.

Définir cette valeur sur 0 désactive les mises à jour récurrentes de la position. Une nouvelle mise à jour de la position est récupérée si l'un des paramètres observés par le fournisseur de localisation change.

L'intervalle d'interrogation par défaut est de 5 000 millisecondes, soit l'intervalle minimal. Si vous définissez l'intervalle d'interrogation sur une valeur non nulle inférieure, 5 000 est utilisé.
remainingPolylineCustomization optional
Type : (function(TripPolylineCustomizationFunctionParams): void)|PolylineOptions 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 TripPolylineCustomizationFunctionParams pour obtenir la liste des paramètres fournis et de leurs utilisations.
takenPolylineCustomization optional
Type : (function(TripPolylineCustomizationFunctionParams): void)|PolylineOptions 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 TripPolylineCustomizationFunctionParams pour obtenir la liste des paramètres fournis et de leurs utilisations.
tripId optional
Type : string optional
ID du trajet à suivre immédiatement après l'instanciation du fournisseur de localisation. Si aucune valeur n'est spécifiée, le fournisseur de localisation ne commence pas à suivre le trajet. Utilisez FleetEngineTripLocationProvider.tripId pour définir l'ID et commencer le suivi.
vehicleMarkerCustomization optional
Type : (function(TripMarkerCustomizationFunctionParams): void)|MarkerOptions optional
Personnalisation appliquée au repère du véhicule.

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 TripMarkerCustomizationFunctionParams pour obtenir la liste des paramètres fournis et de leurs utilisations.
waypointMarkerCustomization optional
Personnalisation appliquée à un repère de point de cheminement.

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 TripWaypointMarkerCustomizationFunctionParams pour obtenir la liste des paramètres fournis et de leurs utilisations.

Interface FleetEngineTripLocationProviderUpdateEvent

Interface google.maps.journeySharing.FleetEngineTripLocationProviderUpdateEvent

Objet d'événement transmis au gestionnaire d'événements lorsque l'événement FleetEngineTripLocationProvider.update est déclenché.
trip optional
Type : Trip optional
Structure du voyage renvoyée par la mise à jour. Non modifiable.