YOLP(地図)

Layerクラス

Layer クラス

クラス一覧へ

Class Layer

レイヤー

Class Summary

属性 クラス名と説明
 
Layer(name, options)
地図上に表示されるレイヤーのインターフェースです。

Method Summary

属性 メソッド名と説明
 
bind(type, function, object)
レイヤーオブジェクトが通知するイベントに対してイベントハンドラを設定します。
 
drawLayer(force)
レイヤーを描画します。拡張クラスで実装されます。
 
コンテナ座標を地理座標へ変換します。
 
Div座標を地理座標へ変換します。
 
fromLatLngsToDivPixels(latlngs, offset)
地理座標列をDiv座標列へ変換します。
 
地理座標をコンテナ座標へ変換します。
 
地理座標をDiv座標へ変換します。
 
地理座標をタイル座標へ変換します。
 
fromTileToLatLng(tx, ty, x, y)
タイル座標を地理座標へ変換します。
 
レイヤーを描画するコンテナを返します。
 
コピーライトの集合を返します。
 
レイヤーが関連付けられているMapを返します。
 
レイヤーが関連付けられているMapのコンテナを返します。
 
レイヤー名を返します。
 
レイヤーが地物を扱い、かつ地物を1つ以上所有しているかを返します。
 
レイヤーが描画済みかどうかを返します。
 
レイヤーが初期化済みかどうかを返します。
 
レイヤーがシステムレイヤーとして初期化されたかどうかを返します。
 
setName(name)
レイヤー名を設定します。
 
unbind(listener)
このレイヤーに設定されたイベントを解除します。

Class Detail

  • Layer(name, options)
    地図上に表示されるレイヤーのインターフェースです。
    Parameters:
    {String} name
    レイヤー名
    {Object} options
    オプション

Method Detail

  • {EventListener}bind(type, function, object)
    レイヤーオブジェクトが通知するイベントに対してイベントハンドラを設定します。
    Parameters:
    {String} type
    イベント名
    {Function} function
    イベント発生時に呼び出されるイベントハンドラ
    {Object} object Optional
    設定したイベントハンドラ内でthisとして評価されるオブジェクト
    省略時はレイヤーオブジェクト自身をthisとして評価
    Returns:
    {EventListener}
  • drawLayer(force)
    レイヤーを描画します。拡張クラスで実装されます。
    Parameters:
    force
  • fromContainerPixelToLatLng(v)
    コンテナ座標を地理座標へ変換します。
    Parameters:
    v
  • fromDivPixelToLatLng(p)
    Div座標を地理座標へ変換します。
    Parameters:
    p
  • {Array}fromLatLngsToDivPixels(latlngs, offset)
    地理座標列をDiv座標列へ変換します。
    Parameters:
    {Array} latlngs
    Y.LatLngオブジェクトの配列
    {Point} offset
    オフセットが必要な場合のオプション引数
    Returns:
    {Array}
  • fromLatLngToContainerPixel(g)
    地理座標をコンテナ座標へ変換します。
    Parameters:
    g
  • fromLatLngToDivPixel(g)
    地理座標をDiv座標へ変換します。
    Parameters:
    g
  • fromLatLngToTile(g)
    地理座標をタイル座標へ変換します。
    Parameters:
    g
  • fromTileToLatLng(tx, ty, x, y)
    タイル座標を地理座標へ変換します。
    Parameters:
    tx
    ty
    x
    y
  • {Node}getContainer()
    レイヤーを描画するコンテナを返します。
    Returns:
    {Node} レイヤーコンテナ
  • {CopyrightCollection}getCopyrightCollection()
    コピーライトの集合を返します。
    Returns:
    {CopyrightCollection} コピーライトの集合
  • {Map}getMap()
    レイヤーが関連付けられているMapを返します。
    Returns:
    {Map} Map
  • {Node}getMapContainer()
    レイヤーが関連付けられているMapのコンテナを返します。
    Returns:
    {Node} マップコンテナ
  • {String}getName()
    レイヤー名を返します。
    Returns:
    {String} レイヤー名
  • {Boolean}hasFeature()
    レイヤーが地物を扱い、 かつ地物を1つ以上所有しているかを返します。
    Returns:
    {Boolean}
  • {Boolean}isDrawn()
    レイヤーが描画済みかどうかを返します。
    Returns:
    {Boolean}
  • {Boolean}isInitialized()
    レイヤーが初期化済みかどうかを返します。
    Returns:
    {Boolean}
  • {Boolean}isSystemLayer()
    レイヤーがシステムレイヤーとして初期化されたかどうかを返します。
    Returns:
    {Boolean}
  • setName(name)
    レイヤー名を設定します。
    Parameters:
    {String} name
  • unbind(listener)
    このレイヤーに設定されたイベントを解除します。
    Parameters:
    {EventListener} listener
    解除するイベントリスナー

Class LayerSet

LayerSet レイヤーの集合

Class Summary

属性 クラス名と説明
 
LayerSet(name, layers, options)
複数のレイヤーから構成されるレイヤーの集合を表します。

Method Summary

属性 メソッド名と説明
 
addLayer(layer)
レイヤーを追加します。
 
レイヤーコンテナの順序をaddLayer()された順番に補正します。
 
レイヤーセットが利用可能かどうかを返します。
 
レイヤーセットの表示名称を返します。
 
すべてのレイヤー配列を取得します。
 
利用可能な最大ズームレベルを返します。
 
利用可能な最小ズームレベルを返します。
 
レイヤーセットの名称を返します。
 
remove(exclude)
地図からレイヤーセットを取り除きます。
 
removeLayer(layer)
レイヤーを削除します。
 
setEnable(value)
レイヤーセットが利用可能かどうかを設定します。
 
setMaxZoom(zoomLevel)
レイヤーセットの最大ズームレベルを再設定します。
 
setMinZoom(zoomLevel)
レイヤーセットの最小ズームレベルを再設定します。

Class Detail

  • LayerSet(name, layers, options)
    複数のレイヤーから構成されるレイヤーの集合を表します。
    Parameters:
    {String} name
    レイヤー名
    {Array} layers
    Layerの配列
    {Object} optionsOptional
    オプション
    {Number} maxZoom
    最大ズームレベル
    {Number} minZoom
    最小ズームレベル
    {Projection} projection
    地理座標とタイル座標の投影変換を行うProjectionを指定できます。デフォルトは、MercatorProjectionです。

