Coreクラス

Namespace YOLP

YOLP名前空間

Namespace Summary

Method Summary

Method Detail

• <static> {Object}YOLP.extend(base, create)
  指定されたオブジェクトを継承するオブジェクトが生成されます。

  // BaseClassを継承するExtendClassを定義します。
  var ExtendClass = Y.extend( BaseClass , function() { 
    //ExtendClassの初期化処理を行います。
    this.val = "aaa";
  } );

Parameters:

{Object} base

基底オブジェクト

{Object} create

生成オブジェクト

Returns:

{Object}

このページのトップへ

Namespace Y

Y名前空間

Namespace Summary

このページのトップへ

Class Map

地図表示

Class Summary

Method Summary

Event Summary

Method Detail

• addControl(control, position)
  地図にコントロールを追加します。

Parameters:

{Control} control

追加するコントロール

{ControlPosition} position Optional

追加する位置

• addFeature(feature)
  地図に地物を追加します。

Parameters:

{Feature} feature

地物

• addFeatures(features)
  地図に複数の地物を追加します。

Parameters:

{ArrayOfFeature} features

地物

• addLayer(layer)
  地図にレイヤーを追加します。 追加されたレイヤーはすべてのレイヤーセットに対して追加されます。

Parameters:

{Layer} layer

追加するレイヤー

• addLayerSet(id, layerset)
  地図に新しいレイヤーセットを追加します。

Parameters:

{String} id

追加するレイヤーセットID

{LayerSet} layerset

追加するレイヤーセット

• addPlugin(plugin)
  プラグインを追加します。

Parameters:

{Plugin} plugin

追加するプラグイン

• {EventListener}bind(type, function, object)
  地図オブジェクトが通知するイベントに対してイベントハンドラを設定します。

 map.bind("click", function(clickLatLng) {
     this.openInfoWindow(clickLatLng, "地図がクリックされました");
 });

Parameters:

{String} type

イベント名

{Function} function

イベント発生時に呼び出されるイベントハンドラ

{Object} object Optional

設定したイベントハンドラ内でthisとして評価されるオブジェクト
省略時は地図オブジェクト自身をthisとして評価

Returns:

{EventListener}

• clearFeatures()
  地図からすべての地物を削除します。 独自のレイヤーに定義された地物は削除の対象外となります。

• closeInfoWindow()
  現在表示している情報ウィンドウを閉じます。

• drawBounds(bounds, layerSetId)
  指定された地理座標範囲が含まれる範囲の地図を表示します。

Parameters:

{LatLngBounds} bounds

地理範囲

{String} layerSetId Optional

レイヤーセットID

• drawMap(center, zoom, layerSetId)
  地図を描画します。 引数は変数名と同じ名前のキーを持つオブジェクトでも指定できます。

 // 地図の描画を行います。どちらの呼び出し形式でも同じ結果になります。
 map.drawMap(new Y.LatLng(35.66572, 139.73100), 17, Y.LayerSetId.NORMAL);
 map.drawMap({
    "center": new Y.LatLng(35.66572, 139.73100), 
    "zoom": 17, 
    "LayerSetId": Y.LayerSetId.NORMAL
 });

Parameters:

{LatLng} center

中心の緯度経度

{Number} zoom Optional

ズームレベル

{String} layerSetId Optional

レイヤーセットID

• {LatLng}fromContainerPixelToLatLng(point)
  コンテナ座標を地理座標へ変換します。

Parameters:

{Point} point

コンテナ座標

Returns:

{LatLng} 地理座標

• {Point}fromLatLngToContainerPixel(latlng)
  地理座標をコンテナ座標へ変換します。

Parameters:

{LatLng} latlng

地理座標

Returns:

{Point} コンテナ座標

• {LatLngBounds}getBounds()
  地図の矩形領域を緯度経度座標で返します。

Returns:

{LatLngBounds}

• {Number}getBoundsZoomLevel(bounds)
  指定された矩形領域が地図に収まるズームレベルを返します。

Parameters:

{LatLngBounds} bounds

