YOLP(地図):Baseクラス - Yahoo!デベロッパーネットワーク

Class Point

ピクセル座標

Class Summary

属性	クラス名と説明
	Point(x, y) Pointはピクセル座標で地図上の地点を表します。緯度経度で地点の地理座標を表す場合は、LatLngクラスを使用します。

Field Summary

属性	フィールド名と説明
	x x座標
	y 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

{Number}x

x座標

{Number}y

y座標

Method Detail

{Point}copy()

ピクセル座標オブジェクトのコピーを返します。

Returns:: {Point}

{Boolean}equals(others)

他の地点と座標が同じ場合に、trueを返します。

Parameters:
{Point} others

Returns:: {Boolean}

{String}toString()

x座標とy座標を「,」で区切られたテキスト形式で出力します。

Returns:: {String}

このページのトップへ

Class Size

ピクセルサイズ

Class Summary

属性	クラス名と説明
	Size(width, height) 矩形サイズをピクセル座標で表します。

Field Summary

属性	フィールド名と説明
	height 高さ
	width 幅

Method Summary

属性	メソッド名と説明
	equals(other) 他のサイズオブジェクトと同じ場合にtrueを返します。
	toString() widthとheightを「,」で区切られたテキストで返します。

Class Detail

Size(width, height)

矩形サイズをピクセル座標で表します。

Parameters:
{Number} width: 短形サイズの幅
{Number} height: 短形サイズの高さ

Field Detail

{Number}height

高さ

{Number}width

幅

Method Detail

{Boolean}equals(other)

他のサイズオブジェクトと同じ場合にtrueを返します。

Parameters:
{Size} other

Returns:: {Boolean}

{String}toString()

widthとheightを「,」で区切られたテキストで返します。

Returns:: {String}

このページのトップへ

Class Bounds

ピクセル矩形領域

Class Summary

属性	クラス名と説明
	Bounds(points) 矩形の領域をピクセル単位で管理します。緯度経度での地理座標領域にはLatLngBoundsを使用します。

Field Summary

属性	フィールド名と説明
	maxX 矩形右端のx座標
	maxY 矩形上端のy座標
	minX 矩形左端のx座標
	minY 矩形下端の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

{Number}maxX

矩形右端のx座標

{Number}maxY

矩形上端のy座標

{Number}minX

矩形左端のx座標

{Number}minY

矩形下端のy座標

Method Detail

{Boolean}containsBounds(other, partial, inclusive)

渡された矩形領域がこの矩形領域全体に含まれる場合にtrueを返します。

Parameters:
{Bounds} other
{Boolean} partial: 部分の重なりも評価する(default: false)
{Boolean} inclusive: 同一座標も評価する(default: true)

Returns:: {Boolean}

{Boolean}containsPoint(point)

渡されたピクセル座標がこの矩形領域内に含まれる場合にtrueを返します。

Parameters:
{Point} point

Returns:: {Boolean}

{Boolean}equals(other)

この矩形と等しい場合に、trueを返します。

Parameters:
{Bounds} other

Returns:: {Boolean}

{Boolean}intersect(other, inclusive)

矩形領域同士が重なるかどうかを判定します。

Parameters:
{Bounds} other: 判定対象
{Boolean} inclusive Optional: 線上を重なると判定する場合true

Returns:: {Boolean} 重なる場合true

{Point}max()

矩形領域の右下座標を返します。

Returns:: {Point}

{Point}mid()

矩形領域の中心座標を返します。

Returns:: {Point}

{Point}min()

矩形領域の左上座標を返します。

Returns:: {Point}

{String}toString()

矩形領域の左上の頂点と右下の頂点の座標を、「,」で区切られたテキスト形式で返します。

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() 緯度を返します。
	latRadians() 緯度のラジアン（rad）を返します。
	lng() 経度を返します。
	lngRadians() 経度のラジアン（rad）を返します。
	toString() この緯度経度座標を表す文字列を返します。
	toUrlValue() URLパラメータ用の文字列に変換します。

Class Detail

LatLng(lat, lng)

地点の地理座標（緯度経度）を表します。

Parameters:
{Number} lat
{Number} lng

Method Detail

{LatLng}copy()

緯度経度オブジェクトのコピーを返します。

Returns:: {LatLng}

{Number}distance(other)

2点間の距離をkm単位で返します。

Parameters:
{LatLng} other: 計測対象の緯度経度

Returns:: {Number} distance 距離（km）

