applican

マイページに戻る

Compass

端末の方向に関する情報を取得します。

機能

現在の方位を取得する 【 getCurrentHeading 】

コンパス方位を一定の時間間隔で取得する 【 watchHeading 】

コンパスの監視を停止する 【 clearWatch 】

利用用途

方位の取得（コンパス）を利用した機能を実装したい場合、こちらの機能をご利用ください。

【対応ランタイムバージョン】

ランタイムのバージョン毎に最適化したサンプルをダウンロードしてご使用ください。

サンプル Compass
サンプル Compass
サンプル Compass
サンプル Compass

メソッド

getCurrentHeading

メソッド説明

getCurrentHeading(Function<CompassResult> successCallback, Function errorCallback, CompassOptions option)

現在の方位を取得します。

コンパスは端末が向いている方向を感知するセンサーです。コンパスは方位を0から359.99の範囲で計測します。

パラメータ

successCallback : Function<CompassResult> コンパス方位の取得が出来た場合にCallbackされます。
errorCallback : Function コンパス方位の取得が出来なかった場合にCallbackされます。

Return

void

サンプルコード

//現在向いている方角を取得
function getCurrentHeading(){
	applican.compass.getCurrentHeading(currentHeadingSuccess, currentHeadingError);
}
function currentHeadingSuccess(res){
	var dump = "currentHeadingSuccess\n";
	dump += "magneticHeading:"+res.magneticHeading+"\n";
	dump += "trueHeading:"+res.trueHeading+"\n";
	dump += "headingAccuracy:"+res.headingAccuracy+"\n";
	dump += "timestamp:"+res.timestamp+"\n";
	document.getElementById("dumpAreaCompass").value =dump;
}
function currentHeadingError(e){
	var dump = "currentHeadingError\n";
	dump += "code:"+e.code+"\n";
	document.getElementById("dumpAreaCompass").value =dump;
}

watchHeading

メソッド説明

watchHeading(Function<CompassResult> successCallback, Function errorCallback, CompassOptions option)

コンパス方位を一定の時間間隔で取得します。

パラメータ

successCallback : Function<CompassResult> コンパス方位の取得が出来た場合にCallbackされます。
errorCallback : Function コンパス方位の取得が出来なかった場合にCallbackされます。

Return

Number clearWatchメソッドの引数で指定すべき intervalIDを返却します。

サンプルコード

var_compassWatchID;
//コンパス方位を一定の時間間隔で取得
function watchHeading(){
	var options = { frequency: 100 };
	_compassWatchID = applican.compass.watchHeading(watchHeadingSuccess, watchHeadingError, options);
}
function watchHeadingSuccess(res){
	var dump = "watchHeadingSuccess\n";
	dump += "magneticHeading:"+res.magneticHeading+"\n";
	dump += "trueHeading:"+res.trueHeading+"\n";
	dump += "headingAccuracy:"+res.headingAccuracy+"\n";
	dump += "timestamp:"+res.timestamp+"\n";
	document.getElementById("dumpAreaCompass").value =dump;
}
function watchHeadingError(e){
	var dump = "watchHeadingError\n";
	dump += "code:"+e.code+"\n";
	document.getElementById("dumpAreaCompass").value =dump;
}

clearWatch

メソッド説明

clearWatch(Number intervalId)

コンパスの監視を停止します。

パラメータ

intervalId : Number watchHeadingメソッドの返却値を指定します。

Return

void

サンプルコード

var_compassWatchID;

//コンパス方位を一定の時間間隔で取得
function watchHeading(){
	var options = { frequency: 100 };
	_compassWatchID = applican.compass.watchHeading(watchHeadingSuccess, watchHeadingError, options);
}
function watchHeadingSuccess(res){
	var dump = "watchHeadingSuccess\n";
	dump += "magneticHeading:"+res.magneticHeading+"\n";
	dump += "trueHeading:"+res.trueHeading+"\n";
	dump += "headingAccuracy:"+res.headingAccuracy+"\n";
	dump += "timestamp:"+res.timestamp+"\n";
	document.getElementById("dumpAreaCompass").value =dump;
}
function watchHeadingError(e){
	var dump = "watchHeadingError\n";
	dump += "code:"+e.code+"\n";
	document.getElementById("dumpAreaCompass").value =dump;
}

//コンパスの監視を停止
function clearWatchHeading(){
	applican.compass.clearWatch(_compassWatchID);
	document.getElementById("dumpAreaCompass").value+"\nStop!!";
}