YOLP(地図)

Pluginクラス

Plugin クラス

クラス一覧へ

Class Plugin

プラグイン

Class Summary

属性 クラス名と説明
 
地図機能を拡張するプラグインのインターフェースです。

Method Summary

属性 メソッド名と説明
 
プラグインの名称を返します。
 
load()
プラグインを開始するための処理を実装します。この処理はMap.addPluginから呼び出されます。
 
プラグインを終了するための処理を実装します。この処理はMap.removePluginから呼び出されます。

Class Detail

  • Plugin()
    地図機能を拡張するプラグインのインターフェースです。

Method Detail

  • getName()
    プラグインの名称を返します。
  • load()
    プラグインを開始するための処理を実装します。 この処理はMap.addPluginから呼び出されます。
  • unload()
    プラグインを終了するための処理を実装します。 この処理はMap.removePluginから呼び出されます。



Class KeyOperationPlugin

キー操作プラグイン

Class Summary

属性 クラス名と説明
 
キーによる地図操作をサポートするプラグインです。
このプラグインをMapクラスに追加すると、キーボード入力イベントを監視して、地図のスクロールと縮尺の変更をサポートします。
←↑→↓キー:地図のスクロール。
PageUpキー:1つ広域の縮尺に変更。
PageDownキー:1つ詳細な縮尺に変更。
Pluginクラスを継承しています。

Method Summary

属性 メソッド名と説明
 
現在のプラグインの有効/無効設定を取得します。
 
プラグイン名称を取得します。
 
load(map)
プラグインのロードを行ないます。
 
setEnable(enable)
プラグインの有効/無効を設定します。
 
プラグインのアンロードを行ないます。

Class Detail

  • KeyOperationPlugin(configs)
    キーによる地図操作をサポートするプラグインです。
    このプラグインをMapクラスに追加すると、キーボード入力イベントを監視して、地図のスクロールと縮尺の変更をサポートします。
    ←↑→↓キー:地図のスクロール。
    PageUpキー:1つ広域の縮尺に変更。
    PageDownキー:1つ詳細な縮尺に変更。
//地図オブジェクトをキー操作可能にする
map.addPlugin(new Y.KeyOperationPlugin());
Parameters:
{Object} configs
無効にするキー操作
{Boolean} noScrollKey
←↑→↓キーによるスクロールを無効にします(未指定時:有効)。
{Boolean} noZoomKey
PageUpキー, PageDownキーによる縮尺変更を無効にします(未指定時:有効)。

Method Detail

  • {Boolean}getEnable()
    現在のプラグインの有効/無効設定を取得します。
    Returns:
    {Boolean} 有効(true)/無効(false)
  • {String}getName()
    プラグイン名称を取得します。
    Returns:
    {String} 名称
  • load(map)
    プラグインのロードを行ないます。
    Parameters:
    {Object} map
    Y.Mapオブジェクト
  • setEnable(enable)
    プラグインの有効/無効を設定します。
    Parameters:
    {Boolean} enable
    有効(true)/無効(false)
  • unload()
    プラグインのアンロードを行ないます。



Class MapAnnotationPlugin

注記クリックプラグイン

Class Summary

属性 クラス名と説明
 
地図上のクリック位置に最も近い注記情報を返すプラグインです。
Pluginクラスを継承しています。

Method Summary

属性 メソッド名と説明
 
現在のプラグインの有効/無効設定を取得します。
 
プラグイン名称を取得します。
 
load(map)
プラグインのロードを行います。
 
setEnable(enable)
プラグインの有効/無効を設定します。
 
プラグインのアンロードを行います。

Class Detail

  • MapAnnotationPlugin(configs)
    地図上のクリック位置に最も近い注記情報を返すプラグインです。
