Classe FleetEngineVehicleLocationProvider
Classe google.maps.journeySharing.FleetEngineVehicleLocationProvider
Fournisseur de localisation de véhicules.
Cette classe étend PollingLocationProvider
.
Pour y accéder, appelez const {FleetEngineVehicleLocationProvider} = await google.maps.importLibrary("journeySharing")
. Consultez Bibliothèques dans l'API Maps JavaScript.
Constructeur | |
---|---|
FleetEngineVehicleLocationProvider |
FleetEngineVehicleLocationProvider(options) Paramètres:
Crée un fournisseur de localisation pour un véhicule Fleet Engine. |
Méthodes statiques | |
---|---|
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION |
TRAFFIC_AWARE_ACTIVE_POLYLINE_CUSTOMIZATION_FUNCTION(params) Paramètres:
Return Value (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 en tant que FleetEngineVehicleLocationProviderOptions.activePolylineCustomization afin d'afficher une polyligne prenant en compte le trafic pour la polyligne active. |
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION |
TRAFFIC_AWARE_REMAINING_POLYLINE_CUSTOMIZATION_FUNCTION(params) Paramètres:
Return Value (Valeur renvoyée) : aucune
Fonction de personnalisation des polylignes qui colore la polyligne restante en fonction de sa vitesse de lecture. Spécifiez cette fonction en tant que FleetEngineVehicleLocationProviderOptions.remainingPolylineCustomization afin d'afficher une polyligne tenant compte du trafic pour la polyligne restante. |
Propriétés | |
---|---|
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. |
vehicleId |
Type:
string ID du véhicule observé par ce fournisseur de localisation. Définissez ce champ pour suivre un véhicule. |
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
|
FleetEngineVehicleLocationProviderOptions.
Interface google.maps.journeySharing.FleetEngineVehicleLocationProviderOptions
Options pour le fournisseur de services de localisation de véhicules.
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(VehiclePolylineCustomizationFunctionParams): 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).
|
destinationMarkerCustomization optional |
Type:
(function(VehicleWaypointMarkerCustomizationFunctionParams): void)|MarkerOptions optional Personnalisation appliquée au repère de destination du véhicule. 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).
|
intermediateDestinationMarkerCustomization optional |
Type:
(function(VehicleWaypointMarkerCustomizationFunctionParams): void)|MarkerOptions optional Personnalisation appliquée aux repères intermédiaires de destination du trajet du véhicule. 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).
|
originMarkerCustomization optional |
Type:
(function(VehicleWaypointMarkerCustomizationFunctionParams): void)|MarkerOptions optional Personnalisation appliquée au repère de départ du trajet du véhicule. 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(VehiclePolylineCustomizationFunctionParams): 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).
|
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(VehiclePolylineCustomizationFunctionParams): 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).
|
vehicleId optional |
Type:
string optional ID du véhicule à suivre immédiatement après l'instanciation du fournisseur de localisation. S'il n'est pas spécifié, le fournisseur de services de localisation ne commence à suivre aucun véhicule. Utilisez FleetEngineVehicleLocationProvider.vehicleId pour définir l'identifiant et commencer le suivi. |
vehicleMarkerCustomization optional |
Type:
(function(VehicleMarkerCustomizationFunctionParams): void)|MarkerOptions optional Personnalisation appliquée au repère du véhicule. 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).
|
FleetEngineVehicleLocationProviderUpdateEvent.
Interface google.maps.journeySharing.FleetEngineVehicleLocationProviderUpdateEvent
Objet événement transmis au gestionnaire d'événements lorsque l'événement FleetEngineVehicleLocationProvider.update
est déclenché.
Propriétés | |
---|---|
trips optional |
Liste des trajets effectués par ce véhicule. Non modifiable. |
vehicle optional |
Type:
Vehicle optional Structure des données du véhicule renvoyée par la mise à jour Non modifiable. |
Classe FleetEngineFleetLocationProvider
Classe google.maps.journeySharing.FleetEngineFleetLocationProvider
Fleet Location Provider.
Cette classe étend PollingLocationProvider
.
Pour y accéder, appelez const {FleetEngineFleetLocationProvider} = await google.maps.importLibrary("journeySharing")
. Consultez Bibliothèques dans l'API Maps JavaScript.
Constructeur | |
---|---|
FleetEngineFleetLocationProvider |
FleetEngineFleetLocationProvider(options) Paramètres:
Crée un fournisseur de localisation pour les véhicules suivis par Fleet Engine. |
Propriétés | |
---|---|
locationRestriction |
Type:
LatLngBounds|LatLngBoundsLiteral optional Limites dans lesquelles suivre les véhicules. Si aucune limite n'est définie, aucun véhicule ne sera suivi. Pour suivre tous les véhicules, 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. |
vehicleFilter |
Type:
string optional Filtre appliqué lors de la récupération des véhicules. |
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 FleetEngineFleetLocationProviderOptions
Interface google.maps.journeySharing.FleetEngineFleetLocationProviderOptions
Options pour le fournisseur de services de localisation de parc.
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. |
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 FleetEngineFleetLocationProvider.locationRestriction pour définir les limites et commencer le suivi. Pour suivre tous les véhicules, 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'affiche 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. |
vehicleFilter optional |
Type:
string optional Requête de filtre à appliquer lors de la récupération de véhicules. Ce filtre est transmis directement à Fleet Engine. Consultez ListVehiclesRequest.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" . |
vehicleMarkerCustomization optional |
Type:
function(VehicleMarkerCustomizationFunctionParams): void optional Personnalisation appliquée à un repère de véhicule. 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 FleetEngineFleetLocationProviderUpdateEvent
Interface google.maps.journeySharing.FleetEngineFleetLocationProviderUpdateEvent
Objet événement transmis au gestionnaire d'événements lorsque l'événement FleetEngineFleetLocationProvider.update
est déclenché.
Propriétés | |
---|---|
vehicles optional |
Liste des véhicules renvoyée par la requête. Non modifiable. |