YOLP(地図)

JavaScript版地図 Version 1 リファレンスマニュアル




このWeb APIは古いバージョンのため、2014年5月31日をもって廃止いたします。新しいYOLP地図APIへの移行をお願いいたします。Yahoo! JavaScriptマップAPI、もしくはYahoo!スタティックマップAPIをご利用ください。

JavaScript版地図APIで利用可能なクラスおよびメソッドの説明をします。

クラス YahooMapsCtrl

地図面をコントロールするクラスです。

コンストラクタ: YahooMapsCtrl(id, pos, layer, mode, datum)

パラメータ 説明
id 地図を表示するHTML ElementのID
pos 初期表示位置(ホーム位置)の緯度経度(文字列またはYLLPointクラス)を指定します。
layer 初期表示位置(ホーム位置)の縮尺を指定します。縮尺は1~10の数値で値が大きくなるほど広域になります。デフォルト値は3です。
mode 初期表示位置(ホーム位置)の地図の種類を指定します。地図の種類は、YMapMode定数で指定します。デフォルト値はYMapMode.MAPです。

コンストラクタ: YahooMapsCtrl(element, pos, layer, mode, datum)

パラメータ 説明
element 地図を表示するHTML Element
pos 初期表示位置(ホーム位置)の緯度経度(文字列またはYLLPointクラス)を指定します。
layer 初期表示位置(ホーム位置)の縮尺を指定します。縮尺は1~10の数値で値が大きくなるほど広域になります。デフォルト値は3です。
mode 初期表示位置(ホーム位置)の地図の種類を指定します。地図の種類は、YMapMode定数で指定します。デフォルト値はYMapMode.MAPです。

メソッド

メソッド 説明
homeTo() ホーム位置へ移動します。
zoomIn() より詳細な縮尺に切り替えます。
zoomOut() より広域な縮尺に切り替えます。
changeMode(mode) 地図の種類を切り替えます。

パラメータ:

  • mode - 地図の種類(YMapMode定数)。デフォルト値は YMapMode.MAPです。
moveTo(pos) 指定した位置に移動します。

パラメータ:

  • pos - 緯度経度(文字列またはYLLPointクラス)
layerTo(layer) 指定した縮尺に切り替えます。

パラメータ:

  • layer - 縮尺(1~10)
setLayer(layer) 指定した縮尺に切り替えます。切り替えは即座に反映します。

パラメータ:

  • layer - 縮尺(1~10)
addCategory(id, img, param) カテゴリを追加します。

パラメータ:

  • id - カテゴリのID(任意の文字列が使用可能)
  • img - アイコン画像のURL
  • param - カテゴリパラメータ(指定しなくても可)

指定した画像のサイズが取得できるまでカテゴリは使用できません。

画像サイズを明示的に指定するには、paramにJSON形式で以下のように指定します。

{width:16, height:16}

removeCategory(id) カテゴリを削除します。

パラメータ:

  • id - 削除するカテゴリのID
addIcon(id, pos, popup, type, label) アイコンを追加します。

パラメータ:

  • id - アイコンのID(任意の文字列が使用可能)
  • pos - 緯度経度(文字列またはYLLPointクラス)
  • popup - 吹き出しの内容(HTMLが使用可能)
  • type - カテゴリのID
  • label - ラベル(省略可能)

カテゴリには、addCategory()で追加したカテゴリのほか、以下のIDが使用できます。

  • 'L1' - 大きいアイコン1
  • 'L2' - 大きいアイコン2
  • 'L3' - 大きいアイコン3
  • 'L4' - 大きいアイコン4
  • 'L5' - 大きいアイコン5
  • 'S1' - 小さいアイコン1
  • 'S2' - 小さいアイコン2
  • 'S3' - 小さいアイコン3
  • 'S4' - 小さいアイコン4
  • 'S5' - 小さいアイコン5
addIcons(ary) 複数のアイコンを追加します。

パラメータ:

  • ary - アイコン情報が格納された配列

引数aryは配列になっており、1つの要素が1つのアイコンを表します。

配列の1つの要素は以下のような JSON オブジェクトになっています。

{id:'icon1',pos:'35.40.39.798,139.46.15.436',popup:'ポップアップ',type:'L1',label:'ラベル'}

JSONオブジェクトのそれぞれのパラメータの仕様については、 addIcon()メソッドを参照してください。

getIcon(id) アイコン情報を取得します。

パラメータ:

  • id - 取得するアイコンのID

戻り値:以下のパラメータを持つJSON オブジェクト

  • id - アイコンのID
  • pos - 緯度経度(YLLPointクラス)
  • popup - 吹き出しの内容
  • type - カテゴリのID
  • label - ラベル
removeIcon(id) アイコンを削除します。

パラメータ:

  • id - 削除するアイコンのID
clearIcon(id) すべてのアイコンを削除します。
moveToIcon(id) アイコンの位置に移動します。

パラメータ:

  • id - 移動先のアイコンのID
openPopup(id) アイコンの吹き出しを開きます。

パラメータ:

  • id - アイコンのID
closePopup() 開いている吹き出しを閉じます。
getCenter() 中心の緯度経度を取得します。

戻り値:緯度経度(YLLPointクラス)