{Booelan}equals(p)

もう一方の緯度経度と同じ値の場合にtrueを返します。

Parameters:
p

Returns:: {Booelan}

<static> {LatLng}LatLng.fromString(latitudeString, longitudeString)

（35/44/24, 139/24/22）のような文字列から緯度経度を構築します。

Parameters:
{String} latitudeString: 緯度を表す文字列
{String} longitudeString: 経度を表す文字列

Returns:: {LatLng} 生成された緯度経度オブジェクト

<static> LatLng.fromUrlValue(val)

URLパラメータから緯度経度を構築します。

Parameters:
val

{Number}lat()

緯度を返します。

Returns:: {Number}

{Double}latRadians()

緯度のラジアン（rad）を返します。

Returns:: {Double} 緯度のラジアン（rad）

{Number}lng()

経度を返します。

Returns:: {Number}

{Double}lngRadians()

経度のラジアン（rad）を返します。

Returns:: {Double} 緯度のラジアン（rad）

{String}toString()

この緯度経度座標を表す文字列を返します。

Returns:: {String}

toUrlValue()

URLパラメータ用の文字列に変換します。

このページのトップへ

Class LatLngBounds

地理座標矩形領域

Class Summary

属性	クラス名と説明
	LatLngBounds(sw, ne) 地理座標で矩形領域を表します。

Method Summary

属性	メソッド名と説明
	containsBounds(other, partial, inclusive) もう一方の矩形領域が、この矩形領域内に含まれるかどうかを返します。
	containsLatLng(latlng, inclusive) 指定した緯度経度がこの矩形領域内に含まれるかどうかを返します。
	copy() 矩形領域のcopyを返します。
	extend(latlng) 指定された地点を含むようにこの矩形を拡大します。
	extendRate(rate) 指定された割合だけ、矩形を拡大します。
	getCenter() 矩形領域の中心緯度経度座標を返します。
	getNorthEast() 矩形の北東の頂点の位置を返します。
	getSouthWest() 矩形の南西の頂点の位置を返します。
	intersect(other, inclusive) 矩形領域同士が重なるかどうかを判定します。
	isEmpty() この矩形が空の場合にtrueを返します。
	toString() この矩形領域を文字列として返します。
	toUrlValue() この矩形領域を表すURLパラメータ用の文字列を返します。

Class Detail

LatLngBounds(sw, ne)

地理座標で矩形領域を表します。

Parameters:
{LatLng} sw: 南西の地理座標
{LatLng} ne: 北東の地理座標

Method Detail

{Boolean}containsBounds(other, partial, inclusive)

もう一方の矩形領域が、この矩形領域内に含まれるかどうかを返します。

Parameters:
{LatLngBounds} other: 比較対象の矩形領域
partial
inclusive

Returns:: {Boolean} 含まれる場合true

{Boolean}containsLatLng(latlng, inclusive)

指定した緯度経度がこの矩形領域内に含まれるかどうかを返します。

Parameters:
{LatLng} latlng: 比較対象の緯度経度
inclusive

Returns:: {Boolean}

{LatLngBounds}copy()

矩形領域のcopyを返します。

Returns:: {LatLngBounds}

extend(latlng)

指定された地点を含むようにこの矩形を拡大します。

Parameters:
{LatLng} latlng

extendRate(rate)

指定された割合だけ、矩形を拡大します。

Parameters:
{Number} rate

{LatLng}getCenter()

矩形領域の中心緯度経度座標を返します。

Returns:: {LatLng}

{LatLng}getNorthEast()

矩形の北東の頂点の位置を返します。

Returns:: {LatLng}

{LatLng}getSouthWest()

矩形の南西の頂点の位置を返します。

Returns:: {LatLng}

{Boolean}intersect(other, inclusive)

矩形領域同士が重なるかどうかを判定します。

Parameters:
{LatLngBounds} other: 判定対象
{Boolean} inclusive Optional: 線上を重なると判定する場合true

Returns:: {Boolean} 重なる場合true

{Boolean}isEmpty()

この矩形が空の場合にtrueを返します。

Returns:: {Boolean}

{String}toString()

この矩形領域を文字列として返します。

Returns:: {String}

{String}toUrlValue()

この矩形領域を表すURLパラメータ用の文字列を返します。

Returns:: {String}

このページのトップへ

Class MapConfigure

地図操作設定

Class Summary