緯度経度矩形領域

Returns:

{Number} ズームレベル

• {LatLng}getCenter()
  地図中心点の地理座標を返します。

Returns:

{LatLng}

• {MapConfigure}getConfigure(name)
  各種設定を返します。

Parameters:

{String} name

設定名

Returns:

{MapConfigure} 設定内容

• {Object}getConfigures()
  各種設定内容をすべて返します。

Returns:

{Object} 設定内容の詳細はMapを参照

• {Node}getContainer()
  地図を含むDOMオブジェクトを返します。

Returns:

{Node}

• {LayerSet}getCurrentLayerSet()
  現在選択されているLayerSetを返します。

Returns:

{LayerSet}

• {String}getCurrentLayerSetId()
  現在選択中のレイヤーセットIDを返します。

Returns:

{String} layerSetId

• {Array}getFeatures()
  地図上のすべての地物を取得します。 独自のレイヤーに定義された地物は対象外となります

Returns:

{Array} Featureの配列

• {InfoWindow}getInfoWindow()
  現在表示している情報ウィンドウを返します。

Returns:

{InfoWindow} 情報ウィンドウ

• {LayerSet}getLayerSet(id)
  指定したレイヤーセットIDで地図に登録されているレイヤーセットを返します。

Parameters:

{String} id

レイヤーセットID

Returns:

{LayerSet}

• {Array of LayerSet}getLayerSets()
  地図に登録されているすべてのレイヤーセットを配列で返します。

Returns:

{Array of LayerSet} レイヤーセットの配列

• {Node}getMapContainer()
  地図が描画されているDOMオブジェクトを返します。

Returns:

{Node}

• {Number}getMaxZoom()
  利用可能なズームレベルの数を返します。 現在設定されているレイヤーセットのズームレベル数に依存します。

Returns:

{Number} ズームレベル数

• getPlugin(name)
  プラグインを取得します。

Parameters:

{String} name

取得するプラグインの名前

• {Projection}getProjection()
  現在の地図に関連付けられているProjectionを返します。

Returns:

{Projection} 投影変換

• {Size}getSize()
  マップコンテナのサイズをピクセル単位で取得します。

Returns:

{Size}

• {Layer}getSystemLayer()
  地図のシステムレイヤーが返されます。

Returns:

{Layer} システムレイヤー

• {Number}getZoom()
  地図に設定されたズームレベルを返します。

Returns:

{Number}

• {Boolean}isInfoWindowOpen()
  情報ウィンドウが開いているかどうかを返します。

Returns:

{Boolean}

• {Boolean}isLoaded()
  地図の作成後にdrawMapによって初期化された場合に、trueを返します。

Returns:

{Boolean}

• {InfoWindow}openInfoWindow(latlng, content, infoWindowOptions, offset)
  指定された地点に情報ウィンドウを表示します。 表示位置には、緯度経度座標もしくはピクセル座標を指定できます。 コンテンツには、HTML文字列、Contentオブジェクト、DOMノードのいずれかを指定できます。

Parameters:

{LatLng} latlng

ウィンドウを表示する緯度経度座標もしくはピクセル座標

{String|Node} content

ウィンドウ内に表示するコンテンツ

{Object} infoWindowOptions

ウィンドウ表示のためのオプション。詳細はInfoWindowを参照

{Size} offset

ウィンドウ表示する緯度経度に対するオフセット値

Returns:

{InfoWindow} 表示される情報ウィンドウ

• panBy(distance, animation)
  指定されたピクセルサイズ分地図を移動します。 引数は変数名と同じ名前のキーを持つオブジェクトでも指定できます。

 // アニメーション無しで地図を移動します。どちらの呼び出し形式でも同じ結果になります。
 map.panBy(new Y.Size(50, 30), false);
 map.panBy({
     "distance": new Y.Size(50, 30), 
     "animation": false
 });

Parameters:

{Size} distance

移動距離

{Boolean} animation Optional

アニメーション処理の有無

