YOLP(地図)

Featureクラス

Feature クラス

クラス一覧へ

Class Feature

地物

Class Summary

属性 クラス名と説明
 
地図の上に描画される地物のインターフェースで、MarkerPolylinePolygonCircleなどが実装されています。このインターフェースを実装したオブジェクトは、FeatureLayer.addFeatureを使用して、地図上に描画することが可能となります。

Method Summary

属性 メソッド名と説明
 
地物のピクセル座標位置を再計算する必要が生じたときに、Layerから呼び出され位置の再配置を行います。
 
bind(type, function, object)
地物オブジェクトが通知するイベントに対してイベントハンドラを設定します。
 
bindInfoWindow(content, infoWindowOptions)
指定されたコンテンツを、この地物に関連付けます。関連付けられたコンテンツは、この地物がクリックされたときに吹きだし内に表示されます。
 
draw(force)
地物を描画します。Layerから呼び出されます。
 
地物を表す緯度経度を返します。
 
地物を表す緯度経度の配列を返します。
 
地物に関連付けられているLayerを返します。
 
地物に関連付けられているMapを返します。
 
initialize(layer)
FeatureLayer.addFeatureを使用して、Layerに地物が追加されるときに呼び出されます。
 
地物がLayer上に描画済みかどうかを返します。
 
地物が画像などを緯度経度に関連付けて表現されるデータであるかどうかを返します。主にMarkerが該当します。
 
openInfoWindow(content, infoWindowOptions)
地物上に吹きだしを表示します。
 
地物を削除します。Layerから呼び出されます。
 
unbind(listener)
地物に設定されたイベントを解除します。

Class Detail

  • Feature()
    地図の上に描画される地物のインターフェースで、MarkerPolylinePolygonCircle などが実装されています。 このインターフェースを実装したオブジェクトは、FeatureLayer.addFeatureを使用して、地図上に描画することが可能となります。

Method Detail

  • adjust()
    地物のピクセル座標位置を再計算する必要が生じたときに、 Layerから呼び出され位置の再配置を行います。
  • {EventListener}bind(type, function, object)
    地物オブジェクトが通知するイベントに対してイベントハンドラを設定します。
    Parameters:
    {String} type
    イベント名
    {Function} function
    イベント発生時に呼び出されるイベントハンドラ
    {Object} object Optional
    設定したイベントハンドラ内でthisとして評価されるオブジェクト
    省略時は地物オブジェクト自身をthisとして評価
    Returns:
    {EventListener}
  • {InfoWindow}bindInfoWindow(content, infoWindowOptions)
    指定されたコンテンツを、この地物に関連付けます。 関連付けられたコンテンツは、この地物がクリックされたときに吹きだし内に表示されます。
    Parameters:
    {String|Node} content
    表示するコンテンツのHTMLもしくはDOMノードオブジェクト
    {Object} infoWindowOptions Optional
    InfoWindowに渡されるオプション
    Returns:
    {InfoWindow} 関連付けられたInfoWindow
  • draw(force)
    地物を描画します。 Layerから呼び出されます。
    Parameters:
    force
  • {LatLng}getLatLng()
    地物を表す緯度経度を返します。
    Returns:
    {LatLng}
  • {ArrayOfLatLng}getLatLngs()
    地物を表す緯度経度の配列を返します。
    Returns:
    {ArrayOfLatLng}
  • {Layer}getLayer()
    地物に関連付けられているLayerを返します。
    Returns:
    {Layer}
  • {Map}getMap()
    地物に関連付けられているMapを返します。
    Returns:
    {Map}
  • initialize(layer)
    FeatureLayer.addFeatureを使用して、Layerに地物が追加されるときに呼び出されます。
    Parameters:
    {Layer} layer
  • {Boolean}isDrawn()
    地物がLayer上に描画済みかどうかを返します。
    Returns:
    {Boolean}
  • {Boolean}isRaster()
    地物が画像などを緯度経度に関連付けて表現されるデータであるかどうかを返します。主にMarkerが該当します。
    Returns:
    {Boolean}
  • {InfoWindow}openInfoWindow(content, infoWindowOptions)
    地物上に吹きだしを表示します。
    Parameters:
    {String|Node} content
    表示するコンテンツのHTMLもしくはDOMノードオブジェクト
    {Object} infoWindowOptions Optional
    InfoWindowに渡されるオプション
    Returns:
    {InfoWindow}
  • remove()
    地物を削除します。 Layerから呼び出されます。
  • unbind(listener)
    地物に設定されたイベントを解除します。
    Parameters:
    {EventListener} listener
    解除するイベントリスナー



