Classe FleetEngineDeliveryVehicleLocationProvider
Classe google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProvider
Fournisseur de localisation des véhicules de livraison.
Cette classe étend PollingLocationProvider
.
Pour y accéder, appelez const {FleetEngineDeliveryVehicleLocationProvider} = await google.maps.importLibrary("journeySharing")
. Consultez Bibliothèques dans l'API Maps JavaScript.
Constructeur | |
---|---|
FleetEngineDeliveryVehicleLocationProvider |
FleetEngineDeliveryVehicleLocationProvider(options) Paramètres:
Crée un fournisseur d'emplacements pour un véhicule de livraison Fleet Engine. |
Propriétés | |
---|---|
deliveryVehicleId |
Type:
string ID du véhicule observé par ce fournisseur de localisation. 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 applicable à l'obsolescence de l'emplacement du véhicule. Si la dernière position actualisée du véhicule est plus ancienne que ce seuil, le véhicule ne s'affiche pas. |
taskFilterOptions |
Affiche les options de filtre à 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é lorsqu'une erreur est rencontrée par le fournisseur de services de localisation. |
update |
function(event) Arguments:
Événement déclenché lorsqu'une requête de mise à jour de données Fleet Engine est terminée. |
Hérité:
ispollingchange
|
Interface FleetEngineDeliveryVehicleLocationProviderOptions
Interface google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderOptions
Options pour le fournisseur de services de localisation des véhicules 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 du projet du client provenant de la console Google Cloud. |
activePolylineCustomization optional |
Type:
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional Personnalisation appliquée à la polyligne active. Une polyligne active correspond à une partie de l'itinéraire que le véhicule traverse. Ce champ vous permet de spécifier un style personnalisé (comme la couleur de la polyligne) et de 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. S'il n'est pas spécifié, le fournisseur de services de localisation ne commence à suivre aucun véhicule. Utilisez FleetEngineDeliveryVehicleLocationProvider.deliveryVehicleId pour définir l'identifiant et commencer le suivi. |
deliveryVehicleMarkerCustomization optional |
Type:
(function(DeliveryVehicleMarkerCustomizationFunctionParams): void)|MarkerOptions optional Personnalisation appliquée au repère du véhicule de livraison. Ce champ vous permet de définir un style personnalisé (comme une icône de repère) et des éléments interactifs (comme la gestion des clics).
|
plannedStopMarkerCustomization optional |
Type:
(function(PlannedStopMarkerCustomizationFunctionParams): void)|MarkerOptions optional Personnalisation appliquée à un repère d'arrêt planifié. Ce champ vous permet de définir un style personnalisé (comme une icône de repère) et des éléments interactifs (comme la gestion des clics).
|
pollingIntervalMillis optional |
Type:
number optional Délai minimal entre la récupération des mises à jour de la 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 lancée que lorsque la mise à jour en cours est terminée. Si vous définissez cette valeur sur 0, les mises à jour de la position sont désactivées de façon récurrente. 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 d'interrogation sur une valeur non nulle inférieure, la valeur 5 000 est utilisée. |
remainingPolylineCustomization optional |
Type:
(function(DeliveryVehiclePolylineCustomizationFunctionParams): 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 commencé à traverser. Ce champ vous permet de spécifier un style personnalisé (comme la couleur de la polyligne) et de l'interactivité (comme la gestion des clics).
|
shouldShowOutcomeLocations optional |
Type:
boolean optional Booléen pour afficher ou masquer les emplacements des résultats des tâches récupérées. |
shouldShowTasks optional |
Type:
boolean optional Booléen 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 prochains arrêts seront affichés. |
staleLocationThresholdMillis optional |
Type:
number optional Seuil applicable à l'obsolescence de l'emplacement du véhicule. Si la dernière position actualisée du véhicule est plus ancienne que ce seuil, le véhicule ne s'affichera pas. La valeur par défaut est de 24 heures en millisecondes. Si le seuil est inférieur à 0 (ou à la valeur Infinity), il est ignoré et l'emplacement du véhicule n'est pas considéré comme obsolète. |
takenPolylineCustomization optional |
Type:
(function(DeliveryVehiclePolylineCustomizationFunctionParams): void)|PolylineOptions optional Personnalisation appliquée à la polyligne choisie. Une polyligne utilisée correspond à une partie de l'itinéraire que le véhicule a déjà traversé. Ce champ vous permet de spécifier un style personnalisé (comme la couleur de la polyligne) et de 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 le véhicule, l'heure et l'état de la tâche. |
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. Ce champ vous permet de définir un style personnalisé (comme une icône de repère) et des éléments interactifs (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 indicateur de résultat de tâche est affiché à l'emplacement réel du résultat de chaque tâche attribuée au véhicule de livraison. Ce champ vous permet de définir un style personnalisé (comme une icône de repère) et des éléments interactifs (comme la gestion des clics).
|
Interface FleetEngineTaskFilterOptions
Interface google.maps.journeySharing.FleetEngineTaskFilterOptions
Options de filtrage des tâches dans le fournisseur de localisation des véhicules de livraison.
Propriétés | |
---|---|
completionTimeFrom optional |
Type:
Date optional Limite inférieure exclusive pour l'heure d'achèvement de la tâche. Utilisé pour filtrer les tâches terminées après le délai spécifié. |
completionTimeTo optional |
Type:
Date optional Limite supérieure exclusive pour la date d'achèvement de la tâche. Utilisé pour 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 OPEN ou CLOSED. |
Interface FleetEngineDeliveryVehicleLocationProviderUpdateEvent
Interface google.maps.journeySharing.FleetEngineDeliveryVehicleLocationProviderUpdateEvent
Objet é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 terminé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 exécutées par ce véhicule de livraison. Non modifiable. |
Classe FleetEngineDeliveryFleetLocationProvider
Classe google.maps.journeySharing.FleetEngineDeliveryFleetLocationProvider
Fournisseur de localisation de parc de livraison.
Cette classe étend PollingLocationProvider
.
Pour y accéder, appelez const {FleetEngineDeliveryFleetLocationProvider} = await google.maps.importLibrary("journeySharing")
. Consultez Bibliothèques dans l'API Maps JavaScript.
Constructeur | |
---|---|
FleetEngineDeliveryFleetLocationProvider |
FleetEngineDeliveryFleetLocationProvider(options) Paramètres:
Crée un fournisseur de localisation 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 applicable à l'obsolescence de l'emplacement du véhicule. Si la dernière position actualisée 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é lorsqu'une requête de mise à jour de données Fleet Engine est terminée. |
Hérité:
ispollingchange
|
Interface FleetEngineDeliveryFleetLocationProviderOptions
Interface google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderOptions
Options pour le fournisseur de localisation du parc 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 du projet du client provenant de la console Google Cloud. |
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. Consultez ListDeliveryVehiclesRequest.filter pour connaître les formats acceptés. Notez que les filtres d'attributs valides doivent comporter le préfixe "attributes". Exemples : 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. Ce champ vous permet de définir un style personnalisé (comme une icône de repère) et des éléments interactifs (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 localisation. Si cette règle n'est pas configurée, le fournisseur de localisation ne commence à suivre aucun véhicule. 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 applicable à l'obsolescence de l'emplacement du véhicule. Si la dernière position actualisée du véhicule est plus ancienne que ce seuil, le véhicule ne s'affichera pas. La valeur par défaut est de 24 heures en millisecondes. Si le seuil est inférieur à zéro ou défini sur Infinity, il est ignoré et la position du véhicule n'est pas considérée comme obsolète. |
Interface FleetEngineDeliveryFleetLocationProviderUpdateEvent
Interface google.maps.journeySharing.FleetEngineDeliveryFleetLocationProviderUpdateEvent
Objet é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. |