• panDirection(dx, dy, animation)
  指定された方向に画面分だけ地図を移動します。 引数は変数名と同じ名前のキーを持つオブジェクトでも指定できます。

 // アニメーション無しで地図を移動します。どちらの呼び出し形式でも同じ結果になります。
 map.panDirection(-0.5, -1.0, false);
 map.panDirection({
     "dx": -0.5,
     "dy": -1.0, 
     "animation": false
 });

Parameters:

{Number} dx

x方向移動距離

{Number} dy

y方向移動距離

{Boolean} animation Optional

アニメーション処理の有無

• panTo(center, animation)
  地図の中心を指定された地点に変更します。 引数は変数名と同じ名前のキーを持つオブジェクトでも指定できます。

 // アニメーション有りで地図を移動します。どちらの呼び出し形式でも同じ結果になります。
 map.panTo(new Y.LatLng(35.68138372459195, 139.76608415039746), true);
 map.panTo({
     "center": new Y.LatLng(35.68138372459195, 139.76608415039746), 
     "animation": true
 });

Parameters:

{LatLng} center

中心点緯度経度

{Boolean} animation Optional

アニメーション処理の有無

• redraw(force)
  地図の状態を変更せずに再描画します。

Parameters:

{Boolean} force

座標情報の変更を通知

• removeControl(control)
  地図からコントロールを削除します。

Parameters:

{Control} control

削除対象となるコントロール

• removeFeature(feature)
  地図から地物を削除します。

Parameters:

{Feature} feature

地物

• removeLayer(layer)
  地図からレイヤーを削除します。 地図に登録されているすべてのレイヤーセットからレイヤーを削除します。

Parameters:

{Layer} layer

削除するレイヤー

• removeLayerSet(id)
  地図からレイヤーセットを削除します。

Parameters:

{String} id

レイヤーセットID

• removePlugin(plugin)
  プラグインを削除します。

Parameters:

{Plugin} plugin

削除するプラグイン

• setApplicationId(appId)
  JavaScriptマップAPIが外部APIと通信する際に使われるアプリケーションIDを設定します

Parameters:

{String} appId

アプリケーションID

• setConfigure(name, value)
  地図動作の設定を行います。
  設定内容は、MapConfigureを参照してください。

Parameters:

{String} name

設定名

{Boolean} value

設定内容

• setConfigures(configures)
  地図動作のための各種設定を行います。

Parameters:

{MapConfigure} configures

設定内容

• setLayerSetId(id, redraw)
  新しいレイヤーセットIDを選択します。 LayerSetはAddLayerSetで地図に追加されている必要があります。

Parameters:

{String} id

レイヤーセットID

{Boolean} redraw Optional

地図再描画の有無

• setZoom(zoom, animation, latlng, center)
  ズームレベルを指定した新しい値に設定します。 引数は変数名と同じ名前のキーを持つオブジェクトでも指定できます。

 // 地図のズームレベルを変更します。どちらの呼び出し形式でも同じ結果になります。
 map.setZoom(8, true);
 map.setZoom({
     "zoom": 8,
     "animation": true
 });

Parameters:

{Number} zoom

ズームレベル

{Boolean} animation Optional

trueの時、ズーム時にアニメーション処理を行う

{LatLng} latlng Optional

ズームの基準としたい位置を指定します

{Boolean} center Optional

trueの時、引数latlngで指定した基準位置をズーム後の中心点とします

• unbind(listener)
  地図オブジェクトに設定されたイベントを解除します。

Parameters:

{EventListener} listener

解除するイベントリスナー

• updateSize()
  地図を表示する html 要素のサイズが変化したときに、ユーザは Map.updateSize() を実行する必要があります。

• zoomIn(latlng, animation, center)
  ズームレベルを一つ上げます。latlngが指定されている場合、ズーム後にlatlngが画面内に含まれるようにズームを変更します。 centerがtrueの場合、latlngの位置が中心点となるようにズームを変更します。 引数は変数名と同じ名前のキーを持つオブジェクトでも指定できます。

 // アニメーション無しでズームレベルを上げて地図を移動します。どちらの呼び出し形式でも同じ結果になります。
 map.zoomIn(new Y.LatLng(35.677944594323826, 139.76690088304304), false, true);
 map.zoomIn({
     "latlng": new Y.LatLng(35.677944594323826, 139.76690088304304), 
     "animation": false, 
     "center": true
 });