Class Icon

アイコン

Class Summary

属性 クラス名と説明
 
Icon(image, options)
マーカーで使用するアイコン画像を表します。

Field Summary

属性 フィールド名と説明
 
このアイコンのCSSクラス名です。
<static> <constant>  
デフォルトアイコン。
 
アイコンの表示位置。アイコン画像左上を基点とします。
 
アイコンの大きさ。
 
アイコンの画像URL。
 
このアイコンに関連付けられる吹きだしの表示位置。アイコン画像左上を基点とします。

Method Summary

属性 メソッド名と説明
 
アイコンのDOMノードを生成します。

Class Detail

  • Icon(image, options)
    マーカーで使用するアイコン画像を表します。
//http://example.com/icon.png をマーカーの画像として使用します。
var icon = new Y.Icon('http://example.com/icon.png', {iconSize: new Y.Size(16,16)});
var marker = new Marker( latlng , { icon : icon } );
map.addFeature( marker );
Parameters:
{String} image
アイコン画像のURL
{Object} options
描画オプション
Size iconSize
アイコンの大きさを指定します。
Point iconAnchor
アイコンの表示位置を指定します。
Point infoWindowAnchor
このアイコンに関連付けられる吹きだしの表示位置を指定します。
Point labelAnchor
このアイコンに関連付けられるラベルの表示位置を指定します。
{String} className
このアイコンのCSSクラス名を指定します。
{String} iconHtml
このアイコンの DOM を指定します。

Field Detail

  • {String}className
    このアイコンのCSSクラス名です。
  • <static> <constant> Icon.DEFAULT_ICON
    デフォルトアイコン。
  • {Point}iconAnchor
    アイコンの表示位置。アイコン画像左上を基点とします。
  • {Size}iconSize
    アイコンの大きさ。
  • {String}image
    アイコンの画像URL。
  • {Point}infoWindowAnchor
    このアイコンに関連付けられる吹きだしの表示位置。アイコン画像左上を基点とします。

Method Detail

  • createNode()
    アイコンのDOMノードを生成します。



Class Style

地物の描画スタイル

Class Summary

属性 クラス名と説明
 
Style(color, weight, opacity, startline, endline)
地物の描画スタイルを管理します。

Field Summary

属性 フィールド名と説明
 
描画色。
 
終端スタイル。
 
透過率。
 
始端スタイル。
 
描画幅。

Class Detail

  • Style(color, weight, opacity, startline, endline)
    地物の描画スタイルを管理します。
    Parameters:
    {String} color
    描画色
    {Number} weight
    描画幅
    {Number} opacity
    透過率0~1.0
    {String} startline
    始端スタイル(arrow=矢印)
    {String} endline
    終端スタイル(arrow=矢印)

Field Detail

  • {String}color
    描画色。
  • {String}endline
    終端スタイル。
  • {Number}opacity
    透過率。
  • {String}startline
    始端スタイル。
  • {Number}weight
    描画幅。



Class Marker

マーカー

Class Summary

属性 クラス名と説明
 
Marker(latlng, options)
地図上にマーカーを表示します。
Featureクラスを継承しています。

Method Summary

属性 メソッド名と説明
 
マーカーが保持しているアイコンのDOM要素を返します。
 
マーカーの緯度経度を返します。
 
マーカーがクリック可能かどうかを返します。
 
マーカーがマウスドラッグにより移動可能かどうかを返します。
 
地物が画像などを緯度経度に関連付けて表現されるデータであるかどうかを返します。主にマーカーが該当します。
 
setClickable(clickable)
マーカーをクリック可能にするかどうかを設定します。
 
setDraggable(draggable)
マーカーをマウスドラッグにより移動可能にするかどうかを設定します。
 