Method Detail

  • addLayer(layer)
    レイヤーを追加します。
    Parameters:
    layer
  • adjustLayerOrder()
    レイヤーコンテナの順序をaddLayer()された順番に補正します。
  • {Boolean}getEnable()
    レイヤーセットが利用可能かどうかを返します。
    Returns:
    {Boolean}
  • {String}getFullName()
    レイヤーセットの表示名称を返します。
    Returns:
    {String} 表示名
  • {Array}getLayers()
    すべてのレイヤー配列を取得します。
    Returns:
    {Array}
  • {Number}getMaxZoom()
    利用可能な最大ズームレベルを返します。
    Returns:
    {Number} ズームレベル
  • {Number}getMinZoom()
    利用可能な最小ズームレベルを返します。
    Returns:
    {Number} ズームレベル
  • {String}getName()
    レイヤーセットの名称を返します。
    Returns:
    {String} 名前
  • remove(exclude)
    地図からレイヤーセットを取り除きます。
    Parameters:
    {LayerSet} exclude Optional
    削除対象外となるレイヤセットを指定
  • removeLayer(layer)
    レイヤーを削除します。
    Parameters:
    layer
  • {Boolean}setEnable(value)
    レイヤーセットが利用可能かどうかを設定します。
    Parameters:
    value
    Returns:
    {Boolean}
  • setMaxZoom(zoomLevel)
    レイヤーセットの最大ズームレベルを再設定します。
    Parameters:
    {Number} zoomLevel
    ズームレベル
  • setMinZoom(zoomLevel)
    レイヤーセットの最小ズームレベルを再設定します。
    Parameters:
    {Number} zoomLevel
    ズームレベル

コピーライト

Class Summary

属性 クラス名と説明
 
Copyright(id, bounds, minZoom, text)
著作権情報を表します。

Class Detail

  • Copyright(id, bounds, minZoom, text)
    著作権情報を表します。
    Parameters:
    {String} id
    {LatLngBounds} bounds
    マップ領域
    {Number} minZoom
    最小ズームレベル
    {String} text
    コピーライト文字列

Class CopyrightCollection

コピーライトの集合

Class Summary

属性 クラス名と説明
 
CopyrightCollection(prefix, options)
複数のコピーライトから構成されるコピーライトの集合を表します。

Method Summary

属性 メソッド名と説明
 
addCopyright(copyright)
コレクションに著作権情報オブジェクトを追加します。
 
getCopyrightNotice(bounds, zoom)
指定されたズームレベルで指定されたマップ領域に関連するプレフィックスと、該当する著作権文字列をすべて返します。
 
getCopyrights(bounds, zoom)
指定されたズームレベルで指定されたマップ領域に関連する著作権文字列をすべて返します。
 
setPrefix(prefix)
プレフィックスを設定する。

Class Detail

  • CopyrightCollection(prefix, options)
    複数のコピーライトから構成されるコピーライトの集合を表します。
    Parameters:
    {String} prefixOptional
    プレフィックス
    {Object} optionsOptional
    オプション

Method Detail

  • addCopyright(copyright)
    コレクションに著作権情報オブジェクトを追加します。
    Parameters:
    {Copyright} copyright
    コピーライトオブジェクト
  • {Array of String}getCopyrightNotice(bounds, zoom)
    指定されたズームレベルで指定されたマップ領域に関連するプレフィックスと、該当する著作権文字列をすべて返します。
    Parameters:
    {LatLngBounds} bounds
    マップ領域
    {Number} zoom
    ズームレベル
    Returns:
    {Array of String} prefix+著作権文字列
  • {Array of String}getCopyrights(bounds, zoom)
    指定されたズームレベルで指定されたマップ領域に関連する著作権文字列をすべて返します。
    Parameters:
    {LatLngBounds} bounds
    マップ領域
    {Number} zoom
    ズームレベル
    Returns:
    {Array of String} 著作権文字列
  • setPrefix(prefix)
    プレフィックスを設定する。
    Parameters:
    {String} prefix
    プレフィックス

Class FeatureLayer

地物レイヤー

Class Summary

属性 クラス名と説明
 
地物を追加可能なレイヤーです。
Layerクラスを継承しています。

Method Summary

属性 メソッド名と説明
 
addFeature(feature)
地物をレイヤーに追加します。
 
addFeatures(features)
複数の地物をレイヤーへ一度に追加します。
 
レイヤーに含まれるすべての地物を削除します。
 
レイヤーに含まれるすべての地物を取得します。
 
レイヤー上に追加されている地物が全て地図上に収まる最適な地理座標範囲を返します。
 
Layer.hasFeatureのオーバーライドです。
 
removeFeature(feature, redraw)
地物をレイヤーから削除します。
Layerから継承した関数:
bind, drawLayer, fromContainerPixelToLatLng, fromDivPixelToLatLng, fromLatLngsToDivPixels, fromLatLngToContainerPixel, fromLatLngToDivPixel, fromLatLngToTile, fromTileToLatLng, getContainer, getCopyrightCollection, getMap, getMapContainer, getName, isDrawn, isInitialized, isSystemLayer, setName, unbind

Class Detail

  • FeatureLayer()
    地物を追加可能なレイヤーです。

Method Detail

  • addFeature(feature)
    地物をレイヤーに追加します。
    Parameters:
    {Feature} feature
    追加する地物
  • addFeatures(features)
    複数の地物をレイヤーへ一度に追加します。
    Parameters:
    {ArrayOfFeature} features
    追加する地物の配列
  • clearFeatures()
    レイヤーに含まれるすべての地物を削除します。
  • {Array}getFeatures()
    レイヤーに含まれるすべての地物を取得します。
    Returns:
    {Array} features 地物の配列
  • {LatLngBounds}getSuitedBounds()
    レイヤー上に追加されている地物が全て地図上に収まる最適な地理座標範囲を返します。
    Returns:
    {LatLngBounds} 地理座標範囲
  • {Boolean}hasFeature()
    Layer.hasFeatureのオーバーライドです。
    Returns:
    {Boolean} 1つ以上の地物を持っているとき, trueを返す
  • removeFeature(feature, redraw)
    地物をレイヤーから削除します。
    Parameters:
    {Feature} feature
    削除する地物
    redraw

Class TileLayer

タイルレイヤ

Class Summary

属性 クラス名と説明
 
