VpsCoachingOverlay.configure()

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

概要

Lightship VPSコーチングオーバーレイの動作と外観を設定します。

パラメータ（全てオプション）

パラメータ	タイプ	デフォルト	説明
wayspotName	String		コーチングオーバーレイがユーザーにローカライズを案内する場所の名前。 Location名が指定されていない場合、最も近いProject Locationが使用されます。 プロジェクトにプロジェクトロケーションがない場合は、最も近いロケーションを使用します。
hintImage	String		現実の場所へ案内するためにユーザーに表示される画像です。 hint-imageが指定されない場合は、Locationのデフォルト画像が使用されます。 ロケーションにデフォルト画像がない場合、画像は表示されません。
animationColor	String	'#ffffff'	コーチングオーバーレイのアニメーションの色です。 このパラメータは、有効なCSSのcolor引数を受け取ります。
animationDuration	Number	5000	ヒント画像が縮小されるまでの総表示時間（ミリ秒）です。
textColor	String	'#ffffff'	コーチングオーバーレイの全テキストの色です。 このパラメータは、有効なCSSのcolor引数を受け取ります。
promptPrefix	String	'Point your camera at'	ロケーション名の上にある、アドバイスされたユーザーアクションのテキスト文字列を設定します。
promptSuffix	String	'and move around'	ロケーション名の下にある、アドバイスされたユーザーアクションのテキスト文字列を設定します。
statusText	String	'Scanning...'	ヒント画像が縮小状態のときに、その下に表示されるテキスト文字列を設定します。
disablePrompt	Boolean	false	カスタムオーバーレイのコーチングオーバーレイイベントを使用したい場合、trueに設定すると、デフォルトのコーチングオーバーレイを非表示にします。

戻り値

なし

例 - コード

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