YOLP(地図)
Baseクラス
Base クラス
- Point
ピクセル座標 - Size
ピクセルサイズ - Bounds
ピクセル矩形領域 - LatLng
地理座標 - LatLngBounds
地理座標矩形領域 - MapConfigure
地図操作設定 - LayerSetId
レイヤーセットID - YDF
YDF(YOLP Data Format) - InfoWindow
吹きだし - Projection
投影変換 - MercatorProjection
メルカトル投影変換 - Event
イベント - EventListener
イベントリスナー
Class Point
ピクセル座標
Class Summary
属性 | クラス名と説明 |
---|---|
Point(x, y)
Pointはピクセル座標で地図上の地点を表します。緯度経度で地点の地理座標を表す場合は、LatLngクラスを使用します。
|
Field Summary
属性 | フィールド名と説明 |
---|---|
x座標
|
|
y座標
|
Method Summary
属性 | メソッド名と説明 |
---|---|
copy()
ピクセル座標オブジェクトのコピーを返します。
|
|
equals(others)
他の地点と座標が同じ場合に、trueを返します。
|
|
toString()
x座標とy座標を「,」で区切られたテキスト形式で出力します。
|
Class Detail
-
Point(x, y)Pointはピクセル座標で地図上の地点を表します。緯度経度で地点の地理座標を表す場合は、 LatLngクラスを使用します。
- Parameters:
- {Number} x
- x座標(左から右へ)
- {Number} y
- y座標(上から下へ)
Field Detail
-
x座標
-
y座標
Method Detail
-
{Point}copy()ピクセル座標オブジェクトのコピーを返します。
- Returns:
- {Point}
-
他の地点と座標が同じ場合に、trueを返します。
- Parameters:
- {Point} others
- Returns:
- {Boolean}
-
x座標とy座標を「,」で区切られたテキスト形式で出力します。
- Returns:
- {String}
Class Size
ピクセルサイズ
Class Summary
属性 | クラス名と説明 |
---|---|
Size(width, height)
矩形サイズをピクセル座標で表します。
|
Field Summary
属性 | フィールド名と説明 |
---|---|
高さ
|
|
幅
|
Method Summary
属性 | メソッド名と説明 |
---|---|
equals(other)
他のサイズオブジェクトと同じ場合にtrueを返します。
|
|
toString()
widthとheightを「,」で区切られたテキストで返します。
|
Class Detail
-
Size(width, height)矩形サイズをピクセル座標で表します。
- Parameters:
- {Number} width
- 短形サイズの幅
- {Number} height
- 短形サイズの高さ
Field Detail
-
高さ
-
幅
Method Detail
-
他のサイズオブジェクトと同じ場合にtrueを返します。
- Parameters:
- {Size} other
- Returns:
- {Boolean}
-
widthとheightを「,」で区切られたテキストで返します。
- Returns:
- {String}
Class Bounds
ピクセル矩形領域
Class Summary
属性 | クラス名と説明 |
---|---|
Bounds(points)
矩形の領域をピクセル単位で管理します。緯度経度での地理座標領域にはLatLngBoundsを使用します。
|
Field Summary
属性 | フィールド名と説明 |
---|---|
矩形右端のx座標
|
|
矩形上端のy座標
|
|
矩形左端のx座標
|
|
矩形下端のy座標
|
Method Summary
属性 | メソッド名と説明 |
---|---|
containsBounds(other, partial, inclusive)
渡された矩形領域がこの矩形領域全体に含まれる場合にtrueを返します。
|
|
containsPoint(point)
渡されたピクセル座標がこの矩形領域内に含まれる場合にtrueを返します。
|
|
equals(other)
この矩形と等しい場合に、trueを返します。
|
|
intersect(other, inclusive)
矩形領域同士が重なるかどうかを判定します。
|
|
max()
矩形領域の右下座標を返します。
|
|
mid()
矩形領域の中心座標を返します。
|
|
min()
矩形領域の左上座標を返します。
|
|
toString()
矩形領域の左上の頂点と右下の頂点の座標を、「,」で区切られたテキスト形式で返します。
|
Class Detail
-
Bounds(points)矩形の領域をピクセル単位で管理します。 緯度経度での地理座標領域にはLatLngBoundsを使用します。
- Parameters:
- {Array} points
- 領域を構成するためのすべてのPoint
Field Detail
-
矩形右端のx座標
-
矩形上端のy座標
-
矩形左端のx座標
-
矩形下端のy座標
Method Detail
-
渡された矩形領域がこの矩形領域全体に含まれる場合にtrueを返します。
- Parameters:
- {Bounds} other
- {Boolean} partial
- 部分の重なりも評価する(default: false)
- {Boolean} inclusive
- 同一座標も評価する(default: true)
- Returns:
- {Boolean}
-
渡されたピクセル座標がこの矩形領域内に含まれる場合にtrueを返します。
- Parameters:
- {Point} point
- Returns:
- {Boolean}
-
この矩形と等しい場合に、trueを返します。
- Parameters:
- {Bounds} other
- Returns:
- {Boolean}
-
矩形領域同士が重なるかどうかを判定します。
- Parameters:
- {Bounds} other
- 判定対象
- {Boolean} inclusive Optional
- 線上を重なると判定する場合true
- Returns:
- {Boolean} 重なる場合true
-
{Point}max()矩形領域の右下座標を返します。
- Returns:
- {Point}
-
矩形領域の左上の頂点と右下の頂点の座標を、「,」で区切られたテキスト形式で返します。
- Returns:
- {String}
Class LatLng
地理座標
Class Summary
属性 | クラス名と説明 |
---|---|
LatLng(lat, lng)
地点の地理座標(緯度経度)を表します。
|
Method Summary
属性 | メソッド名と説明 |
---|---|
copy()
緯度経度オブジェクトのコピーを返します。
|
|
distance(other)
2点間の距離をkm単位で返します。
|
|
equals(p)
もう一方の緯度経度と同じ値の場合にtrueを返します。
|
|
<static> |
LatLng.fromString(latitudeString, longitudeString)
(35/44/24,139/24/22)のような文字列から緯度経度を構築します。
|
<static> |
LatLng.fromUrlValue(val)
URLパラメータから緯度経度を構築します。
|
lat()
緯度を返します。
|
|
緯度のラジアン(rad)を返します。
|
|
lng()
経度を返します。
|
|
経度のラジアン(rad)を返します。
|
|
toString()
この緯度経度座標を表す文字列を返します。
|
|
URLパラメータ用の文字列に変換します。
|
Method Detail
-
{LatLng}copy()緯度経度オブジェクトのコピーを返します。
- Returns:
- {LatLng}
-
2点間の距離をkm単位で返します。
- Parameters:
- {LatLng} other
- 計測対象の緯度経度
- Returns:
- {Number} distance 距離(km)
-
もう一方の緯度経度と同じ値の場合にtrueを返します。
- Parameters:
- p
- Returns:
- {Booelan}
-
(35/44/24, 139/24/22)のような文字列から緯度経度を構築します。
- Parameters:
- {String} latitudeString
- 緯度を表す文字列
- {String} longitudeString
- 経度を表す文字列
- Returns:
- {LatLng} 生成された緯度経度オブジェクト
-
URLパラメータから緯度経度を構築します。
- Parameters:
- val
-
緯度を返します。
- Returns:
- {Number}
-
緯度のラジアン(rad)を返します。
- Returns:
- {Double} 緯度のラジアン(rad)
-
経度を返します。
- Returns:
- {Number}
-
経度のラジアン(rad)を返します。
- Returns:
- {Double} 緯度のラジアン(rad)
-
この緯度経度座標を表す文字列を返します。
- Returns:
- {String}
-
URLパラメータ用の文字列に変換します。
Class LatLngBounds
地理座標矩形領域
Class Summary
属性 | クラス名と説明 |
---|---|
LatLngBounds(sw, ne)
地理座標で矩形領域を表します。
|
Method Summary
属性 | メソッド名と説明 |
---|---|
containsBounds(other, partial, inclusive)
もう一方の矩形領域が、この矩形領域内に含まれるかどうかを返します。
|
|
containsLatLng(latlng, inclusive)
指定した緯度経度がこの矩形領域内に含まれるかどうかを返します。
|
|
copy()
矩形領域のcopyを返します。
|
|
extend(latlng)
指定された地点を含むようにこの矩形を拡大します。
|
|
extendRate(rate)
指定された割合だけ、矩形を拡大します。
|
|
矩形領域の中心緯度経度座標を返します。
|
|
矩形の北東の頂点の位置を返します。
|
|
矩形の南西の頂点の位置を返します。
|
|
intersect(other, inclusive)
矩形領域同士が重なるかどうかを判定します。
|
|
isEmpty()
この矩形が空の場合にtrueを返します。
|
|
toString()
この矩形領域を文字列として返します。
|
|
この矩形領域を表すURLパラメータ用の文字列を返します。
|
Method Detail
-
もう一方の矩形領域が、この矩形領域内に含まれるかどうかを返します。
- Parameters:
- {LatLngBounds} other
- 比較対象の矩形領域
- partial
- inclusive
- Returns:
- {Boolean} 含まれる場合true
-
指定した緯度経度がこの矩形領域内に含まれるかどうかを返します。
- Parameters:
- {LatLng} latlng
- 比較対象の緯度経度
- inclusive
- Returns:
- {Boolean}
-
{LatLngBounds}copy()矩形領域のcopyを返します。
- Returns:
- {LatLngBounds}
-
指定された地点を含むようにこの矩形を拡大します。
- Parameters:
- {LatLng} latlng
-
指定された割合だけ、矩形を拡大します。
- Parameters:
- {Number} rate
-
{LatLng}getCenter()矩形領域の中心緯度経度座標を返します。
- Returns:
- {LatLng}
-
矩形領域同士が重なるかどうかを判定します。
- Parameters:
- {LatLngBounds} other
- 判定対象
- {Boolean} inclusive Optional
- 線上を重なると判定する場合true
- Returns:
- {Boolean} 重なる場合true
-
この矩形が空の場合にtrueを返します。
- Returns:
- {Boolean}
-
この矩形領域を文字列として返します。
- Returns:
- {String}
-
この矩形領域を表すURLパラメータ用の文字列を返します。
- Returns:
- {String}
Class MapConfigure
地図操作設定
Class Summary
属性 | クラス名と説明 |
---|---|
Field Summary
属性 | フィールド名と説明 |
---|---|
<static> |
MapConfigure.continuousZoom
ズーム時に、滑らかなアニメーション処理を有効にします。デフォルトはfalseです。
|
<static> |
MapConfigure.doubleClickZoom
ダブルクリックで地図のズームインを有効にします。デフォルトはfalseです。
|
<static> |
MapConfigure.dragging
ドラッグ操作で地図を移動可能にします。デフォルトはtrueです。
|
<static> |
MapConfigure.enableFlickScroll
マウス,タッチパネルを短時間で弾いた際に慣性スクロールさせます。デフォルトはtrueです。
|
<static> |
MapConfigure.enableOpenStreetMap
OpenStreetMap提供の地図レイヤーセットを使えるようにします。デフォルトはfalseです。
|
<static> |
MapConfigure.hybridPhoto
航空写真レイヤーセットを写真と注記のハイブリッド表示とします。デフォルトはfalseです。
|
<static> |
MapConfigure.mapType
地図のタイプを設定します。
Map.TYPEのいずれかの値を設定します。 PCの場合デフォルトはY.Map.TYPE.STANDARDです。 スマートフォンの場合デフォルトはY.Map.TYPE.SMARTPHONEです。 |
<static> |
MapConfigure.scrollWheelZoom
マウスのスクロールホイールによるズーム処理を有効にします。デフォルトはfalseです。
|
<static> |
MapConfigure.singleClickPan
シングルクリックで地図を移動します。デフォルトはfalseです。
|
<static> |
MapConfigure.weatherOverlay
雨雲レーダーレイヤーを表示します。デフォルトはfalseです。
|
Class Detail
-
MapConfigure()
// 写真と注記のハイブリッド表示, シングルクリックによる地図の移動を有効にしてMapを初期化 var map = new Y.Map("map", { "configure": { "hybridPhoto": true, "singleClickPan": true } }); // 初期化済みのMapで写真と注記のハイブリッド表示を無効化 map.setConfigure("hybridPhoto", false); // スマートフォン用地図を表示 map.setConfigure('mapType', Y.Map.TYPE.SMARTPHONE);
Field Detail
-
ズーム時に、滑らかなアニメーション処理を有効にします。デフォルトはfalseです。
-
ダブルクリックで地図のズームインを有効にします。デフォルトはfalseです。
-
ドラッグ操作で地図を移動可能にします。デフォルトはtrueです。
-
マウス, タッチパネルを短時間で弾いた際に慣性スクロールさせます。デフォルトはtrueです。
-
OpenStreetMap提供の地図レイヤーセットを使えるようにします。デフォルトはfalseです。
-
航空写真レイヤーセットを写真と注記のハイブリッド表示とします。デフォルトはfalseです。
-
地図のタイプを設定します。
Map.TYPEのいずれかの値を設定します。
PCの場合デフォルトはY.Map.TYPE.STANDARDです。
スマートフォンの場合デフォルトはY.Map.TYPE.SMARTPHONEです。
-
マウスのスクロールホイールによるズーム処理を有効にします。デフォルトはfalseです。
-
シングルクリックで地図を移動します。デフォルトはfalseです。
-
雨雲レーダーレイヤーを表示します。デフォルトはfalseです。
Class LayerSetId
レイヤーセットID
Class Summary
属性 | クラス名と説明 |
---|---|
レイヤーセットID
Map.drawMap、Map.setLayerSetで指定可能なレイヤーセットIDのデフォルト値が定義されています。 |
Field Summary
属性 | フィールド名と説明 |
---|---|
<static> <constant> |
LayerSetId.B1
地下街のレイヤーセットID。
|
<static> <constant> |
LayerSetId.EARTHQUAKEPHOTO
震災航空写真のレイヤーセットID。
|
<static> <constant> |
LayerSetId.NORMAL
標準地図のレイヤーセットID。
|
<static> <constant> |
LayerSetId.OSM
OpenStreetMap提供地図のレイヤーセットID。
|
<static> <constant> |
LayerSetId.PHOTO
航空写真のレイヤーセットID。
|
Class Detail
-
LayerSetId()レイヤーセットID
Map.drawMap、Map.setLayerSetで指定可能なレイヤーセットIDのデフォルト値が 定義されています。
//地図レイヤーセットで初期化。 map.drawMap(new Y.LatLng(35.665627,139.730738), 3, Y.LayerSetId.NORMAL); //写真レイヤーセットへ変更。 map.setLayerSet( Y.LayerSetId.PHOTO );
Field Detail
-
地下街のレイヤーセットID。
-
震災航空写真のレイヤーセットID。
-
標準地図のレイヤーセットID。
-
OpenStreetMap提供地図のレイヤーセットID。
-
航空写真のレイヤーセットID。
Class YDF
YDF(YOLP Data Format)
Class Summary
属性 | クラス名と説明 |
---|---|
YDF()
YOLP内で扱う、データの統一フォーマットです。
|
Field Summary
属性 | フィールド名と説明 |
---|---|
features
地物の配列です。Featureを参照。
|
|
YDFのFeatureを解析してオブジェクトに変換する。Featureを参照。
|
|
API実行結果です。
|
Field Detail
-
地物の配列です。Featureを参照。
-
YDFのFeatureを解析してオブジェクトに変換する。Featureを参照。
-
API実行結果です。
- {Number} count
- {Number} total
- {Number} start
- {Number} end
- {String} description
- {LatLngBounds} bounds
Class InfoWindow
吹きだし
Class Summary
属性 | クラス名と説明 |
---|---|
InfoWindow(container, position, content, options)
地図上に表示される吹きだしです。
|
Method Summary
属性 | メソッド名と説明 |
---|---|
ウィンドウを最大化します。
|
|
吹きだしの最大サイズを返します。
|
|
hide()
吹きだしを非表示にします。
|
|
isHidden()
吹きだしが表示中かを返します。
|
|
maximize()
情報ウィンドウを最大化します。
|
|
restore()
最大化された情報ウィンドウを元の大きさに戻します。
|
|
show()
吹きだしを表示します。
|
Event Summary
close()
吹きだしがクローズされたときに発生します。
|
|
load()
吹き出しがロードされたときに発生します。
|
Class Detail
-
InfoWindow(container, position, content, options)地図上に表示される吹きだしです。
- Parameters:
- {Node} container
- 吹きだしの親となるDOMノード
- {Point} position
- 吹きだしの表示位置
- {String|Node} content
- 吹きだしの内容となるHTML文字列もしくはDOMノード
- {Object} options
- 吹きだし表示オプション
Method Detail
-
ウィンドウを最大化します。
-
吹きだしの最大サイズを返します。
-
吹きだしを非表示にします。
-
吹きだしが表示中かを返します。
- Returns:
- {Boolean} hidden 非表示の場合True
-
情報ウィンドウを最大化します。
-
最大化された情報ウィンドウを元の大きさに戻します。
-
吹きだしを表示します。
Event Detail
Class Projection
投影変換
Class Summary
属性 | クラス名と説明 |
---|---|
地図投影の変換を行うためのインターフェース仕様です。地理座標と地図画像のピクセル座標を相互に変換するための関数が定義されています。
|
Method Summary
属性 | メソッド名と説明 |
---|---|
fromLatLngToPixel(latlng, zoom)
指定された地理座標とズームレベルに対応するピクセル座標で返します。
|
|
fromPixelToLatLng(pixel, zoom)
指定されたピクセル座標とズームレベルに対応する地理座標を返します。
|
|
getWrapWidth(zoom)
x方向のピクセル数を返します。
|
Method Detail
-
{Point}fromLatLngToPixel(latlng, zoom)指定された地理座標とズームレベルに対応するピクセル座標で返します。
- Parameters:
- {LatLng} latlng
- {Number} zoom
- Returns:
- {Point} pixel
-
{LatLng}fromPixelToLatLng(pixel, zoom)指定されたピクセル座標とズームレベルに対応する地理座標を返します。
- Parameters:
- {Number} zoom
- Returns:
- {Number} pixel
Class MercatorProjection
メルカトル投影変換
Class Summary
属性 | クラス名と説明 |
---|---|
MercatorProjection(tileSize, options)
|
Method Summary
属性 | メソッド名と説明 |
---|---|
fromLatLngToPixel(latlng, zoom)
緯度経度からピクセル単位へ変換します。
|
|
fromPixelToLatLng(pixel, zoom, unbounded)
ピクセルから緯度経度へ変換します。
|
|
getWrapWidth(zoom)
x方向のピクセル数を返します。
|
|
resolution(zoom)
指定ズームレベルでのタイル一枚あたりの距離(m)を返します。
|
Class Detail
-
MercatorProjection(tileSize, options)メルカトル図法に基づいた座標の変換を提供します。
- Parameters:
- {Number} tileSize
- タイル一枚あたりの大きさ
- {Object} options
- オプション(earthRadius=地球の半径)
Method Detail
-
緯度経度からピクセル単位へ変換します。
- Parameters:
- latlng
- zoom
-
ピクセルから緯度経度へ変換します。
- Parameters:
- pixel
- zoom
- unbounded
-
x 方向のピクセル数を返します。
- Parameters:
- {Number} zoom
- Returns:
- {Number} pixel
-
指定ズームレベルでのタイル一枚あたりの距離(m)を返します。
- Parameters:
- {Number} zoom
- Returns:
- {Number} distance
Class Event
イベント
Class Summary
属性 | クラス名と説明 |
---|---|
Event()
API内で使用可能なカスタムイベントの作成、登録、削除、実行を行います。
|
Method Summary
属性 | メソッド名と説明 |
---|---|
<static> |
Event.addListener(source, type, method, object)
イベントを設定します。
|
<static> |
Event.removeListener()
Event.addListenerで追加したイベントを削除します。
|
<static> |
Event.trigger(source, type, message)
イベントを発生させます。
|
Method Detail
-
イベントを設定します。
- Parameters:
- {Object} source
- イベントが設定されるオブジェクト
- {String} type
- イベントの種別
- {Function} method
- イベント発生時に実行される処理
- {Object} object Optional
- イベント実行時のスコープとなる(thisになる)オブジェクト
- Returns:
- {EventListener}
-
Event.addListenerで追加したイベントを削除します。
- Parameters:
- {EventListener} Event.addListenerの戻り値
-
イベントを発生させます。
// 地図上に追加したmarkerからcustomというイベントを発生させる var marker = new Y.Marker(map.getCenter()); marker.bind("custom", function(message) { alert("custom event message: " + message); }); map.addFeature(marker); setTimeout(function() { Y.Event.trigger(marker, "custom", "myMessage"); }, 2000);
- Parameters:
- {Object} source
- イベントを発生させるオブジェクト
- {String} type
- 発生させるイベントの種別
- {Object} message Optional
- イベント通知時に引数として渡したい変数
Class EventListener
イベントリスナー
Class Summary
属性 | クラス名と説明 |
---|---|
Eventで登録されたイベントを表すオブジェクトです。Event.removeListenerに渡してイベントを削除することが可能です。
|