setIcon(icon)
マーカーが保持しているアイコンを再設定します。
Featureから継承した関数:
adjust, bind, bindInfoWindow, draw, getLatLngs, getLayer, getMap, initialize, isDrawn, openInfoWindow, remove, unbind

Event Summary

 
マーカーをクリックすると発生します。
 
マーカーのオプションdraggable=trueのとき、ドラッグ終了時に発生します。
 
マーカーのオプションdraggable=trueのとき、ドラッグ開始時に発生します。
 
マーカー上からマウスカーソルが離れたときに発生します。
 
マーカー上にマウスカーソルが重なったときに発生します。

Class Detail

  • Marker(latlng, options)
    地図上にマーカーを表示します。
    Parameters:
    {LatLng} latlng
    表示する地理座標位置
    {Object} optionsOptional
    表示オプション
    {Icon} icon
    マーカーとして表示するアイコンを指定します。デフォルト値はY.Icon.DEFAULT_ICONです。
    {Boolean} clickable
    マーカーがクリック可能かどうかを指定します。デフォルト値はtrueです。
    {Boolean} draggable
    マーカーがマウスでドラッグ可能かどうかを指定します。デフォルト値はfalseです。
    {String} title
    マーカーのツールチップとして表示されるタイトルを指定します。
    {String} labelClassName
    マーカーのツールチップとして表示するラベルDOMノードの生成に使用するクラス名です。

Method Detail

  • {DOM}getDOMNode()
    マーカーが保持しているアイコンの DOM 要素を返します。
    Returns:
    {DOM} DOM が存在しない場合は null が返ります。
  • {LatLng}getLatLng()
    マーカーの緯度経度を返します。
    Returns:
    {LatLng}
  • {Boolean}isClickable()
    マーカーがクリック可能かどうかを返します。
    Returns:
    {Boolean} clickable
  • {Boolean}isDraggable()
    マーカーがマウスドラッグにより移動可能かどうかを返します。
    Returns:
    {Boolean} ドラッグ可能かどうか
  • {Boolean}isRaster()
    地物が画像などを緯度経度に関連付けて表現されるデータであるかどうかを返します。主にマーカーが該当します。
    Returns:
    {Boolean}
  • setClickable(clickable)
    マーカーをクリック可能にするかどうかを設定します。
    Parameters:
    {Boolean} clickable
  • setDraggable(draggable)
    マーカーをマウスドラッグにより移動可能にするかどうかを設定します。
    Parameters:
    {Boolean} draggable
    ドラッグ可能かどうか
  • setIcon(icon)
    マーカーが保持しているアイコンを再設定します。
    Parameters:
    {Y.Icon} icon

Event Detail

  • click()
    マーカーをクリックすると発生します。
  • dragend()
    マーカーのオプションdraggable=trueのとき、ドラッグ終了時に発生します。
  • dragstart()
    マーカーのオプションdraggable=trueのとき、ドラッグ開始時に発生します。
  • mouseout()
    マーカー上からマウスカーソルが離れたときに発生します。
  • mouseover()
    マーカー上にマウスカーソルが重なったときに発生します。



Class Label

ラベル

Class Summary

属性 クラス名と説明
 
Label(latlng, label, options)
地図上にラベルを表示します。
Featureクラスを継承しています。

Method Summary

属性 メソッド名と説明
 
ラベルの緯度経度を返します。
 
ラベルがクリック可能かどうかを返します。
 
ラベルがマウスドラッグにより移動可能かどうかを返します。
 
地物が画像などを緯度経度に関連付けて表現されるデータであるかどうかを返します。主にラベルが該当します。
 
setClickable(clickable)
ラベルをクリック可能にするかどうかを設定します。
 
setDraggable(draggable)
ラベルをマウスドラッグにより移動可能にするかどうかを設定します。
Featureから継承した関数:
adjust, bind, bindInfoWindow, draw, getLatLngs, getLayer, getMap, initialize, isDrawn, openInfoWindow, remove, unbind

