Passer au contenu principal

VpsCoachingOverlay.configure()

VpsCoachingOverlay.configure({ wayspotName, hintImage, animationColor, animationDuration, textColor, promptPrefix, promptSuffix, statusText, disablePrompt })

Description​

Configure le comportement et l'apparence de la superposition de l'encadrement du VPS Lightship.

Paramètres (tous facultatifs)​

ParamètresTypeDéfautDescription
nom du wayspotChaîneLe nom du wayspot sur lequel la superposition de coaching guide l'utilisateur pour qu'il se localise. Si aucun nom wayspot n'est spécifié, il utilisera le plus proche. Si le projet n'a pas de wayspott, il utilisera le plus proche.
hintImageChaîneImage affichée à l'utilisateur pour le guider vers le lieu réel. Si aucune image secondaire n'est spécifiée, l'image par défaut sera utilisée pour le Wayspot. Si le Wayspot n'a pas d'image par défaut, aucune image ne sera affichée.
couleur d'animationChaîne'#ffffff'Couleur de l'animation de la superposition d'entraînement. Ce paramètre accepte les arguments de couleur CSS valides.
durée de l'animationNombre5000Durée totale d'affichage de l'image de l'indice avant son rétrécissement (en millisecondes).
couleur du texteChaîne'#ffffff'Couleur de l'ensemble du texte de la superposition d'accompagnement. Ce paramètre accepte les arguments de couleur CSS valides.
préfixe de l'inviteChaînepointez votre appareil photo surDéfinit la chaîne de texte pour l'action utilisateur conseillée au-dessus du nom du Wayspot.
suffixe de l'inviteChaîneet se déplacerDéfinit la chaîne de texte pour l'action utilisateur conseillée sous le nom du Wayspot.
statusTextChaîne'Scanner...'Définit la chaîne de texte qui s'affiche sous l'image secondaire lorsqu'elle est réduite.
disablePromptBooléenfauxLa valeur vrai permet de masquer la superposition d'entraînement par défaut afin d'utiliser les événements de superposition d'entraînement pour une superposition personnalisée.

Retours​

Aucun

Exemple - Code​

VpsCoachingOverlay.configure({
textColor: '#0000FF',
promptPrefix: 'Go look for',
})