タイル形式に表示可能なレイヤー
Layerクラスを継承しています。
Layerから継承した関数:
bind, drawLayer, fromContainerPixelToLatLng, fromDivPixelToLatLng, fromLatLngsToDivPixels, fromLatLngToContainerPixel, fromLatLngToDivPixel, fromLatLngToTile, fromTileToLatLng, getContainer, getCopyrightCollection, getMap, getMapContainer, getName, hasFeature, isDrawn, isInitialized, isSystemLayer, setName, unbind

Class Detail

  • TileLayer()
    タイル形式に表示可能なレイヤー

Class ImageTileLayer

タイル画像レイヤー

Class Summary

属性 クラス名と説明
 
画像をタイル形式で表示します。
TileLayerクラスを継承しています。

Method Summary

属性 メソッド名と説明
 
getImageSrc(x, y, z)
タイル1枚分の画像URLを返します。
 
setOpacity(opacity)
タイル画像の透過度を設定します。
Layerから継承した関数:
bind, drawLayer, fromContainerPixelToLatLng, fromDivPixelToLatLng, fromLatLngsToDivPixels, fromLatLngToContainerPixel, fromLatLngToDivPixel, fromLatLngToTile, fromTileToLatLng, getContainer, getCopyrightCollection, getMap, getMapContainer, getName, hasFeature, isDrawn, isInitialized, isSystemLayer, setName, unbind

Class Detail

  • ImageTileLayer()
    画像をタイル形式で表示します。

Method Detail

  • getImageSrc(x, y, z)
    タイル1枚分の画像URLを返します。
    Parameters:
    {Number} x
    タイルx座標
    {Number} y
    タイルy座標
    {Number} z
    ズーム
  • setOpacity(opacity)
    タイル画像の透過度を設定します。
    Parameters:
    {Number} opacity
    0.0 - 1.0

Class ListingLayer

リスティングレイヤー

Class Summary

属性 クラス名と説明
 
ListingLayer(api, options)
リスティング表示可能なデータを保持するレイヤーです。
FeatureLayerクラスを継承しています。

Method Summary

属性 メソッド名と説明
 
bind(type, function, object)
リスティングレイヤーに対してイベントを設定します。
 
リスト下部フッタ部分のHTMLを構築します。独自のHTMLを作成したい場合には、このメソッドをオーバーライドしてください。
 
リスト上部ヘッダ部分のHTMLを構築します。独自のHTMLを作成したい場合には、このメソッドをオーバーライドしてください。
 
アイテムの吹きだし内に表示するHTMLを作成します。独自のHTMLを作成したい場合には、このメソッドをオーバーライドしてください。
 
アイテムの吹きだしが最大化されたときに表示するHTMLを作成します。独自のHTMLを作成したい場合には、このメソッドをオーバーライドしてください。
 
createItemHtml(index, item)
リスト内、項目一つ分のHTMLを構築します。独自のHTMLを作成したい場合には、このメソッドをオーバーライドしてください。
 
createListHtml(ydf, query, options)
リスト部分のHTMLを構築します。既定の動作では,このメソッドが作成した要素を親要素としてcreateItemHtmlで作成された要素が子要素としてappendされます。独自のHTMLを作成したいときには、このメソッドをオーバーライドしてください。
 
createNoMatchHtml(ydf, query, options)
ノーマッチ時のHTMLを作成します。独自のHTMLを作成したい場合には、このメソッドをオーバーライドしてください。
 
createResultHtml(ydf, query, options)
リスト表示のための全HTMLを構築します。独自のHTMLを構築したい場合には、このメソッドをオーバーライドしてください。
 
drawPage(page)
現在の検索結果リストの別ページを表示します。
 
execute(request, callback, error)
リクエストを実行し、レイヤーの内容を表示します。
 
リスト内容に合わせて、地図の範囲を変更します。
 
getApiRequest(query, options)
リスティングレイヤーに関連付けられたAPIを呼び出すときに使用するパラメータを生成します。
 
リスティングレイヤーに関連付けられたAPIのURLを返します。
 
現在のページ番号を返します。
 
getCustomIcon(index, item)
地図およびリストに表示されるアイコンに独自のカスタムアイコンを設定します。カスタムアイコンを設定する場合には、このメソッドをオーバーライドしてください。
 
getCustomStyle(index, item)
地図上に表示される地物に独自のカスタムスタイルを適用します。カスタムスタイルを設定する場合には、このメソッドをオーバーライドしてください。
 
リストが保持するページ数を返します。
 
リスティングレイヤーに関連付けられた表示結果を返します。
 
検索結果に合わせて、地図を自動で移動するかどうかを返します。
 
地図の移動に合わせてリストを自動更新するかどうかを返します。
 
吹きだし表示を有効にするかをどうかを返します。
 
search(query, options, callback, error)
リスティングレイヤーに関連付けられたAPIを呼び出し、検索を実行します。
 
setAutoUpdate(val, updateRate, boundsRate, callback, error)
地図の移動に合わせて、リストを自動で更新します。
FeatureLayerから継承した関数:
addFeature, addFeatures, clearFeatures, getFeatures, getSuitedBounds, hasFeature, removeFeature
Layerから継承した関数:
drawLayer, fromContainerPixelToLatLng, fromDivPixelToLatLng, fromLatLngsToDivPixels, fromLatLngToContainerPixel, fromLatLngToDivPixel, fromLatLngToTile, fromTileToLatLng, getContainer, getCopyrightCollection, getMap, getMapContainer, getName, isDrawn, isInitialized, isSystemLayer, setName, unbind

Event Summary

 
レイヤーの描画が完了したときに呼び出されます。
 
レイヤーの描画を開始するときに呼び出されます。

Class Detail

  • ListingLayer(api, options)
    リスティング表示可能なデータを保持するレイヤーです。
    Parameters:
    {String} api
    API識別子
    {Object} options
    表示オプション
    {Boolean} autoPanMap
    検索結果に合わせて、地図を自動で移動します。デフォルトはtrueです。
    {Boolean} autoUpdate
    地図の範囲に合わせて、リストを自動で更新します。autoPanMapと同時に設定することはできません。デフォルトはfalseです。
    {Boolean} infoWindowEnable
    吹きだし表示を有効にします。デフォルトはtrueです。
    {Boolean} chunk
    リストのチャンク表示を有効にします。デフォルトはfalseです。
    {Number}chunkCount
    リストのチャンク表示の件数を指定します。デフォルトは10です。