//クリックされた注記の名称をアラートします。
var configs = {
    "match": function(annotation) {
        alert(annotation.name + "がクリックされました。");
    }
};
map.addPlugin(new Y.MapAnnotationPlugin(configs));
Parameters:
{Object} configs
プラグイン設定
{Function} match
クリック位置が特定の注記にマッチした際にコールバックされる関数オブジェクトを指定します(必須)。
コールバック時に次のようなキーを持つオブジェクトが引数で渡されます。
{
  "type"        : 注記種別(String)
                  'icon': アイコン注記、 'text': 文字列注記
  "label"       : 文字列注記だったときの文字列(String)
  "name"        : 注記の名称(String)
  "angle"       : 注記の回転角(Number)
  "vertical"    : 文字列注記の縦書きフラグ(Boolean)
  "clickLatLng" : クリックされた地理座標(Y.LatLng)
  "centerLatLng": 注記の中心地理座標(Y.LatLng)
  "latLngBounds": 注記を含める範囲の地理座標矩形(Y.LatLngBounds)
                  傾きがある(angleが0でない)場合、注記全体を覆う矩形を示す
  "size"        : コールバック時の縮尺における注記のスクリーン上のサイズ(Y.Size)
                  キー"latLngBounds"で表現される矩形と一致する
}
  
{Function} noMatch
クリック位置にマッチする注記がなかった際にコールバックされる関数オブジェクトを指定します。
{Function} error
注記情報取得時にエラーとなった際にコールバックされる関数オブジェクトを指定します。
{Number} threshold
クリック位置が注記から指定されたピクセル分離れていても注記にマッチしているものとして許容される閾値をピクセル単位で指定します。
未指定時は16が設定されます。
{Object} object
コールバック用関数オブジェクトを実行する際にthisとして扱われるオブジェクトを指定します。
未指定時はwindow(グローバルスコープ)が設定されます。

Method Detail

  • {Boolean}getEnable()
    現在のプラグインの有効/無効設定を取得します。
    Returns:
    {Boolean} 有効(true)/無効(false)
  • {String}getName()
    プラグイン名称を取得します。
    Returns:
    {String} 名称
  • load(map)
    プラグインのロードを行います。
    Parameters:
    {Object} map
    Y.Mapオブジェクト
  • setEnable(enable)
    プラグインの有効/無効を設定します。
    Parameters:
    {Boolean} enable
    有効(true)/無効(false)
  • unload()
    プラグインのアンロードを行います。



Class RouteSearchPlugin

経路探索プラグイン

Class Summary

属性 クラス名と説明
 
地図上の地点間の経路を探索して表示するプラグインです。
※長距離の経路は探索できない場合があります。地点間の総直線距離で1000kmまで設定 できます。
Pluginクラスを継承しています。

Method Summary

属性 メソッド名と説明
 
現在設定されている経路探索のオプションを取得します。
RouteSearchLayer.execute(latlngs,configs)のconfigs.paramsに設定できるハッシュを返します。
 
現在設定されている地点の緯度経度列を取得します。
RouteSearchLayer.execute(latlngs,configs)のlatlngsに設定できる配列を返します。
 
現在のプラグインの有効/無効設定を取得します。
 
プラグイン名称を取得します。
 
load(map)
プラグインのロードを行います。
 
setEnable(enable)
プラグインの有効/無効を設定します。
 
プラグインのアンロードを行います。

Class Detail

  • RouteSearchPlugin(configs)
    地図上の地点間の経路を探索して表示するプラグインです。
    ※長距離の経路は探索できない場合があります。地点間の総直線距離で1000kmまで設定できます。
    Parameters:
    {Object} configs
    プラグイン設定
    {Array} latlngs
    緯度経度配列です。
    プラグインのロード時に、この地点間の経路を探索し地図に表示します。
    {Style} strokeStyle
    経路探索結果のポリラインの線のスタイルを指定します。
    {Boolean} enableVia
    経由点を指定できるかどうかを指定します。デフォルトはtrueです。
    {Number} maxVia
    指定できる経由点の点数を指定します。
    無制限の場合は「0」を指定します。デフォルトは「0」です。