Parameters:

{LatLng} latlng Optional

ズームの基点となる緯度経度

{Boolean} animation Optional

ズーム時にアニメーション処理

{Boolean} center Optional

ズームとともに中心点をlatlngの位置へ移動

• zoomOut(latlng, animation, center)
  ズームレベルを一つ下げます。latlngが指定されている場合、ズーム後にlatlngが画面内に含まれるようにズームを変更します。 centerがtrueの場合、latlngの位置が中心点となるようにズームを変更します。 引数は変数名と同じ名前のキーを持つオブジェクトでも指定できます。

 // アニメーション無しでズームレベルを下げて地図を移動します。どちらの呼び出し形式でも同じ結果になります。
 map.zoomOut(new LatLng(35.680641878494455, 139.76912041100363), false, true);
 map.zoomOut({
     "latlng": new LatLng(35.680641878494455, 139.76912041100363), 
     "animation": false, 
     "center": true
 });

Parameters:

{LatLng} latlng Optional

ズームの基点となる緯度経度

{Boolean} animation Optional

ズーム時にアニメーション処理

{Boolean} center Optional

ズームとともに中心点をlatlngの位置へ移動

Event Detail

• addlayerset(layerset)
  地図にレイヤーセットが追加されたときに発生します。

Parameters:

{LayerSet} layerset

追加されたLayerSet

• click(latlng)
  地図をマウスでクリックすると発生します。

  map.bind( "click" , function( latlng ) {
    alert(latlng.lat()  + "," + latlng.lng() );
  } );

Parameters:

{LatLng} latlng

クリックされた地理座標

• dblclick(latlng)
  地図をマウスでダブルクリックすると発生します。

Parameters:

{LatLng} latlng

ダブルクリックされた地理座標

• layersetchanged(newLayerSet, oldLayerSet)
  地図のレイヤーセットが変更されたときに発生します。

  map.bind( "layersetchanged" ,  function( newLayerSet , oldLayerSet ) {
    alert( oldLayerSet.getName() + "から" +
      newLayerSet.getName() + "へ変更しました。" );
  } );

Parameters:

{LayerSet} newLayerSet

変更後のLayerSet

{LayerSet} oldLayerSet

変更前のLayerSet

• load()
  地図の初期化が完了したときに発生します。

• moveend()
  地図の移動が終了したときに発生します。

• movestart()
  地図の移動が開始されるときに発生します。

• removelayerset(layerset)
  地図からレイヤーセットが削除されたときに発生します。

Parameters:

{LayerSet} layerset

削除されたLayerSet

• zoomend()
  地図のズーム変更が終了したときに発生します。

• zoomstart()
  地図のズーム変更を開始したときに発生します。

このページのトップへ

Namespace Map.TYPE

地図のタイプ

Namespace Summary

Field Summary

Field Detail

• <static> <constant> {String}Map.TYPE.SMARTPHONE
  スマートフォン用地図

      //スマートフォン用地図を指定する。
      map = new Y.Map("map",{
       configure : {
        mapType : Y.Map.TYPE.SMARTPHONE
       }
      });
      //または、Map.setConfigureでスマートフォン用地図を指定する。
      map.setConfigure('mapType', Y.Map.TYPE.SMARTPHONE);
      ※スマートフォンの場合デフォルトはこのタイプになります。

• <static> <constant> {String}Map.TYPE.STANDARD
  PC用地図

      //PC用地図を指定する。
      map = new Y.Map("map",{
       configure : {
        mapType : Y.Map.TYPE.STANDARD
       }
      });
      //または、Map.setConfigureでPC用地図を指定する。
      map.setConfigure('mapType', Y.Map.TYPE.STANDARD);
      ※PCの場合デフォルトはこのタイプになります。

このページのトップへ