Method Detail

  • {EventListener}bind(type, function, object)
    リスティングレイヤーに対してイベントを設定します。
    Parameters:
    {String} type
    イベントタイプ
    {Function} function
    実行されるイベント関数
    {Object} object Optional
    イベントを実行するオブジェクト
    Returns:
    {EventListener}
  • {String|Node}createFooterHtml(ydf)
    リスト下部フッタ部分のHTMLを構築します。 独自のHTMLを作成したい場合には、このメソッドをオーバーライドしてください。
    Parameters:
    {Object} ydf
    作成対象となるYDF
    Returns:
    {String|Node} html 作成したHTMLコードもしくはDOMノード
  • {String|Node}createHeaderHtml(ydf)
    リスト上部ヘッダ部分のHTMLを構築します。 独自のHTMLを作成したい場合には、このメソッドをオーバーライドしてください。
    Parameters:
    {Object} ydf
    作成対象となるYDF
    Returns:
    {String|Node} html 作成したHTMLコードもしくはDOMノードn
  • createInfoWindowHtml(item)
    アイテムの吹きだし内に表示するHTMLを作成します。 独自のHTMLを作成したい場合には、このメソッドをオーバーライドしてください。
    Parameters:
    {Object} item
    対象のアイテム
  • createInfoWindowMaxContentHtml(item)
    アイテムの吹きだしが最大化されたときに表示するHTMLを作成します。 独自のHTMLを作成したい場合には、このメソッドをオーバーライドしてください。
    Parameters:
    {Object} item
    対象のアイテム
  • {String|Node}createItemHtml(index, item)
    リスト内、項目一つ分のHTMLを構築します。 独自のHTMLを作成したい場合には、このメソッドをオーバーライドしてください。
    Parameters:
    {Number} index
    アイテムのインデックス番号
    {Feature} item
    アイテム
    Returns:
    {String|Node} html 作成したHTMLコードもしくはDOMノード
  • {String|Node}createListHtml(ydf, query, options)
    リスト部分のHTMLを構築します。 既定の動作では, このメソッドが作成した要素を親要素としてcreateItemHtmlで作成された要素が子要素としてappendされます。 独自のHTMLを作成したいときには、このメソッドをオーバーライドしてください。
    Parameters:
    {Object} ydf
    作成対象となるYDF
    {String} query
    作成対象のクエリー
    {Object} options
    作成対象のAPIオプション
    Returns:
    {String|Node} html 作成したHTMLコードもしくはDOMノード
  • {String|Node}createNoMatchHtml(ydf, query, options)
    ノーマッチ時のHTMLを作成します。 独自のHTMLを作成したい場合には、このメソッドをオーバーライドしてください。
    Parameters:
    {Object} ydf
    作成対象となるYDF
    {String} query
    作成対象のクエリー
    {Object} options
    作成対象のAPIオプション
    Returns:
    {String|Node} html 作成したHTMLコードもしくはDOMノード
  • {String|Node}createResultHtml(ydf, query, options)
    リスト表示のための全HTMLを構築します。 独自のHTMLを構築したい場合には、このメソッドをオーバーライドしてください。
    Parameters:
    {Object} ydf
    作成対象となるYDF
    {String} query
    作成対象のクエリー
    {Object} options
    作成対象のAPIオプション
    Returns:
    {String|Node} html 作成したHTMLコードもしくはDOMノード
  • drawPage(page)
    現在の検索結果リストの別ページを表示します。
    Parameters:
    {Number} page
    ページ番号
  • execute(request, callback, error)
    リクエストを実行し、レイヤーの内容を表示します。
    Parameters:
    {Object} request
    API呼び出しパラメータ
    {LatLng} center
    中心位置
    {Number} dist
    検索範囲(km)。中心位置とセットで指定します。
    {LatLngBounds} bbox
    検索範囲(緯度経度指定)
    {Number} results
    取得件数。デフォルト値は10です。
    {Number} start
    開始位置。デフォルト値は1です。
    {String} detail
    出力レベル。simple,normal(デフォルト),detail
    {Object} opt
    API固有のオプションパラメータです。
    {Function} callback
    結果を受け取る関数
    {Function} error
    エラーを受け取る関数
  • fitToMap()
    リスト内容に合わせて、地図の範囲を変更します。
  • {Object}getApiRequest(query, options)
    リスティングレイヤーに関連付けられたAPIを呼び出すときに使用するパラメータを生成します。
    Parameters:
    {String} query
    {Object} options
    Returns:
    {Object}
  • {String}getApiUrl()
    リスティングレイヤーに関連付けられたAPIのURLを返します。
    Returns:
    {String} URL
  • {Number}getCurrentPage()
    現在のページ番号を返します。
    Returns:
    {Number} ページ番号
  • {Icon}getCustomIcon(index, item)
    地図およびリストに表示されるアイコンに独自のカスタムアイコンを設定します。 カスタムアイコンを設定する場合には、このメソッドをオーバーライドしてください。
    Parameters:
    {Number} index
    アイテムの表示順位
    {OBject} item
    対象のアイテム
    Returns:
    {Icon} アイコン
  • {Style}getCustomStyle(index, item)
    地図上に表示される地物に独自のカスタムスタイルを適用します。 カスタムスタイルを設定する場合には、このメソッドをオーバーライドしてください。
    Parameters:
    {Number} index
    アイテムの表示順位
    {OBject} item
    対象のアイテム
    Returns:
    {Style} style
  • {Number}getTotalPageCount()
    リストが保持するページ数を返します。
    Returns:
    {Number} ページ数
  • {Object}getYDF()
    リスティングレイヤーに関連付けられた表示結果を返します。
    Returns:
    {Object}
  • {Boolean}isAutoPanMap()
    検索結果に合わせて、地図を自動で移動するかどうかを返します。
    Returns:
    {Boolean}
  • isAutoUpdate()
    地図の移動に合わせてリストを自動更新するかどうかを返します。
  • {Boolean}isInfoWindowEnable()
    吹きだし表示を有効にするかをどうかを返します。
    Returns:
    {Boolean}
  • search(query, options, callback, error)
    リスティングレイヤーに関連付けられたAPIを呼び出し、検索を実行します。
    Parameters:
    {String} query
    {Object} options
    {Function} callback
    {Function} error
  • setAutoUpdate(val, updateRate, boundsRate, callback, error)
    地図の移動に合わせて、リストを自動で更新します。
    Parameters:
    {Boolean} val
    更新の有無
    {Number} updateRate
    更新範囲の割合: 取得済みの領域に対して、この割合をかけた領域から地図がはみ出したタイミングでリストを更新します。 デフォルト値は1.0です。
    {Number} boundsRate
    取得範囲の割合: 地図範囲に対して、この割合をかけた領域の範囲のリストを取得します。 デフォルト値は1.0です。
    callback
    error