Method Detail

  • {Object}getCurrentParams()
    現在設定されている経路探索のオプションを取得します。
    RouteSearchLayer.execute(latlngs,configs)のconfigs.paramsに設定できるハッシュを返します。
    Returns:
    {Object} 経路探索のオプション
  • {Array}getCurrentPoints()
    現在設定されている地点の緯度経度列を取得します。
    RouteSearchLayer.execute(latlngs,configs)のlatlngsに設定できる配列を返します。
    Returns:
    {Array} 緯度経度列
  • {Boolean}getEnable()
    現在のプラグインの有効/無効設定を取得します。
    Returns:
    {Boolean} 有効(true)/無効(false)
  • {String}getName()
    プラグイン名称を取得します。
    Returns:
    {String} 名称
  • load(map)
    プラグインのロードを行います。
    Parameters:
    {Object} map
    Y.Mapオブジェクト
  • setEnable(enable)
    プラグインの有効/無効を設定します。
    Parameters:
    {Boolean} enable
    有効(true)/無効(false)
  • unload()
    プラグインのアンロードを行います。



Class GeoXmlPlugin

GeoXml切り替えプラグイン

Class Summary

属性 クラス名と説明
 
GeoXmlPlugin(url, options)
GeoXml用のプラグインです(アイコン⇔ヒートマップの表示を切り替えできます)。

Method Summary

属性 メソッド名と説明
 
現在選択されているレイヤーを取得します。
 
プラグイン名称を取得します。
 
load(map)
プラグインのロードを行います。
 
プラグインのアンロードを行います。

Class Detail

  • GeoXmlPlugin(url, options)
    GeoXml用のプラグインです(アイコン⇔ヒートマップの表示を切り替えできます)。
    Parameters:
    {String} url
    YDF、GeoRSS、KMLのURL
    {Object} options
    オプションオブジェクト
    {Boolean}heat
    true:ヒートマップデフォルト表示、false:ヒートマップデフォルト非表示

Method Detail

  • {Layer}getCurrentLayer()
    現在選択されているレイヤーを取得します。
    Returns:
    {Layer} 現在選択されているレイヤー
  • {String}getName()
    プラグイン名称を取得します。
    Returns:
    {String} 名称
  • load(map)
    プラグインのロードを行います。
    Parameters:
    {Object} map
    Y.Mapオブジェクト
  • unload()
    プラグインのアンロードを行います。



Class ListingTabPlugin

リスティング切り替えタブプラグイン

Class Summary

属性 クラス名と説明
 
リスティングレイヤーのタブ切り替え用プラグインです。

Method Summary

属性 メソッド名と説明
 
changeLayer(layeridx)
指定したレイヤーをアクティブにします。
 
現在選択されているレイヤーを取得します。
 
プラグイン名称を取得します。
 
load(map)
プラグインのロードを行います。
 
shortName(name, length)
カセット名を短縮させる
 
切り替えタブを表示します。
 
プラグインのアンロードを行います。

Class Detail

  • ListingTabPlugin(params)
    リスティングレイヤーのタブ切り替え用プラグインです。
    Parameters:
    {Object} params
    {Array} layers
    リスティングレイヤーオブジェクトListingLayerの配列
    {List} list
    リストオブジェクトListing
    {String} tab
    タブ表示用ターゲットID文字列

Method Detail

  • changeLayer(layeridx)
    指定したレイヤーをアクティブにします。
    Parameters:
    {Number} layeridx
    レイヤー番号
  • {Layer}getCurrentLayer()
    現在選択されているレイヤーを取得します。
    Returns:
    {Layer} 現在選択されているレイヤー
  • {String}getName()
    プラグイン名称を取得します。
    Returns:
    {String} 名称
  • load(map)
    プラグインのロードを行います。
    Parameters:
    {Object} map
    Y.Mapオブジェクト
  • shortName(name, length)
    カセット名を短縮させる
    Parameters:
    name
    length
  • showTab()
    切り替えタブを表示します。
  • unload()
    プラグインのアンロードを行います。