Classe FleetEngineDeliveryVehicleLocationProvider
Classe google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProvider
Fournisseur de localisation du véhicule de livraison.
Cette classe étend PollingLocationProvider
.
Accédez-y en appelant const {FleetEngineDeliveryVehicleLocationProvider} = await google.maps.importLibrary("journeySharing")
. Consultez la section Bibliothèques de l'API Maps JavaScript.
Constructeur | |
---|---|
FleetEngineDeliveryVehicleLocationProvider |
FleetEngineDeliveryVehicleLocationProvider(options) Paramètres:
Crée un fournisseur de position pour un véhicule de livraison Fleet Engine. |
Propriétés | |
---|---|
deliveryVehicleId |
Type:
string ID du véhicule suivi par ce fournisseur de position. Définissez ce champ pour suivre un véhicule. |
shouldShowOutcomeLocations |
Type:
boolean optional Autorisez éventuellement les utilisateurs à afficher l'emplacement du résultat de la tâche. |
shouldShowTasks |
Type:
boolean optional Autorisez éventuellement les utilisateurs à afficher les tâches récupérées. |
staleLocationThresholdMillis |
Type:
number Ce champ est en lecture seule. Seuil de vétusté de la position du véhicule. Si la dernière position du véhicule est plus ancienne que ce seuil, le véhicule ne s'affiche pas. |
taskFilterOptions |
Renvoie les options de filtrage à appliquer lors de la récupération des tâches. |
Hérité:
isPolling ,
pollingIntervalMillis
|
Méthodes | |
---|---|
Hérité:
addListener
|
Événements | |
---|---|
error |
function(event) Arguments:
Événement déclenché lorsque le fournisseur de position rencontre une erreur. |
update |
function(event) Arguments:
Événement déclenché une fois qu'une requête de mise à jour des données de Fleet Engine est terminée. |
Hérité:
ispollingchange
|
Interface FleetEngineDeliveryVehicleLocationProviderOptions
Interface google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderOptions
Options pour le fournisseur de localisation du véhicule de livraison.
Propriétés | |
---|---|
authTokenFetcher |
Type:
AuthTokenFetcher Fournit des jetons Web JSON pour authentifier le client auprès de Fleet Engine. |
projectId |
Type:
string ID de projet du client à partir de Google Cloud Console. |
activePolylineCustomization optional |
Type:
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional Personnalisation appliquée à la polyligne active. Une polyligne active correspond à une partie du trajet que le véhicule emprunte actuellement. Utilisez ce champ pour spécifier un style personnalisé (comme la couleur de la polyligne) et l'interactivité (comme la gestion des clics).
|
deliveryVehicleId optional |
Type:
string optional ID du véhicule de livraison à suivre immédiatement après l'instanciation du fournisseur de position. Si cet élément n'est pas spécifié, le fournisseur de position ne commence pas à suivre un véhicule. Utilisez FleetEngineDeliveryVehicleLocationProvider.deliveryVehicleId pour définir l'ID et commencer le suivi. |
deliveryVehicleMarkerCustomization optional |
Type:
(function(DeliveryVehicleMarkerCustomizationFunctionParams): void)|MarkerOptions optional Personnalisation appliquée au repère du véhicule de livraison. Utilisez ce champ pour spécifier un style personnalisé (comme une icône de repère) et une interactivité (comme la gestion des clics).
|
plannedStopMarkerCustomization optional |
Type:
(function(PlannedStopMarkerCustomizationFunctionParams): void)|MarkerOptions optional Personnalisation appliquée à un repère de point d'arrêt planifié. Utilisez ce champ pour spécifier un style personnalisé (comme une icône de repère) et une interactivité (comme la gestion des clics).
|
pollingIntervalMillis optional |
Type:
number optional Durée minimale entre l'extraction des mises à jour de position, en millisecondes. Si l'extraction d'une mise à jour de position prend plus de pollingIntervalMillis , la mise à jour suivante ne commence pas tant que la mise à jour actuelle n'est pas terminée. Définir cette valeur sur 0 désactive les mises à jour de position récurrentes. Une nouvelle mise à jour de la position est récupérée si l'un des paramètres observés par le fournisseur de position change. L'intervalle d'interrogation par défaut est de 5 000 millisecondes, l'intervalle minimal. Si vous définissez l'intervalle de sondage sur une valeur inférieure non nulle, la valeur 5 000 est utilisée. |
remainingPolylineCustomization optional |
Type:
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional Personnalisation appliquée à la partie restante de la polyligne. Une polyligne restante correspond à une partie du trajet que le véhicule n'a pas encore commencé à parcourir. Utilisez ce champ pour spécifier un style personnalisé (comme la couleur de la polyligne) et l'interactivité (comme la gestion des clics).
|
shouldShowOutcomeLocations optional |
Type:
boolean optional Valeur booléenne pour afficher ou masquer les emplacements des résultats pour les tâches récupérées. |
shouldShowTasks optional |
Type:
boolean optional Valeur booléenne pour afficher ou masquer les tâches. Si vous définissez cette valeur sur "false", le point de terminaison ListTasks ne sera pas appelé pour récupérer les tâches. Seuls les arrêts à venir du véhicule sont affichés. |
staleLocationThresholdMillis optional |
Type:
number optional Seuil de vétusté de la position du véhicule. Si la dernière position du véhicule est antérieure à ce seuil, le véhicule ne s'affiche pas. La valeur par défaut est de 24 heures en millisecondes. Si le seuil est inférieur à 0 ou défini sur Infinity, il sera ignoré et la position du véhicule ne sera pas considérée comme obsolète. |
takenPolylineCustomization optional |
Type:
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional Personnalisation appliquée à la polyligne enregistrée. Une polyligne prise correspond à une partie du trajet 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).
|
taskFilterOptions optional |
Type:
FleetEngineTaskFilterOptions optional Options de filtre à appliquer lors de la récupération des tâches. Les options peuvent inclure un véhicule, une heure et un état de tâche spécifiques. |
taskMarkerCustomization optional |
Type:
(function(TaskMarkerCustomizationFunctionParams): void)|MarkerOptions optional Personnalisation appliquée à un repère de tâche. Un repère de tâche s'affiche à l'emplacement prévu de chaque tâche attribuée au véhicule de livraison. Utilisez ce champ pour spécifier un style personnalisé (comme une icône de repère) et une interactivité (comme la gestion des clics).
|
taskOutcomeMarkerCustomization optional |
Type:
function(TaskMarkerCustomizationFunctionParams): void optional Personnalisation appliquée à un repère de résultat de tâche. Un repère de résultat de tâche s'affiche à l'emplacement réel du résultat de chaque tâche attribuée au véhicule de livraison. Utilisez ce champ pour spécifier un style personnalisé (comme une icône de repère) et une interactivité (comme la gestion des clics).
|
Interface FleetEngineTaskFilterOptions
Interface google.maps.journeySharing.FleetEngineTaskFilterOptions
Options de filtrage des tâches dans le fournisseur de localisation du véhicule de livraison.
Propriétés | |
---|---|
completionTimeFrom optional |
Type:
Date optional Seuil inférieur exclusif pour la durée d'exécution de la tâche. Permet de filtrer les tâches terminées après l'heure spécifiée. |
completionTimeTo optional |
Type:
Date optional Limite supérieure exclusive pour la date de fin de la tâche. Permet de filtrer les tâches terminées avant l'heure spécifiée. |
state optional |
Type:
string optional État de la tâche. Les valeurs valides sont "OUVERT" ou "FERMÉ". |
Interface FleetEngineDeliveryVehicleLocationProviderUpdateEvent
Interface google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderUpdateEvent
Objet d'événement transmis au gestionnaire d'événements lorsque l'événement FleetEngineDeliveryVehicleLocationProvider.update
est déclenché.
Propriétés | |
---|---|
completedVehicleJourneySegments optional |
Type:
Array<VehicleJourneySegment> optional Segments de trajet effectués par ce véhicule. Non modifiable. |
deliveryVehicle optional |
Type:
DeliveryVehicle optional Structure de données du véhicule de livraison renvoyée par la mise à jour. Non modifiable. |
tasks optional |
Liste des tâches effectuées par ce véhicule de livraison. Non modifiable. |
Classe FleetEngineDeliveryFleetLocationProvider
Classe google.maps.journeySharing.FleetEngineDeliveryFleetLocationProvider
Fournisseur de localisation de la flotte de livraison.
Cette classe étend PollingLocationProvider
.
Accédez-y en appelant const {FleetEngineDeliveryFleetLocationProvider} = await google.maps.importLibrary("journeySharing")
. Consultez la section Bibliothèques de l'API Maps JavaScript.
Constructeur | |
---|---|
FleetEngineDeliveryFleetLocationProvider |
FleetEngineDeliveryFleetLocationProvider(options) Paramètres:
Crée un fournisseur de position pour les véhicules suivis par Fleet Engine. |
Propriétés | |
---|---|
deliveryVehicleFilter |
Type:
string optional Filtre appliqué lors de la récupération des véhicules de livraison. |
locationRestriction |
Type:
LatLngBounds|LatLngBoundsLiteral optional Limites dans lesquelles suivre les véhicules de livraison. Si aucune limite n'est définie, aucun véhicule de livraison ne sera suivi. Pour suivre tous les véhicules de livraison, quel que soit leur emplacement, définissez des limites équivalentes à la surface de la Terre. |
staleLocationThresholdMillis |
Type:
number Ce champ est en lecture seule. Seuil de vétusté de la position du véhicule. Si la dernière position du véhicule est plus ancienne que ce seuil, le véhicule ne s'affiche pas. |
Hérité:
isPolling ,
pollingIntervalMillis
|
Méthodes | |
---|---|
Hérité:
addListener
|
Événements | |
---|---|
update |
function(event) Arguments:
Événement déclenché une fois qu'une requête de mise à jour des données de Fleet Engine est terminée. |
Hérité:
ispollingchange
|
Interface FleetEngineDeliveryFleetLocationProviderOptions
Interface google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderOptions
Options pour le fournisseur de localisation de la flotte de livraison.
Propriétés | |
---|---|
authTokenFetcher |
Type:
AuthTokenFetcher Fournit des jetons Web JSON pour authentifier le client auprès de Fleet Engine. |
projectId |
Type:
string ID de projet du client à partir de Google Cloud Console. |
deliveryVehicleFilter optional |
Type:
string optional Requête de filtre à appliquer lors de la récupération des véhicules de livraison. Ce filtre est transmis directement à Fleet Engine. Pour connaître les formats acceptés, consultez ListDeliveryVehiclesRequest.filter. Notez que les filtres valides pour les attributs doivent comporter le préfixe "attributes". Par exemple, attributes.x = "y" ou attributes."x y" = "z" . |
deliveryVehicleMarkerCustomization optional |
Type:
function(DeliveryVehicleMarkerCustomizationFunctionParams): void optional Personnalisation appliquée à un repère de véhicule de livraison. Utilisez ce champ pour spécifier un style personnalisé (comme une icône de repère) et une interactivité (comme la gestion des clics).
|
locationRestriction optional |
Type:
LatLngBounds|LatLngBoundsLiteral optional Limites de latitude/longitude dans lesquelles suivre les véhicules immédiatement après l'instanciation du fournisseur de position. Si ce champ n'est pas défini, le fournisseur de position ne commence pas à suivre les véhicules. Utilisez FleetEngineDeliveryFleetLocationProvider.locationRestriction pour définir les limites et commencer le suivi. Pour suivre tous les véhicules de livraison, quel que soit leur emplacement, définissez des limites équivalentes à la surface de la Terre. |
staleLocationThresholdMillis optional |
Type:
number optional Seuil de vétusté de la position du véhicule. Si la dernière position du véhicule est antérieure à ce seuil, le véhicule ne s'affiche pas. La valeur par défaut est de 24 heures en millisecondes. Si le seuil est inférieur à zéro ou Infinity, il sera ignoré et la position du véhicule ne sera pas considérée comme obsolète. |
Interface FleetEngineDeliveryFleetLocationProviderUpdateEvent
Interface google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderUpdateEvent
Objet d'événement transmis au gestionnaire d'événements lorsque l'événement FleetEngineDeliveryFleetLocationProvider.update
est déclenché.
Propriétés | |
---|---|
deliveryVehicles optional |
Type:
Array<DeliveryVehicle> optional Liste des véhicules de livraison renvoyée par la requête. Non modifiable. |