Event Detail

  • drawend()
    レイヤーの描画が完了したときに呼び出されます。
  • drawstart()
    レイヤーの描画を開始するときに呼び出されます。

Class GeoXmlLayer

GeoXmlレイヤー

Class Summary

属性 クラス名と説明
 
YDF形式のXMLファイルを地図上に表示するレイヤーです。
ListingLayerクラスを継承しています。
ListingLayerから継承した関数:
bind, createFooterHtml, createHeaderHtml, createInfoWindowHtml, createInfoWindowMaxContentHtml, createItemHtml, createListHtml, createNoMatchHtml, createResultHtml, drawPage, execute, fitToMap, getApiRequest, getApiUrl, getCurrentPage, getCustomIcon, getCustomStyle, getTotalPageCount, getYDF, isAutoPanMap, isAutoUpdate, isInfoWindowEnable, search, setAutoUpdate
FeatureLayerから継承した関数:
addFeature, addFeatures, clearFeatures, getFeatures, getSuitedBounds, hasFeature, removeFeature
Layerから継承した関数:
drawLayer, fromContainerPixelToLatLng, fromDivPixelToLatLng, fromLatLngsToDivPixels, fromLatLngToContainerPixel, fromLatLngToDivPixel, fromLatLngToTile, fromTileToLatLng, getContainer, getCopyrightCollection, getMap, getMapContainer, getName, isDrawn, isInitialized, isSystemLayer, setName, unbind
ListingLayerから継承したイベント:
drawend, drawstart

Class Detail

  • GeoXmlLayer(url)
    YDF形式のXMLファイルを地図上に表示するレイヤーです。
     var xmlLayer = new Y.GeoXmlLayer("http://1st.geocities.jp/yjmapstaff/yolp/ydf/geoSearch.xml");
     map.addLayer( xmlLayer );
     xmlLayer.execute();
    Parameters:
    {String} url
    XML形式ファイルのURL

Class StyleMapLayer

スタイル地図レイヤー

Class Summary

属性 クラス名と説明
 
地図のスタイルをカスタマイズして表示できるレイヤーです。
ImageTileLayerクラスを継承しています。

Method Summary

属性 メソッド名と説明
 
setStyle(style, redraw)
オブジェクトの表示の有無を設定します。
ImageTileLayerから継承した関数:
getImageSrc, setOpacity
Layerから継承した関数:
bind, drawLayer, fromContainerPixelToLatLng, fromDivPixelToLatLng, fromLatLngsToDivPixels, fromLatLngToContainerPixel, fromLatLngToDivPixel, fromLatLngToTile, fromTileToLatLng, getContainer, getCopyrightCollection, getMap, getMapContainer, getName, hasFeature, isDrawn, isInitialized, isSystemLayer, setName, unbind

Class Detail

  • StyleMapLayer(base)
    地図のスタイルをカスタマイズして表示できるレイヤーです。
    Parameters:
    {String} base
    ベースの図式
    standard
    スタンダード
    vivid
    ビビッド
    bold
    ボールド
    simple
    シンプル
    monotone
    モノトーン
    red
    レッド
    orange
    オレンジ
    yellow
    イエロー
    yellowishgreen
    イエローグリーン
    green
    グリーン
    aquamarine
    アクアマリン
    lightblue
    ライトブルー
    blue
    ブルー
    bluepurple
    ブルーパープル
    purple
    パープル
    pink
    ピンク
    peach
    ピーチ
    brown
    ブラウン
    gray
    グレー
    midnight
    ミッドナイト
    railway
    鉄道路線
    district
    行政色分け図
    topographic
    地形図
    waters
    水域図

Method Detail

  • setStyle(style, redraw)
    オブジェクトの表示の有無を設定します。
    Parameters:
    {Array} style
    スタイルの配列
    オブジェクトの表示の有無をハッシュの配列で指定します。
    配列の各要素はキーにオブジェクト名、値に表示・非表示を表す論理値を持ちます。
    配列で指定した順序が表示・非表示の優先順位として適用されます。
    以下は道路と建物以外をすべて非表示にする例です。
    [
       {"label":false},    //すべてのカテゴリを非表示にする
       {"figure":false},
       {"shading":false},
       {"road":true},      //道路を表示する
       {"building":true}   //建物を表示する
    ]
    
    設定できるオブジェクトはこちらを参照してください。
    {Boolean} redraw
    再描画をするかどうか

Class BlankMapLayer

白地図レイヤー

Class Summary

属性 クラス名と説明
 
白地図を表示するレイヤーです。
ImageTileLayerクラスを継承しています。

Method Summary

属性 メソッド名と説明
 
setStyle(style, isRedraw)
白地図のスタイルを設定します。
ImageTileLayerから継承した関数:
getImageSrc, setOpacity
Layerから継承した関数:
bind, drawLayer, fromContainerPixelToLatLng, fromDivPixelToLatLng, fromLatLngsToDivPixels, fromLatLngToContainerPixel, fromLatLngToDivPixel, fromLatLngToTile, fromTileToLatLng, getContainer, getCopyrightCollection, getMap, getMapContainer, getName, hasFeature, isDrawn, isInitialized, isSystemLayer, setName, unbind

Class Detail

  • BlankMapLayer()
    白地図を表示するレイヤーです。