属性	クラス名と説明
	MapConfigure() 地図操作の設定を定義します。初期化時の設定はMapクラスのコンストラクタ―オプション、初期化後の設定はMap.setConfigureメソッドを用います。

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クラスのコンストラクタ―オプション、
初期化後の設定はMap.setConfigureメソッドを用います。

 // 写真と注記のハイブリッド表示, シングルクリックによる地図の移動を有効にして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

<static> {Boolean}MapConfigure.continuousZoom

ズーム時に、滑らかなアニメーション処理を有効にします。デフォルトはfalseです。

<static> {Boolean}MapConfigure.doubleClickZoom

ダブルクリックで地図のズームインを有効にします。デフォルトはfalseです。

<static> {Boolean}MapConfigure.dragging

ドラッグ操作で地図を移動可能にします。デフォルトはtrueです。

<static> {Boolean}MapConfigure.enableFlickScroll

マウス, タッチパネルを短時間で弾いた際に慣性スクロールさせます。デフォルトはtrueです。

<static> {Boolean}MapConfigure.enableOpenStreetMap

OpenStreetMap提供の地図レイヤーセットを使えるようにします。デフォルトはfalseです。

<static> {Boolean}MapConfigure.hybridPhoto

航空写真レイヤーセットを写真と注記のハイブリッド表示とします。デフォルトはfalseです。

<static> {String}MapConfigure.mapType

地図のタイプを設定します。
Map.TYPEのいずれかの値を設定します。
PCの場合デフォルトはY.Map.TYPE.STANDARDです。
スマートフォンの場合デフォルトはY.Map.TYPE.SMARTPHONEです。

<static> {Boolean}MapConfigure.scrollWheelZoom

マウスのスクロールホイールによるズーム処理を有効にします。デフォルトはfalseです。

<static> {Boolean}MapConfigure.singleClickPan

シングルクリックで地図を移動します。デフォルトはfalseです。

<static> {Boolean}MapConfigure.weatherOverlay

雨雲レーダーレイヤーを表示します。デフォルトはfalseです。

このページのトップへ

Class LayerSetId

レイヤーセットID

Class Summary

属性	クラス名と説明
	LayerSetId() レイヤーセット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

<static> <constant> {String}LayerSetId.B1

地下街のレイヤーセットID。

<static> <constant> {String}LayerSetId.EARTHQUAKEPHOTO

震災航空写真のレイヤーセットID。

<static> <constant> {String}LayerSetId.NORMAL

標準地図のレイヤーセットID。

<static> <constant> {String}LayerSetId.OSM

OpenStreetMap提供地図のレイヤーセットID。

<static> <constant> {String}LayerSetId.PHOTO

航空写真のレイヤーセットID。

このページのトップへ

Class YDF

YDF（YOLP Data Format）

Class Summary

属性	クラス名と説明
	YDF() YOLP内で扱う、データの統一フォーマットです。

Field Summary

属性	フィールド名と説明
	features 地物の配列です。Featureを参照。
	features YDFのFeatureを解析してオブジェクトに変換する。Featureを参照。
	result API実行結果です。 {Number}count {Number}total {Number}start {Number}end {String}description {LatLngBounds}bounds

Class Detail

YDF()

YOLP内で扱う、データの統一フォーマットです。

Field Detail

{ArrayOfFeature}features

地物の配列です。Featureを参照。

{ArrayOfFeature}features

YDFのFeatureを解析してオブジェクトに変換する。Featureを参照。

{Object}result

API実行結果です。

{Number} count
{Number} total
{Number} start
{Number} end
{String} description
{LatLngBounds} bounds

このページのトップへ

Class InfoWindow

吹きだし

Class Summary

属性	クラス名と説明
	InfoWindow(container, position, content, options) 地図上に表示される吹きだしです。

Method Summary

属性	メソッド名と説明
	createMaxWindow() ウィンドウを最大化します。
	getMaxSize() 吹きだしの最大サイズを返します。
	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

吹きだし表示オプション

{String} type: 吹きだしの表示タイプ
{String} image: 吹きだしの元になる画像URL
{String} maxContent: 吹きだし最大化時に表示する内容
{Boolean} maximize: 吹きだしを最大化して表示

Method Detail

createMaxWindow()

ウィンドウを最大化します。

getMaxSize()

吹きだしの最大サイズを返します。

hide()

吹きだしを非表示にします。

{Boolean}isHidden()

吹きだしが表示中かを返します。

Returns:: {Boolean} hidden 非表示の場合True

maximize()

情報ウィンドウを最大化します。