Class Detail

  • Label(latlng, label, options)
    地図上にラベルを表示します。
    Parameters:
    {LatLng} latlng
    表示する地理座標位置
    {String} label
    表示する文字列
    {Object} optionsOptional
    表示オプション
    {String} className
    ラベルDOMノードの生成に使用するクラス名です。
    {Point} offset
    緯度経度位置に対して、ラベルの左下座標からのオフセット値です。
    {Boolean} clickable
    ラベルがクリック可能かどうかを指定します。デフォルト値はtrueです。
    {Boolean} draggable
    ラベルがマウスでドラッグ可能かどうかを指定します。デフォルト値はfalseです。

Method Detail

  • {LatLng}getLatLng()
    ラベルの緯度経度を返します。
    Returns:
    {LatLng}
  • {Boolean}isClickable()
    ラベルがクリック可能かどうかを返します。
    Returns:
    {Boolean} clickable
  • {Boolean}isDraggable()
    ラベルがマウスドラッグにより移動可能かどうかを返します。
    Returns:
    {Boolean} ドラッグ可能かどうか
  • {Boolean}isRaster()
    地物が画像などを緯度経度に関連付けて表現されるデータであるかどうかを返します。主にラベルが該当します。
    Returns:
    {Boolean}
  • setClickable(clickable)
    ラベルをクリック可能にするかどうかを設定します。
    Parameters:
    {Boolean} clickable
  • setDraggable(draggable)
    ラベルをマウスドラッグにより移動可能にするかどうかを設定します。
    Parameters:
    {Boolean} draggable
    ドラッグ可能かどうか



Class Polyline

ポリライン

Class Summary

属性 クラス名と説明
 
Polyline(latlngs, options)
地図上に描画される線を表します。
Featureクラスを継承しています。

Method Summary

属性 メソッド名と説明
 
startDrawing()で作成中のポリラインを確定させます。この時endlineイベントが発生します。
 
このポリラインを代表する緯度経度を返します。
 
ポリラインの長さをkm単位で返します。
 
このポリラインを代表する点をピクセル座標で返します。
 
setClickable(clickable)
ポリラインをクリック可能にするかどうかを設定します。
 
setDraggable(draggable)
ポリラインをマウスドラッグにより編集可能にするかどうかを設定します。
 
ポリラインの作成を地図上で開始します。作成が正常に完了した場合、endlineイベントが発生します。作成がキャンセルされた場合、cancellineイベントが発生します。作成完了前に再度startDrawing()がコールされた時はキャンセルされた後に再度作成が開始されます。
Featureから継承した関数:
adjust, bind, bindInfoWindow, draw, getLatLngs, getLayer, getMap, initialize, isDrawn, isRaster, openInfoWindow, remove, unbind

Class Detail

  • Polyline(latlngs, options)
    地図上に描画される線を表します。
    Parameters:
    {Array} latlngs
    線を構成する緯度経度配列
    {Object} options
    描画オプション
    {Boolean} clickable
    ポリラインがクリック可能かどうかを指定します。デフォルト値はtrueです。
    {Boolean} draggable
    ポリラインがマウスでドラッグ可能かどうかを指定します。デフォルト値はfalseです。
    {Boolean} clipping
    ポリライン描画時に切り抜きを行うかどうかを指定します。デフォルト値はtrueです。
    {Style} strokeStyle
    線の描画形式です。

Method Detail

  • finalizeDrawing()
    startDrawing()で作成中のポリラインを確定させます。 この時endlineイベントが発生します。
  • {Point}getLatLng()
    このポリラインを代表する緯度経度を返します。
    Returns:
    {Point}
  • {Number}getLength()
    ポリラインの長さをkm単位で返します。
    Returns:
    {Number} 長さ(km)
  • {Point}getPoint()
    このポリラインを代表する点をピクセル座標で返します。
    Returns:
    {Point}
  • setClickable(clickable)
    ポリラインをクリック可能にするかどうかを設定します。
    Parameters:
    {Boolean} clickable
  • setDraggable(draggable)
    ポリラインをマウスドラッグにより編集可能にするかどうかを設定します。
    Parameters:
    {Boolean} draggable
  • startDrawing()
    ポリラインの作成を地図上で開始します。 作成が正常に完了した場合、endlineイベントが発生します。 作成がキャンセルされた場合、cancellineイベントが発生します。 作成完了前に再度startDrawing()がコールされた時はキャンセルされた後に再度作成が開始されます。