Method Detail

  • setStyle(style, isRedraw)
    白地図のスタイルを設定します。
    Parameters:
    {Object} style
    スタイルを指定したオブジェクト
    オブジェクトは以下の形式で作成してください。
    {
      "種類" : {
        "コード" : "色", // 複数指定可能です。
        "コード" : "色"
      },
      "bg" : "色" // 背景は色のみ指定します。
    }
    
    種類に指定可能な文字列
    label
    注記変更時に指定します。
    border
    ライン変更時に指定します。
    area
    エリア変更時に指定します。
    bg
    背景変更時に指定します。
    コードに指定可能な文字列
    default
    すべての指定
    指定可能な種類はlabel,border,areaです。
    state
    都道府県単位の指定
    指定可能な種類はlabel,borderです。
    city
    市区町村単位の指定
    指定可能な種類はlabel,borderです。
    street
    町丁目単位の指定
    指定可能な種類はlabel,borderです。
    数字
    行政コード(JIS住所コード2けたおよび5けた)で指定
    指定可能な種類はareaです。
    色に指定可能な文字列
    off
    透明色指定
    FFF
    3けたでのカラー指定
    FFFFFF
    6けたでのカラー指定
    {Boolean} isRedraw
    白地図レイヤーを再描画します。

Class RouteSearchLayer

経路探索レイヤー

Class Summary

属性 クラス名と説明
 
指定した地点間の経路を探索して表示するレイヤーです。
FeatureLayerクラスを継承しています。

Method Summary

属性 メソッド名と説明
 
経路をクリアします。
 
execute(latlngs, configs)
経路探索を実行します。
 
ルートサーチによる検索をする際に使われるアプリケーションIDを設定します
FeatureLayerから継承した関数:
addFeature, addFeatures, clearFeatures, getFeatures, getSuitedBounds, hasFeature, removeFeature
Layerから継承した関数:
bind, drawLayer, fromContainerPixelToLatLng, fromDivPixelToLatLng, fromLatLngsToDivPixels, fromLatLngToContainerPixel, fromLatLngToDivPixel, fromLatLngToTile, fromTileToLatLng, getContainer, getCopyrightCollection, getMap, getMapContainer, getName, isDrawn, isInitialized, isSystemLayer, setName, unbind

Event Summary

 
drawend(summary)
経路の描画が完了したときに発生します。
 
経路探索を開始するときに発生します。
 
error(error)
経路探索に失敗したときに発生します。

Class Detail

  • RouteSearchLayer(options)
    指定した地点間の経路を探索して表示するレイヤーです。
    Parameters:
    {Object} options
    設定
    {Style} strokeStyle
    経路探索結果のポリラインの線のスタイルを指定します。

Method Detail

  • clearRoute()
    経路をクリアします。
  • execute(latlngs, configs)
    経路探索を実行します。
    Parameters:
    {Array} latlngs
    緯度経度列
    {Object} configs
    経路探索オプション
    {Boolean} enableViaOptimize
    経由地点を最適な順に並べ替えるかどうかを設定します。
    最適な順に並べ替えるときはtrue、指定した順で探索するときはfalseを設定します。デフォルトはfalseです。
    {Number} enableRestrict
    交通規制を考慮するかどうかを設定します。
    考慮するときはtrueを設定します。デフォルトはfalseです。
    {String} priority
    探索時に優先する項目を設定します。
    時間を優先するときはtime、距離を優先するときはdistを設定します。デフォルトはtimeです。
    {Boolean} useCar
    自動車を使うかどうかを設定します。
    自動車を使うときはtrue、徒歩の場合はfalseを設定します。デフォルトはtrueです。
    {Boolean} useFerry
    フェリーを使用するかどうかを設定します。
    使用する場合はtrue、最低限のみ使用する場合はfalseを設定します。デフォルトはfalseです。
    {Boolean} useTollway
    有料道路を使用するかどうかを設定します。
    使用する場合はtrue、最低限のみ使用する場合はfalseを設定します。デフォルトはtrueです。
    {Object} params
    RouteSearchPlugin.getCurrentParams()の結果を設定します。
    RouteSearchPluginを利用した結果をRouteSearchLayerでも利用する場合に使用します。
  • setApplicationId(appId)
    ルートサーチによる検索をする際に使われるアプリケーションIDを設定します
    Parameters:
    {String} appId
    アプリケーションID

Event Detail

  • drawend(summary)
    経路の描画が完了したときに発生します。
    Parameters:
    {Object} summary
    描画された経路の要約
    {Number} TotalDistance
    経路の総距離目安です。単位は「m(メートル)」です。
    {Number} TotalTime
    経路の総時間目安です。単位は「分」です。
    経路探索オプションuseCar=trueのときは道路ごとの制限速度等を考慮して、falseのときは徒歩の時速5kmで計算されます。
  • drawstart()
    経路探索を開始するときに発生します。
  • error(error)
    経路探索に失敗したときに発生します。
    Parameters:
    {Object} error
    エラー
    {Number} code
    エラーコード
    {String} message
    エラーメッセージ

Class YolpSearchLayer

YOLPサーチレイヤ

Class Summary

属性 クラス名と説明
 
YOLP検索結果を表示するレイヤ
ListingLayerクラスを継承しています。

Method Summary

属性 メソッド名と説明
 
アイテムの吹きだし内に表示するHTMLを作成します。
 
アイテムの吹きだしが最大化されたときに表示するHTMLを作成します。
 
createItemHtml(index, feature)
リスト内、項目一つ分のHTMLを構築します。独自のHTMLを作成したい場合には、このメソッドをオーバーライドしてください。
 
createListHtml(ydf, query, options)
リスト表示の1つのアイテムを描画します。
 
createResultHtml(ydf, query, options)
リスト表示のための全HTMLを構築します。独自のHTMLを構築したい場合には、このメソッドをオーバーライドしてください。
 
execute(request, callback, error)
処理の実行
 
レイヤの削除
ListingLayerから継承した関数:
bind, createFooterHtml, createHeaderHtml, createNoMatchHtml, drawPage, fitToMap, getApiRequest, getApiUrl, getCurrentPage, getCustomIcon, getCustomStyle, getTotalPageCount, getYDF, isAutoPanMap, isAutoUpdate, isInfoWindowEnable, search, setAutoUpdate
FeatureLayerから継承した関数:
addFeature, addFeatures, clearFeatures, getFeatures, getSuitedBounds, hasFeature, removeFeature
Layerから継承した関数:
drawLayer, fromContainerPixelToLatLng, fromDivPixelToLatLng, fromLatLngsToDivPixels, fromLatLngToContainerPixel, fromLatLngToDivPixel, fromLatLngToTile, fromTileToLatLng, getContainer, getCopyrightCollection, getMap, getMapContainer, getName, isDrawn, isInitialized, isSystemLayer, setName, unbind
ListingLayerから継承したイベント:
drawend, drawstart

