詳細は Documentation - Leaflet #Map を熟読のこと。
L.map(IDstring[, MapOptions)
第1引数にはマップを保持させたいHTML要素(おそらく div)につけた id 属性の値(文字列)で、省略可能な第2引数にはマップオプションを与える。
主要なものを抜粋する。 確認
| プロパティ | 意味 | 既定値 |
|---|---|---|
zoomControl |
ズーム制御をつけるか | true |
closePopupOnClick |
マップクリックでポップアップを閉じるか | false |
doubleClickZoom |
(SHIFT+)ダブルクリックでのズーム(アウト)インをするか (クリックイベント捕捉処理をするときにはfalseにした方がよい場合もある) |
true |
dragging | マウスドラッグでのスクロール可能か | true |
minZoom | 最小ズームレベル | undefined |
maxZoom | 最大ズームレベル | undefined |
maxBound |
表示可能領域を LatLngBounds オブジェクトで指定する |
null |
inertiaDeceleration |
タップ/ドラッグスクロールで惰性スクロールの減速速度を 「ピクセル/秒」で指定する | null |
keyboard |
矢印キーや + - キーでのナビゲーションを許可するか | true |
keyboardPanDelta |
矢印キーでの移動量をピクセル値で指定する | 80 |
scrollWheelZoom |
マウススクロールでのズームを許すか (ページ内マップの場合は禁止の方がよいこともある) |
true |
| | |
| | |
| |
マップ全体を対象として発生するイベントを示す。
| イベント | 発生時 |
|---|---|
baselayerchange |
ベースレイヤが変更されとき |
overlayadd |
レイヤコントロールでオーバーレイが選択されたとき |
overlayremove |
レイヤコントロールでオーバーレイが外されたとき |
layeradd |
マップにレイヤが足されたとき |
layerremove |
マップからレイヤが削除されたとき |
zoomlevelschange | ズームレベル変更 |
resize | マップがリサイズされたとき |
unload | removeメソッドでマップが除去されたとき |
viewreset |
ズーム等でマップ再描画が必要になったとき |
load | マップが最初にロードされたとき |
zoomstart | ズームレベル変更開始時 |
zoom | ズームレベル変更中中随時 |
zoomend | ズームレベル変更終了時 |
movestart | 地図のスクロール開始時 |
move | 地図のスクロール中随時 |
moveend | 地図のスクロール終了時 |
popupopen | マップ中のポップアップが開かれたとき |
popupclose | マップ中のポップアップが閉じられたとき |
autopanstart |
ポップアップを開くことによる自動パン(ずらし)が始まったとき |
tooltipopen | 地図のスクロール開始時 |
popupopen |
地図中のツールボックスが開かれたとき |
popupclose |
地図中のツールボックスが閉じられたとき |
locationerror |
geolocationによる位置取得が失敗したとき |
locationfound |
geolocationによる位置取得が成功したとき |
click | マップ内がクリックされたとき |
dblclick | マップ内がダブルクリックされたとき |
mousedown | マップ内でマウスボタンが押されたとき |
mouseup | マップ内でマウスボタンが離された |
mouseover | マップ内にマウスポインタが入ったとき |
mouseout | マップ内からマウスポインタが出たとき |
mousemove | マップ内でマウスポインタが動いたとき |
contextmenu | マップ内で右クリック(モバイルデバイスの場合は長タップ)されたとき |
keypress |
マップにフォーカスがある状態でキーが押されたとき |
preclick |
マップ内での他のクリックイベントに先立って実行したいハンドラを呼ぶためのイベント |
L.map での主要なメソッドを抜粋する。
| メソッド | 働き |
|---|---|
addControl(Ctrl) |
マップに、コントロールである Ctrl を追加する。 コントロールには、ズーム制御、アトリビューション表示、レイヤ制御、 スケール表示がある。 |
removeControl(Ctrl) |
マップから、コントロールである Ctrl を削除する。 |
addLayer(Lyr) |
マップに、レイヤ Lyr を追加する。 |
removeLayer(Lyr) |
マップから、レイヤ Lyr を削除する。 |
haseLayer(Lyr) |
マップに、レイヤ Lyr が足されていれば true
を、いなければ false を返す。 |
eachLayer(Func[, Context]) |
マップ上の各レイヤに対して関数 Func を呼ぶ。関数の第1引数にレイヤが渡される。 |
openPopup(pup) |
指定したポップアップ pup を開く。別のポップアップが開いていたら閉じる。 |
openPopup(Cntnt, latlng[, PuPoptions]) |
文字列、またはHTML要素で指定した Cntnt を内容とするポップアップを latlnt の位置に出す。 省略可能な第3引数にはポップアップオプションを指定できる。 |
closePopup([pup]) |
指定したポップアップ pup (省略時は最後に開いたポップアップ) を閉じる。 |
openTooltip(ttp) |
指定したツールチップ(自動吹き出し) ttp を開く。 |
openTooltip(Cntnt, latlng[, Ttpoptions]) |
文字列、またはHTML要素で指定した Cntnt を内容とするポップアップを latlnt の位置に出す。 省略可能な第3引数にはツールチップオプションを指定できる。 |
closeTooltip([ttp]) |
指定したツールチップ ttp を閉じる。 |
| メソッド | 働き |
|---|---|
setView(latlng, z[, zpOpt]) |
地図の中心を latlng、ズームレベルを z
に設定する。省略可能な第3引数 zpOpt
には以下のプロパティが指定できる。
|
setZoom(z[, zpOpt]) |
地図のズームレベルを z にする。 |
zoomIn([d]) |
ズームレベルを d (省略時はマップ生成時の zoomDelta)段階上げる。 |
zoomOut([d]) |
ズームレベルを d (省略時はマップ生成時の zoomDelta)段階下げる。 |
setZoomAround(latlng, z[, zpOpt]) |
マップ上の latlng のみかけ上の位置を保ったまま ズームレベル z に移行する。 |
setZoomAround(point, z[, zpOpt]) |
マップ上の、L.pointで指定したピクセル位置
point のみかけ上の位置を保ったまま
ズームレベル z に移行する。 |
fitBounds(latlngBnd[, fbOpt])
| LatLngBounds 形式で指定した latlngBnd
2点を含む位置で最大のズームレベルに(可能なら)設定する。
fbOpt は zpOpt
に加え以下のプロパティが指定できる。
|
flyToBounds(latlngBnd[, fbOpt])
| fitBounds()
と同様だが空を飛ぶようなアニメーションで設定する。 |
fitWorld([fbOpt])
| 地球全体を含むズームレベルにする。 |
panTo(latlng[, panOpt]) |
指定した場所 latlng に地図をずらす。 |
flyTo(latlng[, z[, panOpt]]) |
指定した場所 latlng (とズームレベルz) に飛ぶようにして地図をずらす。 |
panBy(offset) |
L.point 形式で指定したピクセル数 offset
だけ地図をずらす。 |
setMinZoom(z) |
地図の最小ズームレベルを z にする。 |
setMaxZoom(z) |
地図の最大ズームレベルを z にする。 |
|
| メソッド | 働き |
|---|---|
locate([locOpt]) |
位置情報追跡を開始する。 |
stopLocate |
locOpt には以下のオプションが指定できる。
| プロパティ | 型 | 既定値 | 意味 |
|---|---|---|---|
watch | Boolean | false | 継続して追跡するか(停めるには map.stopLocate()
を使用する) |
setView | Boolean | false | 自動的に捕捉した位置に地図を移動するか |
maxZoom | Number | Infinity | setView が true
の場合の最大ズームレベル |
timeout | Number | 10000 | 位置捕捉を諦めて locationerror イベントを発するまでの時間(ミリ秒) |
maximumAge | Number | 0 | キャッシュされた位置情報の有効期限(ミリ秒) |
enableHighAccuracy | Boolean | false | 高精度捕捉にするか |
| メソッド | 働き | |
|---|---|---|
getCenter() |
地図の表示中心の LatLng 値 | |
getZoom() | 現在のズームレベル値 | |
getBounds() |
現在の表示領域の ||
getPixelBounds() |
現在の表示領域の Point 値(ピクセル) | |
getMinZoom() |
地図に設定されている最小ズーム値(無設定なら0) | |
getMaxZoom() |
地図に設定されている最大ズーム値(無設定なら0) | |
getSize() | 地図コンテナのサイズ(ピクセル) |
| メソッド | 働き |
|---|---|
addHandler(evName, Func) |
evName で示されるイベント発生時のハンドラに関数 Func を足す |
remove() | 地図と関連オブジェクトを消失させる |