Class Polygon

ポリゴン

Class Summary

属性 クラス名と説明
 
Polygon(latlngs, options)
頂点の配列からポリゴンを作成します。
Polylineクラスを継承しています。

Method Summary

属性 メソッド名と説明
 
ポリゴンの位置を再配置します。
 
draw(force)
地物を描画します。Layerから呼び出されます。
 
このポリゴンを代表する緯度経度を返します。
 
このポリゴンを代表するピクセル座標を返す
 
setClickable(clickable)
ポリゴンをクリック可能にするかどうかを設定します。
 
setDraggable(draggable)
ポリゴンをマウスドラッグにより編集可能にするかどうかを設定します。
Polylineから継承した関数:
finalizeDrawing, getLength, startDrawing
Featureから継承した関数:
bind, bindInfoWindow, getLatLngs, getLayer, getMap, initialize, isDrawn, isRaster, openInfoWindow, remove, unbind

Class Detail

  • Polygon(latlngs, options)
    頂点の配列からポリゴンを作成します。
    Parameters:
    {Array} latlngs
    ポリゴンを構成する緯度経度の配列
    {Object} options
    描画オプション
    {Boolean} clickable
    ポリゴンがクリック可能かどうかを指定します。デフォルト値はtrueです。
    {Boolean} draggable
    ポリゴンがマウスでドラッグ可能かどうかを指定します。デフォルト値はfalseです。
    {Boolean} clipping
    ポリゴン描画時に切り抜きを行うかどうかを指定します。デフォルト値はtrueです。
    Style strokeStyle
    ポリゴンを構成するラインの描画形式
    Style fillStyle
    ポリゴンの塗りつぶし形式

Method Detail

  • adjust()
    ポリゴンの位置を再配置します。
  • draw(force)
    地物を描画します。Layerから呼び出されます。
    Parameters:
    {boolean} force
  • {LatLng}getLatLng()
    このポリゴンを代表する緯度経度を返します。
    Returns:
    {LatLng}
  • {Point}getPoint()
    このポリゴンを代表するピクセル座標を返す
    Returns:
    {Point}
  • setClickable(clickable)
    ポリゴンをクリック可能にするかどうかを設定します。
    Parameters:
    {Boolean} clickable
  • setDraggable(draggable)
    ポリゴンをマウスドラッグにより編集可能にするかどうかを設定します。
    Parameters:
    {Boolean} draggable



Class Circle

Class Summary

属性 クラス名と説明
 
Circle(latlng, radius, options)
地図上に描画される円を表します。
Featureクラスを継承しています。

Method Summary

属性 メソッド名と説明
 
円の位置を再配置します。
 
円を地図上で編集可能に設定します。
 
円の中心緯度経度座標を返します。
 
円を代表する点をピクセル座標で返します。
 
円の半径をkm単位で返します。
 
円の半径をピクセル単位で返す
 
setClickable(clickable)
円をクリック可能にするかどうかを設定します。
Featureから継承した関数:
bind, bindInfoWindow, draw, getLatLngs, getLayer, getMap, initialize, isDrawn, isRaster, openInfoWindow, remove, unbind

Class Detail

  • Circle(latlng, radius, options)
    地図上に描画される円を表します。
    Parameters:
    {LatLng} latlng
    円の中心緯度経度
    {Size} radius
    円の半径(Pixel単位)
    {Object} options

    {String} unit
    半径指定の単位。pixel=ピクセル指定、km=キロメートル指定

Method Detail

  • adjust()
    円の位置を再配置します。
  • enableEditing()
    円を地図上で編集可能に設定します。
  • {LatLng}getLatLng()
    円の中心緯度経度座標を返します。
    Returns:
    {LatLng}
  • {Point}getPoint()
    円を代表する点をピクセル座標で返します。
    Returns:
    {Point}
  • {Number}getRadiusKilometers()
    円の半径をkm単位で返します。
    Returns:
    {Number}
  • {Size}getRadiusPixel()
    円の半径をピクセル単位で返す
    Returns:
    {Size} radius ピクセル数
  • setClickable(clickable)
    円をクリック可能にするかどうかを設定します。
    Parameters:
    {Boolean} clickable