Class Detail

  • YolpSearchLayer(Object)
    YOLP検索結果を表示するレイヤ
    Parameters:
    Object
    options レイヤ表示オプション
    {boolean} searchBox
    検索ボックスの有無
    {String} cid
    カセットID
    {String} info
    情報表示モード(simple,standard,full)
    {integer} pageCount
    リスティング表示で1ページあたりの表示数(default=10)、最大100まで
    {integer} chunkCount
    リスティング表示で下部のページナビゲーションの表示数(default=5)
    {boolean} chunk
    リスティング表示で下部のページナビゲーションの表示

Method Detail

  • createInfoWindowHtml(feature)
    アイテムの吹きだし内に表示するHTMLを作成します。
    Parameters:
    {Object} feature
    対象のアイテム
  • createInfoWindowMaxContentHtml(feature)
    アイテムの吹きだしが最大化されたときに表示するHTMLを作成します。
    Parameters:
    {Object} feature
    対象のアイテム
  • {String|Node}createItemHtml(index, feature)
    リスト内、項目一つ分のHTMLを構築します。 独自のHTMLを作成したい場合には、このメソッドをオーバーライドしてください。
    Parameters:
    {Number} index
    アイテムのインデクス番号
    {Feature} feature
    アイテム
    Returns:
    {String|Node} html 作成したHTMLコードもしくはDOMノード
  • {String|Node}createListHtml(ydf, query, options)
    リスト表示の1つのアイテムを描画します。
    Parameters:
    {Object} ydf
    作成対象となるYDF
    {String} query
    作成対象のクエリ
    {Object} options
    作成対象のAPIオプション
    Returns:
    {String|Node} html 作成したHTMLコードもしくはDOMノード
  • {String|Node}createResultHtml(ydf, query, options)
    リスト表示のための全HTMLを構築します。 独自のHTMLを構築したい場合には、このメソッドをオーバーライドしてください。
    Parameters:
    {Object} ydf
    作成対象となるYDF
    {String} query
    作成対象のクエリ
    {Object} options
    作成対象のAPIオプション
    Returns:
    {String|Node} html 作成したHTMLコードもしくはDOMノード
  • execute(request, callback, error)
    処理の実行
    Parameters:
    {Object} request
    API呼び出しパラメータ
    {LatLng} center
    中心位置。
    {Number} dist
    検索範囲(km)。中心位置とセットで指定します。
    {LatLngBounds} bbox
    検索範囲(緯度経度指定)
    {Number} results
    取得件数。デフォルト値は10です。
    {Number} start
    開始位置 デフォルト値は1です。
    {String} detail
    出力レベル。simple,normal(デフォルト),detail
    {Function} callback
    結果を受け取る関数
    {Function} error
    エラーを受け取る関数
  • remove()
    レイヤの削除

Class GeoXmlHeatmapLayer

ヒートマップレイヤ

Class Summary

属性 クラス名と説明
 
GeoXmlHeatmapLayer(url, options)
YDF形式のXMLファイルを地図上にヒートマップとして表示するレイヤ
ImageTileLayerクラスを継承しています。

Method Summary

属性 メソッド名と説明
 
タイル1枚分の画像URLを返します。
ImageTileLayerから継承した関数:
setOpacity
Layerから継承した関数:
bind, drawLayer, fromContainerPixelToLatLng, fromDivPixelToLatLng, fromLatLngsToDivPixels, fromLatLngToContainerPixel, fromLatLngToDivPixel, fromLatLngToTile, fromTileToLatLng, getContainer, getCopyrightCollection, getMap, getMapContainer, getName, hasFeature, isDrawn, isInitialized, isSystemLayer, setName, unbind

Class Detail

  • GeoXmlHeatmapLayer(url, options)
    YDF形式のXMLファイルを地図上にヒートマップとして表示するレイヤ
     //YDFのURL
     var url = "http://1st.geocities.jp/yjmapstaff/yolp/ydf/geoSearch.xml";
     var heatmapLayer = new Y.GeoXmlHeatmapLayer(url);
     //Mapオブジェクトに追加
     map.addLayer(heatmapLayer);
    Parameters:
    {String} url
    YDF形式のXMLファイルのURL
    {Object} optionsOptional
    ヒートマップ作成のためのオプション
    opacity
    タイル画像の不透明度を指定(0~1.0)

Method Detail

  • getImageSrc(x, y)
    タイル1枚分の画像URLを返します。
    Parameters:
    {Number} x
    タイルx座標
    {Number} y
    タイルy座標

Class WeatherMapLayer

雨雲レーダーレイヤー

Class Summary

属性 クラス名と説明
 
雨雲レーダー画像を表示するレイヤーです。雨雲レイヤーはzoomレベルが1~15の場合に表示されます。
ImageTileLayerクラスを継承しています。

Method Summary

属性 メソッド名と説明
 
アニメーション用のタイムシフトの現在値を取得します。単位はミリ秒です。-7200000~3600000(-120分~+60分)の値が返されます。これは5分間隔ではなくてsetAnimationStepで設定した間隔で進む値を取得します。
 
現在表示している雨雲の日付を取得します。形式はYYYYMMDDHHMISSの14桁
 
タイムシフト値を取得します。この値は実際に表示している画像のタイムシフト値です。-7200000~3600000(-120分~+60分)の、どの時間の雨雲を表示しているかを返します。0が現在時間となります。単位はミリ秒です。
 
アニメーション終了時に呼ばれるコールバック関数を登録します。
 
アニメーションの間隔を設定します。単位はミリ秒です。デフォルトは1000ミリ秒(1秒)です。startAnimationのオプションでも設定可能です。
 
アニメーションのステップ数(setAnimationIntervalで設定した間隔毎に進む時間)を設定します。単位はミリ秒です。デフォルトは30000ミリ秒(30秒)です。startAnimationのオプションでも設定可能です。
 
アニメーション用のタイムシフト値を設定します。-7200000~3600000(-120分~+60分)の値を設定できます。
 
アニメーション中にsetAnimationIntervalで設定した間隔で呼ばれるコールバック関数を登録します。
 
気象情報APIによる検索をする際に使われるアプリケーションIDを設定します
 
自動更新時の間隔を指定します。単位は分です。デフォルトは5分です。設定可能な間隔は5分~です。
 
setDispTime(isDisplay)
雨雲データの日付を表示します。
 
setTimePosition(日付の表示位置)
雨雲データの日付位置を設定します。
 
