ZisAuth

認証クラス

OAuth2.0認証利用時のみ利用。
地図を利用する際のオプション等を取得します。

OAuth2.0認証でのjsAPIの利用方法については、以下をご確認ください。

OAuth2.0認証での利用手順

Methods

addEventListener(type, callback)

本メソッドは、認証クラスのイベントを登録します。

Parameters
type(string)

登録するイベントタイプを指定します。

callback(function)

イベント発生時のコールバック関数を指定します。

Event Type
イベントタイプ 説明
ready 地図が利用可能な場合に発行します。
failed エラーが発生した場合に発行します。
getStatus()

地図描画用のjsの取得状態を返却します。

Returns
成功した場合、以下のようなオブジェクトを返却します。
{
  status:true (取得に成功した場合) / false (取得に失敗した場合)
  progress:true (取得中) / false (取得中ではない場合)
}
getMapOption(loadMode)

地図を利用するのに必要な情報を返却します。
このメソッドにて取得したオプションを利用して地図を初期化できます。

その際のパラメータは以下の通りです
{
  minzoom:10
  movable:true
  zoomable:true
  keyboardOperation:true
  mouseOperation:true
  touchOperation:true
  centerZoom:true
}

初期位置、スケールなどは取得できませんので、初期位置を変更したい場合、
本メソッドで取得したオブジェクトに値を追加してご利用下さい。

Parameters
loadMode(Object)

地図のモードを指定します。
auto/指定なし:ベクトル/ラスターを自動判定

  • (ラスターと判定する条件)
  • ・ユーザーエージェントに"MSIE"が含まれる(IE判定)
  • ・ユーザーエージェントに"TRIDENT"が含まれる(IE判定)
  • ・ユーザーエージェントに"Android"が含まれ、バージョンが取れないか、バージョンが10より小さい
  • ・ユーザーエージェントに"iPad"が含まれる
  • (ベクトルと判定する条件)
  • ・上記以外
forceRaster:ラスター
forceVector:ベクター

Example
・地図のモードを自動判定する場合
var map = new ZDC.Map(elm, ZisAuth.getMapOption({loadMode: "auto"}), function(){}, function(){});
・地図のモードをラスターとする場合
var map = new ZDC.Map(elm, ZisAuth.getMapOption({loadMode: "forceRaster"}), function(){}, function(){});
・位置等がデフォルトで良い場合
var map = new ZDC.Map(elm, ZisAuth.getMapOption(), function(){}, function(){});
・位置を指定する場合
var opt = ZisAuth.getMapOption();
opt.center = new ZDC.LatLng(35.5, 139.5);
var map = new ZDC.Map(elm, opt, function(){}, function(){});
・位置+縮尺を指定する場合
var opt = ZisAuth.getMapOption();
opt.center = new ZDC.LatLng(35.5, 139.5);
opt.scale = 1500;
var map = new ZDC.Map(elm, opt, function(){}, function(){});
※ZDC.Mapのコンストラクタ・オプションの詳細については、 リファレンスを参照下さい。
※getMapOptionのレスポンスに含まれるドメイン情報の利用は非推奨となります。
quit()

認証クラスでキャッシュしている情報をクリアします。


Events

  • ready
    • 地図オブジェクトが生成可能な状態になったら発行されます。
      getMapOptionメソッドを呼び出すことが可能になるので、
      オプションを取得後、ZDC.Mapを作成して地図を表示して下さい。
  • failed
    • 何らかのエラーが発生した場合に発行されます。
      • WEBGL JavaScript APIのロード失敗
      • 認証クラスのロードに問題があった場合
        etc...
    • エラーが発生した場合、このイベントハンドラーには原因を示す情報が引数にて渡されます。
      {
        status:{
          code:[エラーコード]
        }
      }

    • エラーコード一覧は下記です。
      コード 意味 原因 対応
      19119001 サーバ接続エラー サーバに接続できませんでした。 時間を置いて再試行頂き、継続する場合には許可ドメイン等のネットワーク設定をご確認ください。
      19119002 パラメータ不正 パラメータ指定に誤りがあります。 パラメータの指定を確認してください。