getBottomLeft() 左下の緯度経度を取得します。

戻り値:緯度経度(YLLPointクラス)

getTopRight() 右上の緯度経度を取得します。

戻り値:緯度経度(YLLPointクラス)

getCurrentLayer() 現在の縮尺を取得します。

戻り値:縮尺(1~10)

getCurrentMode() 現在の地図の種類を取得します。

戻り値:地図の種類(YMapMode定数)

addEvent(type, func) イベントハンドラを登録します。

パラメータ:

  • type - イベントタイプ(YEventType定数)
  • func - イベントハンドラ関数

戻り値:イベントオブジェクト(削除する際に必要)

removeEvent(obj) イベントハンドラを削除します。

パラメータ:

  • obj - イベントオブジェクト(addEventの戻り値)
setVisibleSliderbar(value) スライダーバーの表示・非表示を設定します。

パラメータ:

  • value - trueならスライダーバーを表示、falseなら縮尺切り替えボタンを表示します。デフォルトは縮尺切り替えボタン表示です。
setVisibleCentermark(value) 中心点の表示・非表示を設定します。

パラメータ:

  • value - trueなら中心点を表示、falseなら中心点を非表示 。デフォルトは中心点表示です。
setEnableClickPopup(value) クリックポップアップの有効・無効を設定します。

パラメータ:

  • value - trueならアイコンクリックで吹き出し表示、falseならマウスオーバーで吹き出し表示となります。デフォルトはマウスオーバーで吹き出し表示となります。
setEnableDraggableMode(value) ドラッガブルアイコンの有効・無効を設定します。

パラメータ:

  • value - trueならドラッガブルアイコン有効、falseなら無効。デフォルトはドラッガブルアイコン無効です。
setEnableWheelOperation(value) マウスホイール操作の有効・無効を設定します。

パラメータ:

  • value - true ならマウスホイール有効、false なら無効。 デフォルトはマウスホイール有効です。
getSuitableLayer(p1,p2) 2点が表示可能な最大の縮尺を返します。

パラメータ:

  • p1,p2 - 緯度経度(文字列または YLLPoint クラス)

戻り値:縮尺(1~10)

返された縮尺に地図が存在することを保証するものではありません。

クラス YLLPoint

緯度経度を管理するクラスです。

コンストラクタ: YLLPoint(lat, lon)

パラメータ 説明
lat 緯度(度単位の数値)を指定します。
lon 経度(度単位の数値)を指定します。

コンストラクタ: YLLPoint(pos)

パラメータ 説明
pos 緯度経度文字列を指定します。使用できる緯度経度文字列は以下のとおりです。
  • 度.分.秒形式(35.39.26.180,139.43.56.868)
  • 度/分/秒形式(35/39/26.180,139/43/56.868)
  • 度形式(35.657272,139.732463)

アトリビュート

アトリビュート 説明
lat 緯度を取得・設定します。度単位の数値です。
lon 経度を取得・設定します。度単位の数値です。

メソッド

メソッド 説明
toString() この緯度経度の文字列形式を返します。度.分.秒形式です。

定数 YMapMode

地図の種類を表す定数です。

定数 説明
MAP 地図
AERO 航空写真

定数 YEventType

イベントの種類を表す定数です。

定数 説明
MAP_CLICK 地図面をクリックしたときに発生します。イベントハンドラはクリックした位置の緯度経度(YLLPointクラス)を引数に取ります。
MAP_MOVING 地図面の移動中に発生します。
MAP_MOVED 地図面を移動したときに発生します。
LAYER_CHANGED 縮尺を変更したときに発生します。
MODE_CHANGED 地図の種類を変更したときに発生します。
MOUSE_OVER 地図面上にマウスオーバーしたときに発生します。
MOUSE_OUT 地図面上からマウスアウトしたときに発生します。
MOUSE_MOVE 地図面上でマウスカーソルが移動したときに発生します。イベントハンドラはマウスカーソル位置の緯度経度(YLLPointクラス)を引数に取ります。
ICON_CLICK アイコンをクリックしたときに発生します。イベントハンドラはクリックしたアイコンのIDを引数に取ります。
ICON_DBLCLICK アイコンをダブルクリックしたときに発生します。イベントハンドラはダブルクリックしたアイコンのIDを引数に取ります。
ICON_MOUSEDOWN アイコンにマウスダウンしたときに発生します。イベントハンドラはマウスダウンしたアイコンのIDを引数に取ります。
ICON_MOUSEUP アイコンにマウスアップしたときに発生します。イベントハンドラはマウスアップしたアイコンのIDを引数に取ります。
ICON_MOUSEOVER アイコンにマウスカーソルを合わせたとき(マウスオーバー)に発生します。イベントハンドラはマウスオーバーしたアイコンのIDを引数に取ります。
ICON_MOUSEOUT アイコンからマウスカーソルが外れたとき(マウスアウト)に発生します。イベントハンドラはマウスアウトしたアイコンのIDを引数に取ります。
POPUP_OPEN 吹き出しを開いたときに発生します。イベントハンドラはアイコンのIDを引数に取ります。
POPUP_CLOSE 吹き出しを閉じたときに発生します。