タイムシフト値を設定します。この値は実際に表示している画像のタイムシフト値です。-7200000~3600000(-120分~+60分)の、どの時間の雨雲を表示するかを設定します。0が現在時間となります。単位はミリ秒です。
 
自動更新された時に呼ばれるコールバック関数を登録します。
 
startAnimation(options)
雨雲のアニメーションを開始します。
 
startAutoUpdate(options)
自動更新を開始します。setAutoUpdateInterval()で設定されている間隔で自動更新されます。デフォルトは5分です。
 
雨雲のアニメーションを停止します。onFinishイベントにコールバック関数が設定されている場合はそのコールバック関数が呼び出されます。
 
自動更新を停止します。
 
雨雲レイヤーを再描画します。
ImageTileLayerから継承した関数:
getImageSrc, setOpacity
Layerから継承した関数:
bind, drawLayer, fromContainerPixelToLatLng, fromDivPixelToLatLng, fromLatLngsToDivPixels, fromLatLngToContainerPixel, fromLatLngToDivPixel, fromLatLngToTile, fromTileToLatLng, getContainer, getCopyrightCollection, getMap, getMapContainer, getName, hasFeature, isDrawn, isInitialized, isSystemLayer, setName, unbind

Event Summary

 
天気データの更新とレイヤーの再描画が完了した時に通知されます

Class Detail

  • WeatherMapLayer(options)
    雨雲レーダー画像を表示するレイヤーです。 雨雲レイヤーはzoomレベルが1~15の場合に表示されます。
    Parameters:
    {Object} options
    オプション
    {Number} opacity 透過率0~1.0
    雨雲レーダーレイヤーの透過率を設定します。デフォルトは1.0です。

Method Detail

  • getAnimationTimeShift()
    アニメーション用のタイムシフトの現在値を取得します。単位はミリ秒です。 -7200000~3600000(-120分~+60分)の値が返されます。 これは5分間隔ではなくてsetAnimationStepで設定した間隔で進む値を取得します。
  • {String}getNowDate()
    現在表示している雨雲の日付を取得します。 形式はYYYYMMDDHHMISSの14桁
    Returns:
    {String} YYYYMMDDHHMISSの14桁
  • {Number}getTimeShift()
    タイムシフト値を取得します。この値は実際に表示している画像のタイムシフト値です。 -7200000~3600000(-120分~+60分)の、どの時間の雨雲を表示しているかを返します。0が現在時間となります。単位はミリ秒です。
    Returns:
    {Number} タイムシフト値。単位はミリ秒。
  • setAnimationFinishCallback(callback)
    アニメーション終了時に呼ばれるコールバック関数を登録します。
    Parameters:
    {Function} callback
    コールバック関数
  • setAnimationInterval(time)
    アニメーションの間隔を設定します。単位はミリ秒です。 デフォルトは1000ミリ秒(1秒)です。 startAnimation のオプションでも設定可能です。
    Parameters:
    {Number} time
    アニメーションの間隔。単位はミリ秒。
  • setAnimationStep(step)
    アニメーションのステップ数(setAnimationIntervalで設定した間隔毎に進む時間)を設定します。単位はミリ秒です。 デフォルトは30000ミリ秒(30秒)です。 startAnimationのオプションでも設定可能です。
    Parameters:
    {Number} step
    更新時間毎に進む時間。単位はミリ秒。
  • setAnimationTimeShift(time)
    アニメーション用のタイムシフト値を設定します。 -7200000~3600000(-120分~+60分)の値を設定できます。
    Parameters:
    time
  • setAnimationUpdateCallback(callback)
    アニメーション中にsetAnimationIntervalで設定した間隔で呼ばれるコールバック関数を登録します。
    Parameters:
    {Function} callback
    コールバック関数
  • setApplicationId(appId)
    気象情報APIによる検索をする際に使われるアプリケーションIDを設定します
    Parameters:
    {String} appId
    アプリケーションID
  • setAutoUpdateInterval(time)
    自動更新時の間隔を指定します。単位は分です。デフォルトは5分です。 設定可能な間隔は5分~です。
    Parameters:
    {Number} time
    自動更新時の間隔。単位は分。設定可能な間隔は5~です。
  • setDispTime(isDisplay)
    雨雲データの日付を表示します。
    Parameters:
    {Boolean} isDisplay
    true...表示 false...非表示
  • setTimePosition(日付の表示位置)
    雨雲データの日付位置を設定します。
    weather.setTimePosition(new Y.ControlPosition(Y.ControlPosition.BOTTOM_LEFT, new Y.Size(1, 26)));
    Parameters:
    {ControlPosition} 日付の表示位置
  • setTimeShift(time)
    タイムシフト値を設定します。この値は実際に表示している画像のタイムシフト値です。 -7200000~3600000(-120分~+60分)の、どの時間の雨雲を表示するかを設定します。0が現在時間となります。単位はミリ秒です。
    Parameters:
    {Number} time
    タイムシフト値。単位はミリ秒。
  • setUpdateCallback(callback)
    自動更新された時に呼ばれるコールバック関数を登録します。
    Parameters:
    {Function} callback
    コールバック関数
  • startAnimation(options)
    雨雲のアニメーションを開始します。
    Parameters:
    {Object} options
    オプション
    {Function} onFinish
    アニメーション停止時に呼びだされるコールバック関数を指定します。
    {Function} onUpdate
    アニメーション更新時に呼びだされるコールバック関数を指定します。setAnimationInterval()で指定した時間毎にコールされます。
    {Number} interval
    アニメーションの間隔を指定します。単位はミリ秒です。
    {Number} step
    アニメーション時に更新間隔毎に何ミリ秒進むかを指定します。
  • startAutoUpdate(options)
    自動更新を開始します。 setAutoUpdateInterval() で設定されている間隔で自動更新されます。デフォルトは5分です。
    Parameters:
    {Object} options
    オプション
    {Number} interval
    自動更新の間隔。単位は分。設定可能な間隔は5分~です。
  • stopAnimation()
    雨雲のアニメーションを停止します。 onFinishイベントにコールバック関数が設定されている場合はそのコールバック関数が呼び出されます。
  • stopAutoUpdate()
    自動更新を停止します。
  • updateWeather()
    雨雲レイヤーを再描画します。

Event Detail

  • dataupdate()
    天気データの更新とレイヤーの再描画が完了した時に通知されます