restore()

最大化された情報ウィンドウを元の大きさに戻します。

show()

吹きだしを表示します。

Event Detail

close()

吹きだしがクローズされたときに発生します。

load()

吹き出しがロードされたときに発生します。

このページのトップへ

Class Projection

投影変換

Class Summary

属性	クラス名と説明
	Projection() 地図投影の変換を行うためのインターフェース仕様です。地理座標と地図画像のピクセル座標を相互に変換するための関数が定義されています。

Method Summary

属性	メソッド名と説明
	fromLatLngToPixel(latlng, zoom) 指定された地理座標とズームレベルに対応するピクセル座標で返します。
	fromPixelToLatLng(pixel, zoom) 指定されたピクセル座標とズームレベルに対応する地理座標を返します。
	getWrapWidth(zoom) x方向のピクセル数を返します。

Class Detail

Projection()

地図投影の変換を行うためのインターフェース仕様です。地理座標と地図画像のピクセル座標を相互に変換するための関数が定義されています。

Method Detail

{Point}fromLatLngToPixel(latlng, zoom)

指定された地理座標とズームレベルに対応するピクセル座標で返します。

Parameters:
{LatLng} latlng
{Number} zoom

Returns:: {Point} pixel

{LatLng}fromPixelToLatLng(pixel, zoom)

指定されたピクセル座標とズームレベルに対応する地理座標を返します。

Parameters:
{Point} pixel
{Number} zoom

Returns:: {LatLng} latlng

{Number}getWrapWidth(zoom)

x 方向のピクセル数を返します。

Parameters:
{Number} zoom

Returns:: {Number} pixel

このページのトップへ

Class MercatorProjection

メルカトル投影変換

Class Summary

属性	クラス名と説明
	MercatorProjection(tileSize, options) メルカトル図法に基づいた座標の変換を提供します。 Projectionクラスを継承しています。

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

fromLatLngToPixel(latlng, zoom)

緯度経度からピクセル単位へ変換します。

Parameters:
latlng
zoom

fromPixelToLatLng(pixel, zoom, unbounded)

ピクセルから緯度経度へ変換します。

Parameters:
pixel
zoom
unbounded

{Number}getWrapWidth(zoom)

x 方向のピクセル数を返します。

Parameters:
{Number} zoom

Returns:: {Number} pixel

{Number}resolution(zoom)

指定ズームレベルでのタイル一枚あたりの距離（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) イベントを発生させます。

Class Detail

Event()

API内で使用可能なカスタムイベントの作成、登録、削除、実行を行います。

Method Detail

<static> {EventListener}Event.addListener(source, type, method, object)

イベントを設定します。

Parameters:
{Object} source: イベントが設定されるオブジェクト
{String} type: イベントの種別
{Function} method: イベント発生時に実行される処理
{Object} object Optional: イベント実行時のスコープとなる（thisになる）オブジェクト

Returns:: {EventListener}

<static> Event.removeListener()

Event.addListenerで追加したイベントを削除します。

Parameters:
{EventListener} Event.addListenerの戻り値

<static> Event.trigger(source, type, message)

イベントを発生させます。

 // 地図上に追加した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: イベント通知時に引数として渡したい変数

このページのトップへ

Baseクラス

Class Point

Class Summary

Field Summary

Method Summary

Class Detail

Field Detail

Method Detail

Class Size

Class Summary

Field Summary

Method Summary

Class Detail

Field Detail

Method Detail

Class Bounds

Class Summary

Field Summary

Method Summary

Class Detail

Field Detail

Method Detail

Class LatLng

Class Summary

Method Summary

Class Detail

Method Detail

Class LatLngBounds

Class Summary

Method Summary

Class Detail

Method Detail

Class MapConfigure

Class Summary

Field Summary

Class Detail

Field Detail

Class LayerSetId

Class Summary

Field Summary

Class Detail

Field Detail

Class YDF

Class Summary

Field Summary

Class Detail

Field Detail

Class InfoWindow

Class Summary

Method Summary

Event Summary

Class Detail

Method Detail

Event Detail

Class Projection

Class Summary

Method Summary

Class Detail

Method Detail

Class MercatorProjection

Class Summary

Method Summary

Class Detail

Method Detail

Class Event

Class Summary

Method Summary

Class Detail

Method Detail

Class EventListener

Class Summary

Class Detail

はじめよう

目次

開発のヒント

プラットフォーム

開発ツール

Web APIとその他サービス