📚Références de l'API

L'API JavaScript de Jakartowns permet d'intégrer le jumeau numérique Jakartowns dans des applications web tierces. Le script JavaScript contient le code informatique de l'API avec toutes ses fonctions et méthodes pour manipuler le jumeau numérique.

L'API facilite ainsi l'interaction avec le jumeau numérique en fournissant des méthodes pour définir la position, la rotation, le tilt et le champ de vision de la vue.

L'API s'applique sur un conteneur HTML de la page web applicative.

Une fois l'API récupérée, la fonction create_jakartowns est disponible pour créer une instance du jumeau numérique Jakartowns dans un conteneur spécifique sur la page web.

window.jakartowns.app.create_jakartowns('#app', options, callback)

Cette fonction est responsable de créer le jumeau numérique Jakartowns dans le conteneur spécifié, avec les options de configuration spécifiées, et exécute la fonction de rappel une fois que le jumeau numérique est prêt à être utilisé. Cela permet aux développeurs d'interagir avec le jumeau numérique et de personnaliser son comportement en fonction de leurs besoins spécifiques.

Voici une explication détaillée de chaque paramètre de cette fonction :

1. '#app': C'est le sélecteur CSS de l'élément sur la page HTML où vous souhaitez afficher le jumeau numérique. Dans ce cas, l'élément avec l'ID "app" sera utilisé comme conteneur pour le jumeau numérique.

2. options: C'est un objet JavaScript contenant les options de configuration pour le jumeau numérique. Ces options permettent de contrôler si l'en-tête et la mini-carte du jumeau numérique sont activés ou désactivés.

3. callback: C'est une fonction de rappel (callback) qui est appelée une fois que l'instance du jumeau numérique est créée et prête à être utilisée. Cette fonction de rappel peut être définie comme une fonction anonyme (arrow function) qui prend un paramètre viewer. Ce paramètre viewer correspond à l'instance du jumeau numérique créée. Vous pouvez utiliser cette instance pour effectuer des actions et des opérations spécifiques sur le jumeau numérique, par exemple, ajouter des écouteurs pour les événements de mise à jour de position, rotation, tilt et fov.

Fonction pour interagir avec le jumeau numérique

setPosition(viewer, wantedPosition: { latitude: float, longitude: float })

Définit la position de la vue du jumeau numérique sur la carte en utilisant les coordonnées de latitude et de longitude spécifiées. Cette fonction renvoie les données du jumeau numérique après le positionnement, y compris l'UID de l'image actuelle et la distance entre la position ciblée et la position du panorama.

setTilt(viewer, wantedTilt: int)

Définit l'inclinaison verticale de la vue du jumeau numérique en utilisant la valeur spécifiée. Cette fonction renvoie la nouvelle inclinaison.

setPan(viewer, wantedPan: int)

Définit la rotation horizontale de la vue du jumeau numérique en utilisant la valeur spécifiée. Cette fonction renvoie la nouvelle rotation.

setFov(viewer, wantedFov: int)

Définit le champ de vision (FOV) de la vue du jumeau numérique en utilisant la valeur spécifiée. Cette fonction renvoie la nouvelle valeur de FOV.

Événements

position

Cet événement est déclenché lorsque l'utilisateur change de position dans le jumeau numérique. Il fournit les détails de la nouvelle position, y compris les coordonnées de latitude et de longitude.

rotation

Cet événement est déclenché lorsque l'utilisateur change la rotation horizontale de la vue du jumeau numérique. Il fournit la nouvelle valeur de rotation.

tilt

Cet événement est déclenché lorsque l'utilisateur change l'inclinaison verticale de la vue du jumeau numérique. Il fournit la nouvelle valeur d'inclinaison.

fov

Cet événement est déclenché lorsque l'utilisateur change le champ de vision (FOV) de la vue du jumeau numérique. Il fournit la nouvelle valeur de FOV.