Leaflet API リファレンス
このリファレンスはLeaflet を反映しています。Leaflet の異なるバージョンを使用している場合は、こちらのリストを確認してください。
UIレイヤー
ラスターレイヤー
ベクターレイヤー
その他のレイヤー
基本型
コントロール
基本クラス
その他
マップ
API の中心となるクラス — ページ上にマップを作成し、操作するために使用されます。
使用例
// initialize the map on the "map" div with a given center and zoom
var map = L.map('map', {
center: [51.505, -0.09],
zoom: 13
});
作成
ファクトリ | 説明 |
---|---|
L.map( |
<div> 要素の DOM ID と、必要に応じてマップオプション を含むオブジェクトリテラルを指定して、マップオブジェクトをインスタンス化します。 |
L.map( |
<div> HTML要素のインスタンスと、必要に応じてマップオプション を含むオブジェクトリテラルを指定して、マップオブジェクトをインスタンス化します。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
preferCanvas |
ブール値 |
false |
Path をCanvas レンダラーでレンダリングするかどうか。デフォルトでは、すべてのPath はSVG レンダラーでレンダリングされます。 |
コントロールオプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
attributionControl |
ブール値 |
true |
デフォルトでアトリビューションコントロールをマップに追加するかどうか。 |
zoomControl |
ブール値 |
true |
デフォルトでズームコントロールをマップに追加するかどうか。 |
インタラクションオプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
closePopupOnClick |
ブール値 |
true |
ユーザーがマップをクリックしたときにポップアップを閉じたくない場合は、false に設定します。 |
boxZoom |
ブール値 |
true |
Shift キーを押しながらマウスをドラッグして指定した矩形領域にマップをズームできるかどうか。 |
doubleClickZoom |
ブール値|文字列 |
true |
マップをダブルクリックしてズームインし、Shift キーを押しながらダブルクリックしてズームアウトできるかどうか。'center' を渡した場合、ダブルクリックズームはマウスの位置に関係なく、ビューの中心にズームします。 |
dragging |
ブール値 |
true |
マウス/タッチでマップをドラッグ可能にするかどうか。 |
zoomSnap |
数値 |
1 |
特にfitBounds() またはピンチズーム直後に、マップのズームレベルを常にこの倍数になるように強制します。デフォルトでは、ズームレベルは最も近い整数にスナップします。より低い値 (例: 0.5 または 0.1 ) では、より高い粒度が可能になります。0 の値は、fitBounds またはピンチズーム後にズームレベルがスナップされないことを意味します。 |
zoomDelta |
数値 |
1 |
zoomIn() 、zoomOut() 、キーボードの+ または- キーを押す、またはズームコントロールを使用した後、マップのズームレベルがどれだけ変化するかを制御します。1 より小さい値 (例: 0.5 ) では、より高い粒度が可能になります。 |
trackResize |
ブール値 |
true |
マップがブラウザウィンドウのリサイズを自動的に処理して自身を更新するかどうか。 |
パン慣性オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
inertia |
ブール値 |
* |
有効にすると、マップのパンに慣性効果が適用され、マップがドラッグ中に勢いをつけ、しばらく同じ方向に移動し続けます。特にタッチデバイスで快適に感じられます。デフォルトで有効になっています。 |
inertiaDeceleration |
数値 |
3000 |
慣性移動が減速するレート (ピクセル/秒²)。 |
inertiaMaxSpeed |
数値 |
無限大 |
慣性移動の最大速度 (ピクセル/秒)。 |
easeLinearity |
数値 |
0.2 |
|
worldCopyJump |
ブール値 |
false |
このオプションを有効にすると、マップが世界の別の「コピー」にパンしたときに追跡し、マーカーやベクターレイヤーなどのすべてのオーバーレイが引き続き表示されるように、元のコピーにシームレスにジャンプします。 |
maxBoundsViscosity |
数値 |
0.0 |
maxBounds が設定されている場合、このオプションは、マップをドラッグするときに境界がどれだけ堅牢であるかを制御します。デフォルト値の0.0 では、ユーザーは通常の速度で境界の外にドラッグできます。値が高いほど、境界外へのマップドラッグが減速し、1.0 では境界が完全に固定され、ユーザーが境界の外にドラッグできなくなります。 |
キーボードナビゲーションオプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
keyboard |
ブール値 |
true |
マップをフォーカス可能にし、ユーザーがキーボードの矢印キーと+ /- キーでマップをナビゲートできるようにします。 |
keyboardPanDelta |
数値 |
80 |
矢印キーを押したときにパンするピクセル数。 |
マウスホイールオプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
scrollWheelZoom |
ブール値|文字列 |
true |
マウスホイールを使用してマップをズームできるかどうか。'center' を渡した場合、マウスの位置に関係なく、ビューの中心にズームします。 |
wheelDebounceTime |
数値 |
40 |
ホイールが発火できるレートを制限します (ミリ秒単位)。デフォルトでは、ユーザーはホイールを介して 40 ミリ秒に 1 回より多くズームすることはできません。 |
wheelPxPerZoomLevel |
数値 |
60 |
L.DomEvent.getWheelDeltaによって報告されるように、スクロールピクセルのうち、1 つのフルズームレベルの変化を意味するピクセル数。値が小さいほど、ホイールズームが速くなります (逆も同様です)。 |
タッチインタラクションオプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
tapHold |
ブール値 |
|
contextmenu イベントのシミュレーションを有効にします。モバイル Safari ではデフォルトでtrue です。 |
tapTolerance |
数値 |
15 |
ユーザーがタッチ中に指をずらしても有効なタップと見なされるピクセル数の最大値。 |
touchZoom |
ブール値|文字列 |
* |
2 本の指でタッチドラッグしてマップをズームできるかどうか。'center' を渡した場合、タッチイベント (指) の位置に関係なく、ビューの中心にズームします。タッチ対応の Web ブラウザーで有効になっています。 |
bounceAtZoomLimits |
ブール値 |
true |
ピンチズーム時にマップが最小/最大ズームを超えてズームし、跳ね返る動作をさせたくない場合は、false に設定します。 |
マップ状態オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
crs |
CRS |
L.CRS.EPSG3857 |
使用する座標参照系。意味がわからない場合は、これを変更しないでください。 |
center |
LatLng |
未定義 |
マップの初期地理的中心 |
zoom |
数値 |
未定義 |
マップの初期ズームレベル |
minZoom |
数値 |
* |
マップの最小ズームレベル。指定されておらず、少なくとも1つのGridLayer またはTileLayer がマップにある場合、それらのminZoom オプションの最小値が代わりに使用されます。 |
maxZoom |
数値 |
* |
マップの最大ズームレベル。指定されておらず、少なくとも1つのGridLayer またはTileLayer がマップにある場合、それらのmaxZoom オプションの最大値が代わりに使用されます。 |
layers |
Layer[] |
[] |
マップに最初に追加されるレイヤーの配列 |
maxBounds |
LatLngBounds |
null |
このオプションを設定すると、マップはビューを与えられた地理的境界に制限し、ユーザーがビューの外にパンしようとするとユーザーを跳ね返します。制限を動的に設定するには、setMaxBounds メソッドを使用します。 |
renderer |
レンダラー |
* |
マップ上にベクターレイヤーを描画するためのデフォルトのメソッド。ブラウザのサポートに応じて、デフォルトではL.SVG またはL.Canvas になります。 |
アニメーションオプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
zoomAnimation |
ブール値 |
true |
マップのズームアニメーションを有効にするかどうか。デフォルトでは、Android を除く CSS3 Transitions をサポートするすべてのブラウザで有効になっています。 |
zoomAnimationThreshold |
数値 |
4 |
ズームの差がこの値を超えると、ズームをアニメーション化しません。 |
fadeAnimation |
ブール値 |
true |
タイルフェードアニメーションを有効にするかどうか。デフォルトでは、Android を除く CSS3 Transitions をサポートするすべてのブラウザで有効になっています。 |
markerZoomAnimation |
ブール値 |
true |
マーカーがズームアニメーションに合わせてズームをアニメーション化するかどうか。無効にした場合、アニメーション中はマーカーが消えます。デフォルトでは、Android を除く CSS3 Transitions をサポートするすべてのブラウザで有効になっています。 |
transform3DLimit |
数値 |
2^23 |
CSS変換変換の最大サイズを定義します。panBy を大きく行った後、Webブラウザがレイヤーを間違った場所に配置しない限り、デフォルト値を変更しないでください。 |
イベント
レイヤーイベント
イベント | データ | 説明 |
---|---|---|
baselayerchange |
LayersControlEvent |
レイヤーコントロールを介してベースレイヤーが変更されたときに発生します。 |
overlayadd |
LayersControlEvent |
レイヤーコントロールを介してオーバーレイが選択されたときに発生します。 |
overlayremove |
LayersControlEvent |
レイヤーコントロールを介してオーバーレイの選択が解除されたときに発生します。 |
layeradd |
LayerEvent |
新しいレイヤーがマップに追加されたときに発生します。 |
layerremove |
LayerEvent |
レイヤーがマップから削除されたときに発生します。 |
マップの状態変更イベント
イベント | データ | 説明 |
---|---|---|
zoomlevelschange |
イベント |
レイヤーの追加または削除により、マップのズームレベルの数が変更されたときに発生します。 |
resize |
ResizeEvent |
マップのサイズが変更されたときに発生します。 |
unload |
イベント |
removeメソッドでマップが破棄されたときに発生します。 |
viewreset |
イベント |
マップがそのコンテンツを再描画する必要がある場合に発生します (通常、マップのズームまたは読み込み時に発生します)。カスタムオーバーレイを作成するのに非常に役立ちます。 |
load |
イベント |
マップが初期化されたとき (その中心とズームが初めて設定されたとき) に発生します。 |
zoomstart |
イベント |
マップのズームが変更されようとしているとき (例: ズームアニメーションの前) に発生します。 |
movestart |
イベント |
マップのビューの変更が開始されたとき (例: ユーザーがマップのドラッグを開始したとき) に発生します。 |
zoom |
イベント |
ズームおよびフライアニメーションを含む、ズームレベルの変化中に繰り返し発生します。 |
move |
イベント |
パンおよびフライアニメーションを含む、マップのあらゆる移動中に繰り返し発生します。 |
zoomend |
イベント |
アニメーションの後に、マップのズームが変更されたときに発生します。 |
moveend |
イベント |
マップの中心の変更が停止したとき (例: ユーザーがマップのドラッグを停止したとき、または中心化されていないズームの後) に発生します。 |
ポップアップイベント
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
マップでポップアップが開かれたときに発生します。 |
popupclose |
PopupEvent |
マップ内のポップアップが閉じられたときに発生します。 |
autopanstart |
イベント |
ポップアップを開くときにマップが自動パンを開始したときに発生します。 |
ツールチップイベント
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
マップ内でツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
マップ内のツールチップが閉じられたときに発生します。 |
位置情報イベント
イベント | データ | 説明 |
---|---|---|
locationerror |
ErrorEvent |
ジオロケーション(locate メソッドを使用)が失敗したときに発生します。 |
locationfound |
LocationEvent |
ジオロケーション(locate メソッドを使用)が成功したときに発生します。 |
インタラクションイベント
イベント | データ | 説明 |
---|---|---|
click |
MouseEvent |
ユーザーがマップをクリック(またはタップ)したときに発生します。 |
dblclick |
MouseEvent |
ユーザーがマップをダブルクリック(またはダブルタップ)したときに発生します。 |
mousedown |
MouseEvent |
ユーザーがマップ上でマウスボタンを押したときに発生します。 |
mouseup |
MouseEvent |
ユーザーがマップ上でマウスボタンを離したときに発生します。 |
mouseover |
MouseEvent |
マウスがマップに入ったときに発生します。 |
mouseout |
MouseEvent |
マウスがマップから出たときに発生します。 |
mousemove |
MouseEvent |
マウスがマップ上を移動している間に発生します。 |
contextmenu |
MouseEvent |
ユーザーがマップ上で右マウスボタンを押したときに発生し、このイベントにリスナーがある場合は、ブラウザのデフォルトのコンテキストメニューの表示を防止します。また、モバイルでは、ユーザーがシングルタッチを1秒間保持したとき(長押しとも呼ばれます)にも発生します。 |
keypress |
KeyboardEvent |
マップがフォーカスされている状態で、ユーザーがキーボードから文字値を生成するキーを押したときに発生します。 |
keydown |
KeyboardEvent |
マップがフォーカスされている状態で、ユーザーがキーボードからキーを押したときに発生します。keypress イベントとは異なり、keydown イベントは、文字値を生成するキーと、文字値を生成しないキーの両方で発生します。 |
keyup |
KeyboardEvent |
マップがフォーカスされている状態で、ユーザーがキーボードからキーを離したときに発生します。 |
preclick |
MouseEvent |
マップ上でのマウスクリックの前に発生します(既存のクリックハンドラーが実行を開始する前にクリック時に何かを発生させたい場合に便利です)。 |
その他のイベント
イベント | データ | 説明 |
---|---|---|
zoomanim |
ZoomAnimEvent |
ズームアニメーションごとに少なくとも1回発生します。ピンチズームのような連続ズームの場合は、ズーム中にフレームごとに1回発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
getRenderer( |
レンダラー |
指定された |
レイヤーとコントロールのメソッド
メソッド | 戻り値 | 説明 |
---|---|---|
addControl( |
this |
指定されたコントロールをマップに追加します |
removeControl( |
this |
指定されたコントロールをマップから削除します |
addLayer( |
this |
指定されたレイヤーをマップに追加します |
removeLayer( |
this |
指定されたレイヤーをマップから削除します。 |
hasLayer( |
ブール値 |
指定されたレイヤーが現在マップに追加されている場合は |
eachLayer( |
this |
マップのレイヤーを反復処理し、オプションで反復関数のコンテキストを指定します。
|
openPopup( |
this |
指定されたポップアップを開き、以前に開いたポップアップを閉じます(使いやすさのために、一度に1つだけが開かれるようにします)。 |
openPopup( |
this |
指定されたコンテンツとオプションでポップアップを作成し、マップ上の指定されたポイントで開きます。 |
closePopup( |
this |
openPopupで以前に開いたポップアップ(または指定されたポップアップ)を閉じます。 |
openTooltip( |
this |
指定されたツールチップを開きます。 |
openTooltip( |
this |
指定されたコンテンツとオプションでツールチップを作成し、開きます。 |
closeTooltip( |
this |
パラメーターとして与えられたツールチップを閉じます。 |
マップの状態を変更するためのメソッド
メソッド | 戻り値 | 説明 |
---|---|---|
setView( |
this |
指定されたアニメーションオプションを使用して、マップのビュー(地理的な中心とズーム)を設定します。 |
setZoom( |
this |
マップのズームを設定します。 |
zoomIn( |
this |
マップのズームを |
zoomOut( |
this |
マップのズームを |
setZoomAround( |
this |
マップ上の特定の地理的ポイントを固定したままズームします(例:スクロールズームやダブルクリックズームで内部的に使用されます)。 |
setZoomAround( |
this |
マップ上の指定されたピクセル(左上隅からの相対位置)を固定したままマップをズームします。 |
fitBounds( |
this |
可能な限り最大のズームレベルで、指定された地理的な境界を含むマップビューを設定します。 |
fitWorld( |
this |
可能な限り最大のズームレベルで、ほぼ全世界を含むマップビューを設定します。 |
panTo( |
this |
マップを指定された中心にパンします。 |
panBy( |
this |
マップを指定されたピクセル数だけ(アニメーションで)パンします。 |
flyTo( |
this |
スムーズなパンズームアニメーションを実行して、マップのビュー(地理的な中心とズーム)を設定します。 |
flyToBounds( |
this |
|
setMaxBounds( |
this |
マップビューを指定された境界に制限します(maxBoundsオプションを参照)。 |
setMinZoom( |
this |
利用可能なズームレベルの下限を設定します(minZoomオプションを参照)。 |
setMaxZoom( |
this |
利用可能なズームレベルの上限を設定します(maxZoomオプションを参照)。 |
panInsideBounds( |
this |
(まだそうでない場合)指定された境界の内側に収まる最も近いビューにマップをパンし、必要に応じて特定のアニメーションを使用してアニメーションを制御します。 |
panInside( |
this |
|
invalidateSize( |
this |
マップコンテナのサイズが変更されたかどうかを確認し、変更された場合はマップを更新します。マップのサイズを動的に変更した後に呼び出します。また、デフォルトではパンをアニメーション化します。 |
invalidateSize( |
this |
マップコンテナのサイズが変更されたかどうかを確認し、変更された場合はマップを更新します。マップのサイズを動的に変更した後に呼び出します。また、デフォルトではパンをアニメーション化します。 |
stop() |
this |
現在実行中の |
ジオロケーションメソッド
メソッド | 戻り値 | 説明 |
---|---|---|
locate( |
this |
ジオロケーションAPIを使用してユーザーの位置を特定しようとします。成功した場合は位置データとともに |
stopLocate() |
this |
|
その他のメソッド
メソッド | 戻り値 | 説明 |
---|---|---|
addHandler( |
this |
マップに新しい |
remove() |
this |
マップを破棄し、関連するすべてのイベントリスナーをクリアします。 |
createPane( |
HTMLElement |
指定された名前で新しいマップペインを作成し(まだ存在しない場合)、それを返します。ペインは、 |
getPane( |
HTMLElement |
指定された名前またはそのHTML要素(その識別子)に基づいて、マップペインを返します。 |
getPanes() |
Object |
すべてのペインの名前をキーとし、ペインを値とするプレーンオブジェクトを返します。 |
getContainer() |
HTMLElement |
マップを含むHTML要素を返します。 |
whenReady( |
this |
マップがビュー(中心とズーム)と少なくとも1つのレイヤーで初期化されたときに、指定された関数 |
マップの状態を取得するためのメソッド
メソッド | 戻り値 | 説明 |
---|---|---|
getCenter() |
LatLng |
マップビューの地理的な中心を返します |
getZoom() |
数値 |
マップビューの現在のズームレベルを返します |
getBounds() |
LatLngBounds |
現在のマップビューに表示されている地理的な境界を返します |
getMinZoom() |
数値 |
マップの最小ズームレベル(マップまたはレイヤーの |
getMaxZoom() |
数値 |
マップの最大ズームレベル(マップまたはレイヤーの |
getBoundsZoom( |
数値 |
指定された境界がマップビュー全体に収まる最大ズームレベルを返します。 |
getSize() |
ポイント |
マップコンテナの現在のサイズ(ピクセル単位)を返します。 |
getPixelBounds() |
バウンズ |
現在のマップビューの境界を、投影されたピクセル座標で返します(レイヤーとオーバーレイの実装で役立つ場合があります)。 |
getPixelOrigin() |
ポイント |
マップレイヤーの左上ポイントの投影されたピクセル座標を返します(カスタムレイヤーおよびオーバーレイの実装で役立ちます)。 |
getPixelWorldBounds( |
バウンズ |
ズームレベル |
変換メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
getZoomScale( |
数値 |
ズームレベル |
getScaleZoom( |
数値 |
マップが |
project( |
ポイント |
マップのCRSの投影法に従って地理座標 |
unproject( |
LatLng |
|
layerPointToLatLng( |
LatLng |
原点ピクセルに対するピクセル座標が与えられた場合、対応する地理座標(現在のズームレベルの場合)を返します。 |
latLngToLayerPoint( |
ポイント |
地理座標が与えられた場合、原点ピクセルに対する対応するピクセル座標を返します。 |
wrapLatLng( |
LatLng |
マップのCRSの |
wrapLatLngBounds( |
LatLngBounds |
指定されたものと同じサイズの |
distance( |
数値 |
マップのCRSに従って、2つの地理座標間の距離を返します。デフォルトでは、これはメートル単位で距離を測定します。 |
containerPointToLayerPoint( |
ポイント |
マップコンテナに対するピクセル座標が与えられた場合、原点ピクセルに対する対応するピクセル座標を返します。 |
layerPointToContainerPoint( |
ポイント |
原点ピクセルに対するピクセル座標が与えられた場合、マップコンテナに対する対応するピクセル座標を返します。 |
containerPointToLatLng( |
LatLng |
マップコンテナに対するピクセル座標が与えられた場合、対応する地理座標(現在のズームレベルの場合)を返します。 |
latLngToContainerPoint( |
ポイント |
地理座標が与えられた場合、マップコンテナに対する対応するピクセル座標を返します。 |
mouseEventToContainerPoint( |
ポイント |
MouseEventオブジェクトが与えられた場合、イベントが発生したマップコンテナに対するピクセル座標を返します。 |
mouseEventToLayerPoint( |
ポイント |
MouseEventオブジェクトが与えられた場合、イベントが発生した原点ピクセルに対するピクセル座標を返します。 |
mouseEventToLatLng( |
LatLng |
MouseEventオブジェクトが与えられた場合、イベントが発生した地理座標を返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
プロパティ
コントロール
Property | 型 | 説明 |
---|---|---|
zoomControl |
Control.Zoom |
デフォルトのズームコントロール(マップを作成するときにzoomControl オプションがtrue の場合のみ利用可能)。 |
Handlers
Property | 型 | 説明 |
---|---|---|
boxZoom |
ハンドラー |
ボックス(マウスでのShiftドラッグ)ズームハンドラー。 |
doubleClickZoom |
ハンドラー |
ダブルクリックズームハンドラー。 |
dragging |
ハンドラー |
マップドラッグハンドラー(マウスとタッチの両方)。 |
keyboard |
ハンドラー |
キーボードナビゲーションハンドラー。 |
scrollWheelZoom |
ハンドラー |
スクロールホイールズームハンドラー。 |
tapHold |
ハンドラー |
contextmenu イベントをシミュレートするロングタップハンドラー(モバイルSafariで役立ちます)。 |
touchZoom |
ハンドラー |
タッチズームハンドラー。 |
Map panes
Pane | 型 | Z-index | 説明 |
---|---|---|---|
mapPane |
HTMLElement |
'auto' |
他のすべてのマップペインを含むペイン |
tilePane |
HTMLElement |
200 |
GridLayer とTileLayer のペイン |
overlayPane |
HTMLElement |
400 |
ベクトル(Polyline やPolygon などのPath )、ImageOverlay 、VideoOverlay のペイン |
shadowPane |
HTMLElement |
500 |
オーバーレイシャドウのペイン(例:Marker シャドウ) |
markerPane |
HTMLElement |
600 |
Marker のIcon のペイン |
tooltipPane |
HTMLElement |
650 |
Tooltip のペイン。 |
popupPane |
HTMLElement |
700 |
Popup のペイン。 |
Locate options
Map
の一部のジオロケーションメソッドは、options
パラメーターを受け取ります。これは、次のオプションコンポーネントを含むプレーンなjavascriptオブジェクトです。オプション | 型 | デフォルト | 説明 |
---|---|---|---|
watch |
ブール値 |
false |
true の場合、W3C watchPosition メソッドを使用して、位置の変化の継続的な監視を開始します(一度検出するのではなく)。後でmap.stopLocate() メソッドを使用して監視を停止できます。 |
setView |
ブール値 |
false |
setView |
maxZoom |
数値 |
無限大 |
true の場合、検出精度を考慮して、またはジオロケーションが失敗した場合はワールドビューに、マップビューをユーザーの場所に自動的に設定します。 |
setViewオプションを使用した場合の自動ビュー設定の最大ズーム。 |
数値 |
10000 |
timeout |
|
数値 |
0 |
maximumAge |
検出された位置の最大経過時間。最後のジオロケーション応答からこのミリ秒数より少ない時間が経過した場合、 |
ブール値 |
false |
enableHighAccuracy |
高精度を有効にします。W3C仕様の説明を参照してください。
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
animate |
ブール値 |
|
ズームレベルを変更するMap メソッドの一部は、options パラメーターを受け取ります。これは、次のオプションコンポーネントを含むプレーンなjavascriptオブジェクトです。 |
animate
true
の場合、マップはズームの原点がどこにあるかに関係なくズームをアニメーション化しようとします。false
に設定すると、アニメーションなしで常にビューを完全にリセットします。オプション | 型 | デフォルト | 説明 |
---|---|---|---|
animate |
ブール値 |
|
Pan options |
マップの中心を変更する |
数値 |
0.25 |
animate |
easeLinearity |
数値 |
0.25 |
true の場合、可能な場合は常にパンがアニメーション化されます。false の場合、パンをアニメーション化しません。パンが画面よりも離れている場合はマップビューをリセットするか、マップペインの新しいオフセットを設定するだけです(panBy は常に後者を行います)。 |
duration |
ブール値 |
false |
アニメーション化されたパンの期間(秒単位)。 |
easeLinearity
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
animate |
ブール値 |
|
ズームレベルを変更するMap メソッドの一部は、options パラメーターを受け取ります。これは、次のオプションコンポーネントを含むプレーンなjavascriptオブジェクトです。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
マップの中心を変更する |
数値 |
0.25 |
animate |
easeLinearity |
数値 |
0.25 |
true の場合、可能な場合は常にパンがアニメーション化されます。false の場合、パンをアニメーション化しません。パンが画面よりも離れている場合はマップビューをリセットするか、マップペインの新しいオフセットを設定するだけです(panBy は常に後者を行います)。 |
duration |
ブール値 |
false |
アニメーション化されたパンの期間(秒単位)。 |
true
の場合、パンの開始時にmovestart
イベントは発生しません(パン慣性で内部的に使用されます)。
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
Zoom/pan options |
ポイント |
[0, 0] |
Zoom options から継承されたオプション |
Pan options から継承されたオプション |
ポイント |
[0, 0] |
Padding options |
paddingTopLeft |
ポイント |
[0, 0] |
ビューを境界に合わせるように設定するときに考慮すべきではないマップコンテナの左上隅のパディング量を設定します。マップ上にサイドバーのようなコントロールオーバーレイがあり、ズームインするオブジェクトを隠したくない場合に役立ちます。 |
paddingBottomRight
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
maxZoom |
数値 |
null |
マップの右下隅についても同様です。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
animate |
ブール値 |
|
ズームレベルを変更するMap メソッドの一部は、options パラメーターを受け取ります。これは、次のオプションコンポーネントを含むプレーンなjavascriptオブジェクトです。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
マップの中心を変更する |
数値 |
0.25 |
animate |
easeLinearity |
数値 |
0.25 |
true の場合、可能な場合は常にパンがアニメーション化されます。false の場合、パンをアニメーション化しません。パンが画面よりも離れている場合はマップビューをリセットするか、マップペインの新しいオフセットを設定するだけです(panBy は常に後者を行います)。 |
duration |
ブール値 |
false |
アニメーション化されたパンの期間(秒単位)。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
Zoom/pan options |
ポイント |
[0, 0] |
Zoom options から継承されたオプション |
Pan options から継承されたオプション |
ポイント |
[0, 0] |
Padding options |
paddingTopLeft |
ポイント |
[0, 0] |
ビューを境界に合わせるように設定するときに考慮すべきではないマップコンテナの左上隅のパディング量を設定します。マップ上にサイドバーのようなコントロールオーバーレイがあり、ズームインするオブジェクトを隠したくない場合に役立ちます。 |
マーカー
左上と右下の両方のパディングを同じ値に設定することと同じです。
使用例
L.marker([50.5, 30.5]).addTo(map);
作成
ファクトリ | 説明 |
---|---|
FitBounds options( |
使用する最大可能なズーム。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
Padding options から継承されたオプション |
アイコン |
* |
L.Markerは、マップ上にクリック/ドラッグ可能なアイコンを表示するために使用されます。Layer を拡張します。 |
keyboard |
ブール値 |
true |
L.marker |
<Marker options> |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
icon |
マーカーのレンダリングに使用するアイコンインスタンス。マーカーアイコンをカスタマイズする方法の詳細については、Iconドキュメントを参照してください。指定されていない場合は、 |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
keyboard |
マーカーがキーボードでタブ移動し、Enterキーを押してクリックできるかどうか。 |
title |
数値 |
0 |
String |
マーカーにマウスオーバーすると表示されるブラウザのツールチップのテキスト(デフォルトではツールチップはありません)。アクセシビリティに役立ちます。 |
数値 |
1.0 |
alt |
'Marker' |
ブール値 |
false |
アイコンイメージのalt 属性のテキスト。アクセシビリティに役立ちます。 |
riseOffset |
数値 |
250 |
riseOnHover 機能に使用されるz-indexオフセット。 |
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'markerPane' |
マーカーのアイコンが追加されるマップペイン 。 |
shadowPane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'shadowPane' |
マーカーの影が追加されるマップペイン 。 |
bubblingMouseEvents |
ブール値 |
false |
true の場合、このマーカー上のマウスイベントは、L.DomEvent.stopPropagation が使用されない限り、マップ上で同じイベントをトリガーします。 |
autoPanOnFocus |
ブール値 |
true |
true の場合、マーカーが(キーボードでtab キーを押すなどして)フォーカスされたときに、マップの境界内にマーカーが表示されるように、マップがパンします。 |
ドラッグ可能なマーカーのオプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
draggable |
ブール値 |
false |
マーカーをマウス/タッチでドラッグ可能にするかどうか。 |
autoPan |
ブール値 |
false |
このマーカーを端の近くでドラッグしたときにマップをパンするかどうか。 |
autoPanPadding |
ポイント |
Point(50, 50) |
マップの端からマップのパンを開始するまでの距離(左/右および上/下、ピクセル単位)。 |
autoPanSpeed |
数値 |
10 |
マップがパンするピクセル数。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
interactive |
ブール値 |
true |
false の場合、レイヤーはマウスイベントを発行せず、下にあるマップの一部として機能します。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
イベント | データ | 説明 |
---|---|---|
move |
イベント |
マーカーがsetLatLng またはドラッグによって移動されたときに発生します。古い座標と新しい座標は、イベント引数としてoldLatLng 、latlng に含まれます。 |
ドラッグイベント
イベント | データ | 説明 |
---|---|---|
dragstart |
イベント |
ユーザーがマーカーのドラッグを開始したときに発生します。 |
movestart |
イベント |
マーカーが(ドラッグによって)移動を開始したときに発生します。 |
drag |
イベント |
ユーザーがマーカーをドラッグしている間、繰り返し発生します。 |
dragend |
DragEndEvent |
ユーザーがマーカーのドラッグを停止したときに発生します。 |
moveend |
イベント |
マーカーが(ドラッグによって)移動を停止したときに発生します。 |
イベント | データ | 説明 |
---|---|---|
click |
MouseEvent |
ユーザーがレイヤーをクリック(またはタップ)したときに発生します。 |
dblclick |
MouseEvent |
ユーザーがレイヤーをダブルクリック(またはダブルタップ)したときに発生します。 |
mousedown |
MouseEvent |
ユーザーがレイヤー上でマウスボタンを押したときに発生します。 |
mouseup |
MouseEvent |
ユーザーがレイヤー上で押されたマウスボタンを離したときに発生します。 |
mouseover |
MouseEvent |
マウスがレイヤーに入ったときに発生します。 |
mouseout |
MouseEvent |
マウスがレイヤーから離れたときに発生します。 |
contextmenu |
MouseEvent |
ユーザーがレイヤーを右クリックしたときに発生し、このイベントにリスナーがある場合は、デフォルトのブラウザのコンテキストメニューが表示されないようにします。モバイルでユーザーがシングルタッチを1秒間保持した場合(長押しとも呼ばれる)にも発生します。 |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
getLatLng() |
LatLng |
マーカーの現在の地理的な位置を返します。 |
setLatLng( |
this |
マーカーの位置を指定されたポイントに変更します。 |
setZIndexOffset( |
this |
マーカーのzIndexオフセットを変更します。 |
getIcon() |
アイコン |
マーカーが現在使用しているアイコンを返します |
setIcon( |
this |
マーカーのアイコンを変更します。 |
setOpacity( |
this |
マーカーの不透明度を変更します。 |
その他のメソッド
メソッド | 戻り値 | 説明 |
---|---|---|
toGeoJSON( |
Object |
座標の値は、指定された |
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
プロパティ
インタラクションハンドラー
Handler
メソッドを参照)。例marker.dragging.disable();
Property | 型 | 説明 |
---|---|---|
dragging |
ハンドラー |
マーカードラッグハンドラー(マウスとタッチの両方による)。マーカーがマップ上にある場合にのみ有効です(それ以外の場合は、marker.options.draggable を設定します)。 |
Divオーバーレイ
L.PopupおよびL.Tooltipのベースモデル。プラグインのようなカスタムオーバーレイのためにそれを継承します。
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
interactive |
ブール値 |
false |
trueの場合、ポップアップ/ツールチップはマウスイベントをリッスンします。 |
offset |
ポイント |
Point(0, 0) |
オーバーレイの位置のオフセット。 |
className |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
オーバーレイに割り当てるカスタムCSSクラス名。 |
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
未定義 |
オーバーレイが追加されるマップペイン 。 |
content |
String|HTMLElement|Function |
'' |
初期化中にオーバーレイのHTMLコンテンツを設定します。関数が渡された場合、ソースレイヤーが関数に渡されます。関数は、オーバーレイで使用されるString またはHTMLElement を返す必要があります。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
bubblingMouseEvents |
ブール値 |
true |
true の場合、このレイヤー上のマウスイベントは、L.DomEvent.stopPropagation が使用されない限り、マップ上で同じイベントをトリガーします。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
DivOverlayイベント
イベント | データ | 説明 |
---|---|---|
contentupdate |
イベント |
オーバーレイのコンテンツが更新されたときに発生します |
イベント | データ | 説明 |
---|---|---|
click |
MouseEvent |
ユーザーがレイヤーをクリック(またはタップ)したときに発生します。 |
dblclick |
MouseEvent |
ユーザーがレイヤーをダブルクリック(またはダブルタップ)したときに発生します。 |
mousedown |
MouseEvent |
ユーザーがレイヤー上でマウスボタンを押したときに発生します。 |
mouseup |
MouseEvent |
ユーザーがレイヤー上で押されたマウスボタンを離したときに発生します。 |
mouseover |
MouseEvent |
マウスがレイヤーに入ったときに発生します。 |
mouseout |
MouseEvent |
マウスがレイヤーから離れたときに発生します。 |
contextmenu |
MouseEvent |
ユーザーがレイヤーを右クリックしたときに発生し、このイベントにリスナーがある場合は、デフォルトのブラウザのコンテキストメニューが表示されないようにします。モバイルでユーザーがシングルタッチを1秒間保持した場合(長押しとも呼ばれる)にも発生します。 |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
openOn( |
this |
オーバーレイをマップに追加します。 |
close() |
this |
オーバーレイを閉じます。 |
toggle( |
this |
現在の状態に応じて、レイヤーにバインドされたオーバーレイを開閉します。引数は、レイヤーにバインドされたオーバーレイでのみ省略できます。 |
getLatLng() |
LatLng |
オーバーレイの地理的なポイントを返します。 |
setLatLng( |
this |
オーバーレイが開く地理的なポイントを設定します。 |
getContent() |
String|HTMLElement |
オーバーレイのコンテンツを返します。 |
setContent( |
this |
オーバーレイのHTMLコンテンツを設定します。関数が渡された場合、ソースレイヤーが関数に渡されます。関数は、オーバーレイで使用される |
getElement() |
String|HTMLElement |
オーバーレイのHTMLコンテナを返します。 |
update() |
null |
オーバーレイのコンテンツ、レイアウト、位置を更新します。内部の何かが変更された後(たとえば、画像が読み込まれた後)にオーバーレイを更新するのに役立ちます。 |
isOpen() |
ブール値 |
オーバーレイがマップ上に表示されている場合は |
bringToFront() |
this |
このオーバーレイを(同じマップペイン内の)他のオーバーレイの前に移動します。 |
bringToBack() |
this |
このオーバーレイを(同じマップペイン内の)他のオーバーレイの後ろに移動します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
ポップアップ
マップの特定の位置にポップアップを開くために使用されます。一度に1つのポップアップのみが開いていることを確認しながらポップアップを開くにはMap.openPopupを使用し(ユーザビリティのため推奨)、必要な数だけ開くにはMap.addLayerを使用します。
使用例
マーカークリックにポップアップをバインドして開くだけの場合は、非常に簡単です
marker.bindPopup(popupContent).openPopup();
ポリラインのようなパスオーバーレイにもbindPopup
メソッドがあります。
ポップアップはスタンドアロンでも可能です
var popup = L.popup()
.setLatLng(latlng)
.setContent('<p>Hello world!<br />This is a nice popup.</p>')
.openOn(map);
または
var popup = L.popup(latlng, {content: '<p>Hello world!<br />This is a nice popup.</p>'})
.openOn(map);
作成
ファクトリ | 説明 |
---|---|
L.popup( |
外観と位置を記述するオプションのoptions オブジェクトと、ポップアップが参照するレイヤーへの参照でポップアップをタグ付けするために使用されるオプションのsource オブジェクトが与えられたPopup オブジェクトをインスタンス化します。 |
L.popup( |
ポップアップが開くlatlng と、外観と位置を記述するオプションのoptions オブジェクトが与えられたPopup オブジェクトをインスタンス化します。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'popupPane' |
ポップアップが追加されるマップペイン 。 |
offset |
ポイント |
Point(0, 7) |
ポップアップの位置のオフセット。 |
maxWidth |
数値 |
300 |
ポップアップの最大幅(ピクセル単位)。 |
minWidth |
数値 |
50 |
ポップアップの最小幅(ピクセル単位)。 |
maxHeight |
数値 |
null |
設定した場合、コンテンツが超過した場合に、ポップアップ内に指定された高さのスクロール可能なコンテナを作成します。スクロール可能なコンテナは、leaflet-popup-scrolled CSSクラスセレクターを使用してスタイルを設定できます。 |
autoPan |
ブール値 |
true |
開いたポップアップに合わせてマップがパンアニメーションを行わないようにする場合は、false に設定します。 |
autoPanPaddingTopLeft |
ポイント |
null |
自動パンが実行された後、ポップアップとマップビューの左上隅の間のマージン。 |
autoPanPaddingBottomRight |
ポイント |
null |
オートパン実行後、ポップアップとマップビューの右下隅との間のマージン。 |
autoPanPadding |
ポイント |
Point(5, 5) |
左上と右下のオートパンのパディングを同じ値に設定することと同等です。 |
keepInView |
ブール値 |
false |
ポップアップが開いている間、ユーザーがポップアップを画面外にパンするのを防ぎたい場合は、true に設定します。 |
closeButton |
ブール値 |
true |
ポップアップに閉じるボタンを表示するかどうかを制御します。 |
autoClose |
ブール値 |
true |
別のポップアップが開いたときにポップアップを閉じるデフォルトの動作をオーバーライドしたい場合は、false に設定します。 |
closeOnEscapeKey |
ブール値 |
true |
ポップアップを閉じるための ESC キーのデフォルトの動作をオーバーライドしたい場合は、false に設定します。 |
closeOnClick |
ブール値 |
* |
ユーザーがマップをクリックしたときにポップアップを閉じるデフォルトの動作をオーバーライドしたい場合は設定します。デフォルトでは、マップの closePopupOnClick オプションが使用されます。 |
className |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
ポップアップに割り当てるカスタム CSS クラス名。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
interactive |
ブール値 |
false |
trueの場合、ポップアップ/ツールチップはマウスイベントをリッスンします。 |
content |
String|HTMLElement|Function |
'' |
初期化中にオーバーレイのHTMLコンテンツを設定します。関数が渡された場合、ソースレイヤーが関数に渡されます。関数は、オーバーレイで使用されるString またはHTMLElement を返す必要があります。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
bubblingMouseEvents |
ブール値 |
true |
true の場合、このレイヤー上のマウスイベントは、L.DomEvent.stopPropagation が使用されない限り、マップ上で同じイベントをトリガーします。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
イベント | データ | 説明 |
---|---|---|
contentupdate |
イベント |
オーバーレイのコンテンツが更新されたときに発生します |
イベント | データ | 説明 |
---|---|---|
click |
MouseEvent |
ユーザーがレイヤーをクリック(またはタップ)したときに発生します。 |
dblclick |
MouseEvent |
ユーザーがレイヤーをダブルクリック(またはダブルタップ)したときに発生します。 |
mousedown |
MouseEvent |
ユーザーがレイヤー上でマウスボタンを押したときに発生します。 |
mouseup |
MouseEvent |
ユーザーがレイヤー上で押されたマウスボタンを離したときに発生します。 |
mouseover |
MouseEvent |
マウスがレイヤーに入ったときに発生します。 |
mouseout |
MouseEvent |
マウスがレイヤーから離れたときに発生します。 |
contextmenu |
MouseEvent |
ユーザーがレイヤーを右クリックしたときに発生し、このイベントにリスナーがある場合は、デフォルトのブラウザのコンテキストメニューが表示されないようにします。モバイルでユーザーがシングルタッチを1秒間保持した場合(長押しとも呼ばれる)にも発生します。 |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
openOn( |
this |
|
メソッド | 戻り値 | 説明 |
---|---|---|
close() |
this |
オーバーレイを閉じます。 |
toggle( |
this |
現在の状態に応じて、レイヤーにバインドされたオーバーレイを開閉します。引数は、レイヤーにバインドされたオーバーレイでのみ省略できます。 |
getLatLng() |
LatLng |
オーバーレイの地理的なポイントを返します。 |
setLatLng( |
this |
オーバーレイが開く地理的なポイントを設定します。 |
getContent() |
String|HTMLElement |
オーバーレイのコンテンツを返します。 |
setContent( |
this |
オーバーレイのHTMLコンテンツを設定します。関数が渡された場合、ソースレイヤーが関数に渡されます。関数は、オーバーレイで使用される |
getElement() |
String|HTMLElement |
オーバーレイのHTMLコンテナを返します。 |
update() |
null |
オーバーレイのコンテンツ、レイアウト、位置を更新します。内部の何かが変更された後(たとえば、画像が読み込まれた後)にオーバーレイを更新するのに役立ちます。 |
isOpen() |
ブール値 |
オーバーレイがマップ上に表示されている場合は |
bringToFront() |
this |
このオーバーレイを(同じマップペイン内の)他のオーバーレイの前に移動します。 |
bringToBack() |
this |
このオーバーレイを(同じマップペイン内の)他のオーバーレイの後ろに移動します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
ツールチップ
マップレイヤーの上に小さなテキストを表示するために使用されます。
使用例
ツールチップをマーカーにバインドするだけでよい場合
marker.bindTooltip("my tooltip text").openTooltip();
ポリラインのようなパスオーバーレイにも bindTooltip
メソッドがあります。
ツールチップはスタンドアロンでも使用できます。
var tooltip = L.tooltip()
.setLatLng(latlng)
.setContent('Hello world!<br />This is a nice tooltip.')
.addTo(map);
または
var tooltip = L.tooltip(latlng, {content: 'Hello world!<br />This is a nice tooltip.'})
.addTo(map);
ツールチップオフセットに関する注意。Leaflet はツールチップのオフセット計算において、2 つのオプションを考慮します。
offset
ツールチップオプション: デフォルトは [0, 0] で、1 つのツールチップに固有です。ツールチップを右に移動するには正の x オフセットを、下に移動するには正の y オフセットを追加します。負の値は左と上に移動します。tooltipAnchor
アイコンオプション: これはマーカーの場合にのみ考慮されます。カスタムアイコンを使用する場合は、この値を調整する必要があります。
作成
ファクトリ | 説明 |
---|---|
L.tooltip( |
外観と位置を記述するオプションの options オブジェクトと、ツールチップが参照するレイヤーへの参照でツールチップをタグ付けするために使用されるオプションの source オブジェクトを指定して、Tooltip オブジェクトをインスタンス化します。 |
L.tooltip( |
ツールチップが開く latlng と、外観と位置を記述するオプションの options オブジェクトを指定して、Tooltip オブジェクトをインスタンス化します。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'tooltipPane' |
ツールチップが追加される マップペイン 。 |
offset |
ポイント |
Point(0, 0) |
ツールチップの位置のオプションのオフセット。 |
direction |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'auto' |
ツールチップを開く方向。可能な値は、right 、left 、top 、bottom 、center 、auto です。auto は、マップ上のツールチップの位置に応じて、right と left を動的に切り替えます。 |
permanent |
ブール値 |
false |
ツールチップを永続的に開くか、マウスオーバー時のみ開くか。 |
sticky |
ブール値 |
false |
true の場合、ツールチップはフィーチャの中心に固定されるのではなく、マウスに追従します。 |
マーカーにマウスオーバーすると表示されるブラウザのツールチップのテキスト(デフォルトではツールチップはありません)。アクセシビリティに役立ちます。 |
数値 |
0.9 |
ツールチップコンテナの不透明度。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
interactive |
ブール値 |
false |
trueの場合、ポップアップ/ツールチップはマウスイベントをリッスンします。 |
className |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
オーバーレイに割り当てるカスタムCSSクラス名。 |
content |
String|HTMLElement|Function |
'' |
初期化中にオーバーレイのHTMLコンテンツを設定します。関数が渡された場合、ソースレイヤーが関数に渡されます。関数は、オーバーレイで使用されるString またはHTMLElement を返す必要があります。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
bubblingMouseEvents |
ブール値 |
true |
true の場合、このレイヤー上のマウスイベントは、L.DomEvent.stopPropagation が使用されない限り、マップ上で同じイベントをトリガーします。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
イベント | データ | 説明 |
---|---|---|
contentupdate |
イベント |
オーバーレイのコンテンツが更新されたときに発生します |
イベント | データ | 説明 |
---|---|---|
click |
MouseEvent |
ユーザーがレイヤーをクリック(またはタップ)したときに発生します。 |
dblclick |
MouseEvent |
ユーザーがレイヤーをダブルクリック(またはダブルタップ)したときに発生します。 |
mousedown |
MouseEvent |
ユーザーがレイヤー上でマウスボタンを押したときに発生します。 |
mouseup |
MouseEvent |
ユーザーがレイヤー上で押されたマウスボタンを離したときに発生します。 |
mouseover |
MouseEvent |
マウスがレイヤーに入ったときに発生します。 |
mouseout |
MouseEvent |
マウスがレイヤーから離れたときに発生します。 |
contextmenu |
MouseEvent |
ユーザーがレイヤーを右クリックしたときに発生し、このイベントにリスナーがある場合は、デフォルトのブラウザのコンテキストメニューが表示されないようにします。モバイルでユーザーがシングルタッチを1秒間保持した場合(長押しとも呼ばれる)にも発生します。 |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
openOn( |
this |
オーバーレイをマップに追加します。 |
close() |
this |
オーバーレイを閉じます。 |
toggle( |
this |
現在の状態に応じて、レイヤーにバインドされたオーバーレイを開閉します。引数は、レイヤーにバインドされたオーバーレイでのみ省略できます。 |
getLatLng() |
LatLng |
オーバーレイの地理的なポイントを返します。 |
setLatLng( |
this |
オーバーレイが開く地理的なポイントを設定します。 |
getContent() |
String|HTMLElement |
オーバーレイのコンテンツを返します。 |
setContent( |
this |
オーバーレイのHTMLコンテンツを設定します。関数が渡された場合、ソースレイヤーが関数に渡されます。関数は、オーバーレイで使用される |
getElement() |
String|HTMLElement |
オーバーレイのHTMLコンテナを返します。 |
update() |
null |
オーバーレイのコンテンツ、レイアウト、位置を更新します。内部の何かが変更された後(たとえば、画像が読み込まれた後)にオーバーレイを更新するのに役立ちます。 |
isOpen() |
ブール値 |
オーバーレイがマップ上に表示されている場合は |
bringToFront() |
this |
このオーバーレイを(同じマップペイン内の)他のオーバーレイの前に移動します。 |
bringToBack() |
this |
このオーバーレイを(同じマップペイン内の)他のオーバーレイの後ろに移動します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
タイルレイヤー
マップ上にタイルレイヤーをロードして表示するために使用されます。ほとんどのタイルサーバーでは、Layer
で設定できるアトリビューションが必要であることに注意してください。GridLayer
を拡張します。
使用例
L.tileLayer('https://tile.openstreetmap.org/{z}/{x}/{y}.png?{foo}', {foo: 'bar', attribution: '© <a href="https://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors'}).addTo(map);
URL テンプレート
次の形式の文字列
'https://{s}.somedomain.com/blabla/{z}/{x}/{y}{r}.png'
{s}
は利用可能なサブドメインの1つを意味します(ドメインごとのブラウザの並列リクエスト制限を支援するために順番に使用されます。サブドメインの値はオプションで指定されます。デフォルトでは a
、b
、または c
で、省略できます)、{z}
はズームレベル、{x}
と {y}
はタイル座標です。{r}
を使用して、URL に "@2x" を追加し、Retina タイルをロードできます。
テンプレートでカスタムキーを使用できます。これは、次のように TileLayer オプションから 評価されます
L.tileLayer('https://{s}.somedomain.com/{foo}/{z}/{x}/{y}.png', {foo: 'bar'});
作成
拡張メソッド
ファクトリ | 説明 |
---|---|
L.tilelayer( |
URL テンプレート と、オプションでオプションオブジェクトを指定して、タイルレイヤーオブジェクトをインスタンス化します。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
minZoom |
数値 |
0 |
このレイヤーが表示される最小ズームレベル(両端を含む)。 |
maxZoom |
数値 |
18 |
このレイヤーが表示される最大ズームレベル(両端を含む)。 |
subdomains |
String|String[] |
'abc' |
タイルサービスのサブドメイン。1 つの文字列(各文字がサブドメイン名である)または文字列の配列の形式で渡すことができます。 |
errorTileUrl |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
読み込みに失敗したタイルの代わりに表示するタイル画像の URL。 |
zoomOffset |
数値 |
0 |
タイル URL で使用されるズーム番号は、この値でオフセットされます。 |
tms |
ブール値 |
false |
true の場合、タイルの Y 軸番号を反転します(TMS サービスの場合はこれをオンにします)。 |
zoomReverse |
ブール値 |
false |
true に設定すると、タイル URL で使用されるズーム番号が反転されます (zoom の代わりに maxZoom - zoom )。 |
detectRetina |
ブール値 |
false |
true であり、ユーザーが Retina ディスプレイを使用している場合、指定されたサイズの半分のサイズの 4 つのタイルと、高解像度を利用するために、より大きなズームレベルを 1 つの代わりに要求します。 |
crossOrigin |
ブール値|文字列 |
false |
crossOrigin 属性がタイルに追加されるかどうか。文字列が指定されている場合、すべてのタイルには、指定された文字列に設定された crossOrigin 属性があります。これは、タイルピクセルデータにアクセスする場合に必要です。有効な文字列値については、CORS 設定を参照してください。 |
referrerPolicy |
ブール値|文字列 |
false |
referrerPolicy 属性がタイルに追加されるかどうか。文字列が指定されている場合、すべてのタイルには、指定された文字列に設定された referrerPolicy 属性があります。これは、マップのレンダリングコンテキストに厳密なデフォルトがあるが、タイルプロバイダーが有効なリファラーを予期する場合(API トークンを検証する場合など)に必要になる可能性があります。有効な文字列値については、HTMLImageElement.referrerPolicyを参照してください。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
tileSize |
Number|Point |
256 |
グリッド内のタイルの幅と高さ。幅と高さが等しい場合は数値を使用するか、それ以外の場合は L.point(width, height) を使用します。 |
マーカーにマウスオーバーすると表示されるブラウザのツールチップのテキスト(デフォルトではツールチップはありません)。アクセシビリティに役立ちます。 |
数値 |
1.0 |
タイルの不透明度。createTile() 関数で使用できます。 |
updateWhenIdle |
ブール値 |
(depends) |
パンが終わったときにのみ新しいタイルをロードします。モバイルブラウザでは、過剰なリクエストを回避し、スムーズなナビゲーションを維持するために、デフォルトで true に設定されています。デスクトップブラウザでは、keepBuffer オプションの外に簡単にパンできるため、パン中に新しいタイルを表示するために、それ以外の場合は false に設定されています。 |
updateWhenZooming |
ブール値 |
true |
デフォルトでは、スムーズなズームアニメーション(タッチズームまたは flyTo() 中)は、すべての整数ズームレベルでグリッドレイヤーを更新します。このオプションを false に設定すると、スムーズなアニメーションが終了したときにのみグリッドレイヤーが更新されます。 |
updateInterval |
数値 |
200 |
パン時に、タイルが updateInterval ミリ秒ごとに 1 回以上更新されることはありません。 |
zIndex |
数値 |
1 |
タイルレイヤーの明示的な zIndex。 |
bounds |
LatLngBounds |
未定義 |
設定されている場合、タイルは設定された LatLngBounds 内でのみロードされます。 |
maxNativeZoom |
数値 |
未定義 |
タイルソースで使用可能な最大ズーム番号。指定されている場合、maxNativeZoom より高いすべてのズームレベルのタイルは、maxNativeZoom レベルからロードされ、自動的にスケーリングされます。 |
minNativeZoom |
数値 |
未定義 |
タイルソースで使用可能な最小ズーム番号。指定されている場合、minNativeZoom より低いすべてのズームレベルのタイルは、minNativeZoom レベルからロードされ、自動的にスケーリングされます。 |
noWrap |
ブール値 |
false |
レイヤーが子午線をラップするかどうか。true の場合、GridLayer は低いズームレベルで 1 回だけ表示されます。マップ CRS がラップしない場合は効果がありません。bounds と組み合わせて使用し、CRS 制限外のタイルを要求しないようにすることができます。 |
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'tilePane' |
グリッドレイヤーが追加される マップペイン 。 |
className |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
タイルレイヤーに割り当てるカスタムクラス名。デフォルトでは空です。 |
keepBuffer |
数値 |
2 |
マップをパンするとき、タイルのこの数の行と列をアンロードする前に保持します。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
拡張メソッド
イベント | データ | 説明 |
---|---|---|
tileabort |
TileEvent |
タイルがロード中だったが、不要になったときに発生します。 |
イベント | データ | 説明 |
---|---|---|
loading |
イベント |
グリッドレイヤーがタイルのロードを開始したときに発生します。 |
tileunload |
TileEvent |
タイルが削除されたときに発生します(たとえば、タイルが画面外に出たとき)。 |
tileloadstart |
TileEvent |
タイルが要求され、ロードを開始したときに発生します。 |
tileerror |
TileErrorEvent |
タイルのロード中にエラーが発生したときに発生します。 |
tileload |
TileEvent |
タイルがロードされたときに発生します。 |
load |
イベント |
グリッドレイヤーがすべての可視タイルをロードしたときに発生します。 |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
setUrl( |
this |
レイヤーの URL テンプレートを更新し、( |
createTile( |
HTMLElement |
内部でのみ呼び出され、 |
拡張メソッド
TileLayer
を拡張するレイヤーは、次のメソッドを再実装する場合があります。メソッド | 戻り値 | 説明 |
---|---|---|
getTileUrl( |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
内部でのみ呼び出され、座標が与えられたタイルの URL を返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bringToFront() |
this |
すべてのタイルレイヤーの上にタイルレイヤーを移動します。 |
bringToBack() |
this |
すべてのタイルレイヤーの下にタイルレイヤーを移動します。 |
getContainer() |
HTMLElement |
このレイヤーのタイルを含む HTML 要素を返します。 |
setOpacity( |
this |
グリッドレイヤーの opacity を変更します。 |
setZIndex( |
this |
グリッドレイヤーの zIndex を変更します。 |
isLoading() |
ブール値 |
グリッドレイヤーのタイルがロードを完了していない場合、 |
redraw() |
this |
レイヤーがすべてのタイルをクリアし、再度要求するようにします。 |
getTileSize() |
ポイント |
tileSize オプションをポイントに正規化します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
TileLayer.WMS
マップ上に WMS サービスをタイルレイヤーとして表示するために使用されます。TileLayer
を拡張します。
使用例
var nexrad = L.tileLayer.wms("http://mesonet.agron.iastate.edu/cgi-bin/wms/nexrad/n0r.cgi", {
layers: 'nexrad-n0r-900913',
format: 'image/png',
transparent: true,
attribution: "Weather data © 2012 IEM Nexrad"
});
作成
ファクトリ | 説明 |
---|---|
L.tileLayer.wms( |
WMS サービスのベース URL と WMS パラメータ/オプションオブジェクトを指定して、WMS タイルレイヤーオブジェクトをインスタンス化します。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
layers |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
(必須) 表示する WMS レイヤーのカンマ区切りリスト。 |
styles |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
WMS スタイルのカンマ区切りリスト。 |
format |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'image/jpeg' |
WMS 画像形式(透明度のあるレイヤーの場合は 'image/png' を使用します)。 |
transparent |
ブール値 |
false |
true の場合、WMS サービスは透明度のある画像を返します。 |
バージョン |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'1.1.1' |
使用する WMS サービスのバージョン |
crs |
CRS |
null |
WMS リクエストに使用する座標参照システム。デフォルトはマップ CRS です。これが何を意味するかわからない場合は、これを変更しないでください。 |
uppercase |
ブール値 |
false |
true の場合、WMS リクエストパラメータキーは大文字になります。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
minZoom |
数値 |
0 |
このレイヤーが表示される最小ズームレベル(両端を含む)。 |
maxZoom |
数値 |
18 |
このレイヤーが表示される最大ズームレベル(両端を含む)。 |
subdomains |
String|String[] |
'abc' |
タイルサービスのサブドメイン。1 つの文字列(各文字がサブドメイン名である)または文字列の配列の形式で渡すことができます。 |
errorTileUrl |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
読み込みに失敗したタイルの代わりに表示するタイル画像の URL。 |
zoomOffset |
数値 |
0 |
タイル URL で使用されるズーム番号は、この値でオフセットされます。 |
tms |
ブール値 |
false |
true の場合、タイルの Y 軸番号を反転します(TMS サービスの場合はこれをオンにします)。 |
zoomReverse |
ブール値 |
false |
true に設定すると、タイル URL で使用されるズーム番号が反転されます (zoom の代わりに maxZoom - zoom )。 |
detectRetina |
ブール値 |
false |
true であり、ユーザーが Retina ディスプレイを使用している場合、指定されたサイズの半分のサイズの 4 つのタイルと、高解像度を利用するために、より大きなズームレベルを 1 つの代わりに要求します。 |
crossOrigin |
ブール値|文字列 |
false |
crossOrigin 属性がタイルに追加されるかどうか。文字列が指定されている場合、すべてのタイルには、指定された文字列に設定された crossOrigin 属性があります。これは、タイルピクセルデータにアクセスする場合に必要です。有効な文字列値については、CORS 設定を参照してください。 |
referrerPolicy |
ブール値|文字列 |
false |
referrerPolicy 属性がタイルに追加されるかどうか。文字列が指定されている場合、すべてのタイルには、指定された文字列に設定された referrerPolicy 属性があります。これは、マップのレンダリングコンテキストに厳密なデフォルトがあるが、タイルプロバイダーが有効なリファラーを予期する場合(API トークンを検証する場合など)に必要になる可能性があります。有効な文字列値については、HTMLImageElement.referrerPolicyを参照してください。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
tileSize |
Number|Point |
256 |
グリッド内のタイルの幅と高さ。幅と高さが等しい場合は数値を使用するか、それ以外の場合は L.point(width, height) を使用します。 |
マーカーにマウスオーバーすると表示されるブラウザのツールチップのテキスト(デフォルトではツールチップはありません)。アクセシビリティに役立ちます。 |
数値 |
1.0 |
タイルの不透明度。createTile() 関数で使用できます。 |
updateWhenIdle |
ブール値 |
(depends) |
パンが終わったときにのみ新しいタイルをロードします。モバイルブラウザでは、過剰なリクエストを回避し、スムーズなナビゲーションを維持するために、デフォルトで true に設定されています。デスクトップブラウザでは、keepBuffer オプションの外に簡単にパンできるため、パン中に新しいタイルを表示するために、それ以外の場合は false に設定されています。 |
updateWhenZooming |
ブール値 |
true |
デフォルトでは、スムーズなズームアニメーション(タッチズームまたは flyTo() 中)は、すべての整数ズームレベルでグリッドレイヤーを更新します。このオプションを false に設定すると、スムーズなアニメーションが終了したときにのみグリッドレイヤーが更新されます。 |
updateInterval |
数値 |
200 |
パン時に、タイルが updateInterval ミリ秒ごとに 1 回以上更新されることはありません。 |
zIndex |
数値 |
1 |
タイルレイヤーの明示的な zIndex。 |
bounds |
LatLngBounds |
未定義 |
設定されている場合、タイルは設定された LatLngBounds 内でのみロードされます。 |
maxNativeZoom |
数値 |
未定義 |
タイルソースで使用可能な最大ズーム番号。指定されている場合、maxNativeZoom より高いすべてのズームレベルのタイルは、maxNativeZoom レベルからロードされ、自動的にスケーリングされます。 |
minNativeZoom |
数値 |
未定義 |
タイルソースで使用可能な最小ズーム番号。指定されている場合、minNativeZoom より低いすべてのズームレベルのタイルは、minNativeZoom レベルからロードされ、自動的にスケーリングされます。 |
noWrap |
ブール値 |
false |
レイヤーが子午線をラップするかどうか。true の場合、GridLayer は低いズームレベルで 1 回だけ表示されます。マップ CRS がラップしない場合は効果がありません。bounds と組み合わせて使用し、CRS 制限外のタイルを要求しないようにすることができます。 |
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'tilePane' |
グリッドレイヤーが追加される マップペイン 。 |
className |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
タイルレイヤーに割り当てるカスタムクラス名。デフォルトでは空です。 |
keepBuffer |
数値 |
2 |
マップをパンするとき、タイルのこの数の行と列をアンロードする前に保持します。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
イベント | データ | 説明 |
---|---|---|
tileabort |
TileEvent |
タイルがロード中だったが、不要になったときに発生します。 |
イベント | データ | 説明 |
---|---|---|
loading |
イベント |
グリッドレイヤーがタイルのロードを開始したときに発生します。 |
tileunload |
TileEvent |
タイルが削除されたときに発生します(たとえば、タイルが画面外に出たとき)。 |
tileloadstart |
TileEvent |
タイルが要求され、ロードを開始したときに発生します。 |
tileerror |
TileErrorEvent |
タイルのロード中にエラーが発生したときに発生します。 |
tileload |
TileEvent |
タイルがロードされたときに発生します。 |
load |
イベント |
グリッドレイヤーがすべての可視タイルをロードしたときに発生します。 |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
setParams( |
this |
オブジェクトを新しいパラメータとマージし、現在の画面のタイルを再リクエストします( |
メソッド | 戻り値 | 説明 |
---|---|---|
setUrl( |
this |
レイヤーの URL テンプレートを更新し、( |
createTile( |
HTMLElement |
内部でのみ呼び出され、 |
メソッド | 戻り値 | 説明 |
---|---|---|
bringToFront() |
this |
すべてのタイルレイヤーの上にタイルレイヤーを移動します。 |
bringToBack() |
this |
すべてのタイルレイヤーの下にタイルレイヤーを移動します。 |
getContainer() |
HTMLElement |
このレイヤーのタイルを含む HTML 要素を返します。 |
setOpacity( |
this |
グリッドレイヤーの opacity を変更します。 |
setZIndex( |
this |
グリッドレイヤーの zIndex を変更します。 |
isLoading() |
ブール値 |
グリッドレイヤーのタイルがロードを完了していない場合、 |
redraw() |
this |
レイヤーがすべてのタイルをクリアし、再度要求するようにします。 |
getTileSize() |
ポイント |
tileSize オプションをポイントに正規化します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
イメージオーバーレイ
マップの特定の範囲に単一の画像をロードして表示するために使用されます。Layer
を拡張します。
使用例
var imageUrl = 'https://maps.lib.utexas.edu/maps/historical/newark_nj_1922.jpg',
imageBounds = [[40.712216, -74.22655], [40.773941, -74.12544]];
L.imageOverlay(imageUrl, imageBounds).addTo(map);
作成
ファクトリ | 説明 |
---|---|
L.imageOverlay( |
画像のURLとそれが関連付けられている地理的境界を指定して、画像オーバーレイオブジェクトをインスタンス化します。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
マーカーにマウスオーバーすると表示されるブラウザのツールチップのテキスト(デフォルトではツールチップはありません)。アクセシビリティに役立ちます。 |
数値 |
1.0 |
画像オーバーレイの不透明度。 |
マーカーのレンダリングに使用するアイコンインスタンス。マーカーアイコンをカスタマイズする方法の詳細については、Iconドキュメントを参照してください。指定されていない場合は、 |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
画像のalt 属性のテキスト(アクセシビリティに役立ちます)。 |
interactive |
ブール値 |
false |
true の場合、画像オーバーレイはクリックまたはホバーされたときにマウスイベントを発生させます。 |
crossOrigin |
ブール値|文字列 |
false |
crossOrigin属性が画像に追加されるかどうか。文字列が指定された場合、画像のcrossOrigin属性は指定された文字列に設定されます。これは、画像ピクセルデータにアクセスする場合に必要です。有効な文字列値については、CORS設定を参照してください。 |
errorOverlayUrl |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
ロードに失敗したオーバーレイの代わりに表示するオーバーレイ画像のURL。 |
zIndex |
数値 |
1 |
オーバーレイレイヤーの明示的なzIndex。 |
className |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
画像に割り当てるカスタムクラス名。デフォルトでは空です。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
bubblingMouseEvents |
ブール値 |
true |
true の場合、このレイヤー上のマウスイベントは、L.DomEvent.stopPropagation が使用されない限り、マップ上で同じイベントをトリガーします。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'overlayPane' |
デフォルトでは、レイヤーはマップのオーバーレイペインに追加されます。このオプションをオーバーライドすると、デフォルトでレイヤーは別のペインに配置されます。 |
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
イベント | データ | 説明 |
---|---|---|
load |
イベント |
ImageOverlayレイヤーが画像をロードしたときに発生します。 |
error |
イベント |
ImageOverlayレイヤーが画像のロードに失敗したときに発生します。 |
イベント | データ | 説明 |
---|---|---|
click |
MouseEvent |
ユーザーがレイヤーをクリック(またはタップ)したときに発生します。 |
dblclick |
MouseEvent |
ユーザーがレイヤーをダブルクリック(またはダブルタップ)したときに発生します。 |
mousedown |
MouseEvent |
ユーザーがレイヤー上でマウスボタンを押したときに発生します。 |
mouseup |
MouseEvent |
ユーザーがレイヤー上で押されたマウスボタンを離したときに発生します。 |
mouseover |
MouseEvent |
マウスがレイヤーに入ったときに発生します。 |
mouseout |
MouseEvent |
マウスがレイヤーから離れたときに発生します。 |
contextmenu |
MouseEvent |
ユーザーがレイヤーを右クリックしたときに発生し、このイベントにリスナーがある場合は、デフォルトのブラウザのコンテキストメニューが表示されないようにします。モバイルでユーザーがシングルタッチを1秒間保持した場合(長押しとも呼ばれる)にも発生します。 |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
setOpacity( |
this |
オーバーレイの不透明度を設定します。 |
bringToFront() |
this |
レイヤーをすべてのオーバーレイの最上部に移動します。 |
bringToBack() |
this |
レイヤーをすべてのオーバーレイの最下部に移動します。 |
setUrl( |
this |
画像のURLを変更します。 |
setBounds( |
this |
このImageOverlayがカバーする境界を更新します。 |
setZIndex( |
this |
画像オーバーレイのzIndexを変更します。 |
getBounds() |
LatLngBounds |
このImageOverlayがカバーする境界を取得します。 |
getElement() |
HTMLElement |
このオーバーレイで使用される |
getCenter() |
LatLng |
ImageOverlayの中心を返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
ビデオオーバーレイ
マップの特定の範囲にビデオプレーヤーをロードして表示するために使用されます。ImageOverlay
を拡張します。
ビデオオーバーレイは、<video>
HTML5要素を使用します。
使用例
var videoUrl = 'https://www.mapbox.com/bites/00188/patricia_nasa.webm',
videoBounds = [[ 32, -130], [ 13, -100]];
L.videoOverlay(videoUrl, videoBounds ).addTo(map);
作成
ファクトリ | 説明 |
---|---|
L.videoOverlay( |
ビデオのURL(またはURLの配列、またはビデオ要素)とそれが関連付けられている地理的境界を指定して、画像オーバーレイオブジェクトをインスタンス化します。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
autoplay |
ブール値 |
true |
ロード時にビデオが自動的に再生を開始するかどうか。一部のブラウザでは、muted: true の場合のみ自動再生が機能します。 |
loop |
ブール値 |
true |
ビデオが再生されたときに先頭に戻ってループするかどうか。 |
keepAspectRatio |
ブール値 |
true |
ビデオが投影後にアスペクト比を保持するかどうか。サポートされているブラウザに関連します。ブラウザの互換性を参照してください。 |
muted |
ブール値 |
false |
ロード時にビデオがミュートで開始されるかどうか。 |
playsInline |
ブール値 |
true |
モバイルブラウザは、全画面モードで開くのではなく、ビデオをその場で再生します。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
マーカーにマウスオーバーすると表示されるブラウザのツールチップのテキスト(デフォルトではツールチップはありません)。アクセシビリティに役立ちます。 |
数値 |
1.0 |
画像オーバーレイの不透明度。 |
マーカーのレンダリングに使用するアイコンインスタンス。マーカーアイコンをカスタマイズする方法の詳細については、Iconドキュメントを参照してください。指定されていない場合は、 |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
画像のalt 属性のテキスト(アクセシビリティに役立ちます)。 |
interactive |
ブール値 |
false |
true の場合、画像オーバーレイはクリックまたはホバーされたときにマウスイベントを発生させます。 |
crossOrigin |
ブール値|文字列 |
false |
crossOrigin属性が画像に追加されるかどうか。文字列が指定された場合、画像のcrossOrigin属性は指定された文字列に設定されます。これは、画像ピクセルデータにアクセスする場合に必要です。有効な文字列値については、CORS設定を参照してください。 |
errorOverlayUrl |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
ロードに失敗したオーバーレイの代わりに表示するオーバーレイ画像のURL。 |
zIndex |
数値 |
1 |
オーバーレイレイヤーの明示的なzIndex。 |
className |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
画像に割り当てるカスタムクラス名。デフォルトでは空です。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
bubblingMouseEvents |
ブール値 |
true |
true の場合、このレイヤー上のマウスイベントは、L.DomEvent.stopPropagation が使用されない限り、マップ上で同じイベントをトリガーします。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'overlayPane' |
デフォルトでは、レイヤーはマップのオーバーレイペインに追加されます。このオプションをオーバーライドすると、デフォルトでレイヤーは別のペインに配置されます。 |
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
イベント | データ | 説明 |
---|---|---|
load |
イベント |
ビデオが最初のフレームのロードを完了したときに発生します。 |
イベント | データ | 説明 |
---|---|---|
error |
イベント |
ImageOverlayレイヤーが画像のロードに失敗したときに発生します。 |
イベント | データ | 説明 |
---|---|---|
click |
MouseEvent |
ユーザーがレイヤーをクリック(またはタップ)したときに発生します。 |
dblclick |
MouseEvent |
ユーザーがレイヤーをダブルクリック(またはダブルタップ)したときに発生します。 |
mousedown |
MouseEvent |
ユーザーがレイヤー上でマウスボタンを押したときに発生します。 |
mouseup |
MouseEvent |
ユーザーがレイヤー上で押されたマウスボタンを離したときに発生します。 |
mouseover |
MouseEvent |
マウスがレイヤーに入ったときに発生します。 |
mouseout |
MouseEvent |
マウスがレイヤーから離れたときに発生します。 |
contextmenu |
MouseEvent |
ユーザーがレイヤーを右クリックしたときに発生し、このイベントにリスナーがある場合は、デフォルトのブラウザのコンテキストメニューが表示されないようにします。モバイルでユーザーがシングルタッチを1秒間保持した場合(長押しとも呼ばれる)にも発生します。 |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
getElement() |
HTMLVideoElement |
このオーバーレイで使用される |
メソッド | 戻り値 | 説明 |
---|---|---|
setOpacity( |
this |
オーバーレイの不透明度を設定します。 |
bringToFront() |
this |
レイヤーをすべてのオーバーレイの最上部に移動します。 |
bringToBack() |
this |
レイヤーをすべてのオーバーレイの最下部に移動します。 |
setUrl( |
this |
画像のURLを変更します。 |
setBounds( |
this |
このImageOverlayがカバーする境界を更新します。 |
setZIndex( |
this |
画像オーバーレイのzIndexを変更します。 |
getBounds() |
LatLngBounds |
このImageOverlayがカバーする境界を取得します。 |
getCenter() |
LatLng |
ImageOverlayの中心を返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
SVGオーバーレイ
マップの特定の範囲にSVGファイルをロード、表示し、DOMアクセスを提供するために使用されます。ImageOverlay
を拡張します。
SVGオーバーレイは、<svg>
要素を使用します。
使用例
var svgElement = document.createElementNS("http://www.w3.org/2000/svg", "svg");
svgElement.setAttribute('xmlns', "http://www.w3.org/2000/svg");
svgElement.setAttribute('viewBox', "0 0 200 200");
svgElement.innerHTML = '<rect width="200" height="200"/><rect x="75" y="23" width="50" height="50" style="fill:red"/><rect x="75" y="123" width="50" height="50" style="fill:#0013ff"/>';
var svgElementBounds = [ [ 32, -130 ], [ 13, -100 ] ];
L.svgOverlay(svgElement, svgElementBounds).addTo(map);
作成
ファクトリ | 説明 |
---|---|
L.svgOverlay( |
SVG要素とそれが関連付けられている地理的境界を指定して、画像オーバーレイオブジェクトをインスタンス化します。適切にズームインおよびズームアウトするには、SVG要素にviewBox属性が必要です。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
マーカーにマウスオーバーすると表示されるブラウザのツールチップのテキスト(デフォルトではツールチップはありません)。アクセシビリティに役立ちます。 |
数値 |
1.0 |
画像オーバーレイの不透明度。 |
マーカーのレンダリングに使用するアイコンインスタンス。マーカーアイコンをカスタマイズする方法の詳細については、Iconドキュメントを参照してください。指定されていない場合は、 |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
画像のalt 属性のテキスト(アクセシビリティに役立ちます)。 |
interactive |
ブール値 |
false |
true の場合、画像オーバーレイはクリックまたはホバーされたときにマウスイベントを発生させます。 |
crossOrigin |
ブール値|文字列 |
false |
crossOrigin属性が画像に追加されるかどうか。文字列が指定された場合、画像のcrossOrigin属性は指定された文字列に設定されます。これは、画像ピクセルデータにアクセスする場合に必要です。有効な文字列値については、CORS設定を参照してください。 |
errorOverlayUrl |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
ロードに失敗したオーバーレイの代わりに表示するオーバーレイ画像のURL。 |
zIndex |
数値 |
1 |
オーバーレイレイヤーの明示的なzIndex。 |
className |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
画像に割り当てるカスタムクラス名。デフォルトでは空です。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
bubblingMouseEvents |
ブール値 |
true |
true の場合、このレイヤー上のマウスイベントは、L.DomEvent.stopPropagation が使用されない限り、マップ上で同じイベントをトリガーします。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'overlayPane' |
デフォルトでは、レイヤーはマップのオーバーレイペインに追加されます。このオプションをオーバーライドすると、デフォルトでレイヤーは別のペインに配置されます。 |
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
イベント | データ | 説明 |
---|---|---|
click |
MouseEvent |
ユーザーがレイヤーをクリック(またはタップ)したときに発生します。 |
dblclick |
MouseEvent |
ユーザーがレイヤーをダブルクリック(またはダブルタップ)したときに発生します。 |
mousedown |
MouseEvent |
ユーザーがレイヤー上でマウスボタンを押したときに発生します。 |
mouseup |
MouseEvent |
ユーザーがレイヤー上で押されたマウスボタンを離したときに発生します。 |
mouseover |
MouseEvent |
マウスがレイヤーに入ったときに発生します。 |
mouseout |
MouseEvent |
マウスがレイヤーから離れたときに発生します。 |
contextmenu |
MouseEvent |
ユーザーがレイヤーを右クリックしたときに発生し、このイベントにリスナーがある場合は、デフォルトのブラウザのコンテキストメニューが表示されないようにします。モバイルでユーザーがシングルタッチを1秒間保持した場合(長押しとも呼ばれる)にも発生します。 |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
getElement() |
SVGElement |
このオーバーレイで使用される |
メソッド | 戻り値 | 説明 |
---|---|---|
setOpacity( |
this |
オーバーレイの不透明度を設定します。 |
bringToFront() |
this |
レイヤーをすべてのオーバーレイの最上部に移動します。 |
bringToBack() |
this |
レイヤーをすべてのオーバーレイの最下部に移動します。 |
setUrl( |
this |
画像のURLを変更します。 |
setBounds( |
this |
このImageOverlayがカバーする境界を更新します。 |
setZIndex( |
this |
画像オーバーレイのzIndexを変更します。 |
getBounds() |
LatLngBounds |
このImageOverlayがカバーする境界を取得します。 |
getCenter() |
LatLng |
ImageOverlayの中心を返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
パス
ベクターオーバーレイ(Polygon、Polyline、Circle)間で共有されるオプションと定数を含む抽象クラスです。直接使用しないでください。Layer
を拡張します。
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
stroke |
ブール値 |
true |
パスに沿ってストロークを描画するかどうか。ポリゴンまたは円の境界線を無効にするには、false に設定します。 |
color |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'#3388ff' |
ストロークの色 |
weight |
数値 |
3 |
ストロークの幅(ピクセル単位) |
マーカーにマウスオーバーすると表示されるブラウザのツールチップのテキスト(デフォルトではツールチップはありません)。アクセシビリティに役立ちます。 |
数値 |
1.0 |
ストロークの不透明度 |
lineCap |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'round' |
ストロークの終端で使用する形状を定義する文字列。 |
lineJoin |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'round' |
ストロークの角で使用する形状を定義する文字列。 |
dashArray |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
ストロークの破線パターンを定義する文字列。Canvas ベースのレイヤーでは、一部の古いブラウザでは機能しません。 |
dashOffset |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
破線パターンの開始位置までの距離を定義する文字列。Canvas ベースのレイヤーでは、一部の古いブラウザでは機能しません。 |
fill |
ブール値 |
depends |
パスを色で塗りつぶすかどうか。ポリゴンまたは円の塗りつぶしを無効にするには、false に設定します。 |
fillColor |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
* |
塗りつぶしの色。デフォルトでは、color オプションの値になります。 |
fillOpacity |
数値 |
0.2 |
塗りつぶしの不透明度。 |
fillRule |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'evenodd' |
シェイプの内側を決定する方法を定義する文字列。 |
bubblingMouseEvents |
ブール値 |
true |
true の場合、このパスでのマウスイベントはマップで同じイベントをトリガーします(L.DomEvent.stopPropagation が使用されている場合を除く)。 |
renderer |
レンダラー |
|
このパスにこの特定のRenderer インスタンスを使用します。マップのデフォルトのレンダラーよりも優先されます。 |
className |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
要素に設定されたカスタムクラス名。SVGレンダラーの場合のみ。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
interactive |
ブール値 |
true |
false の場合、レイヤーはマウスイベントを発行せず、下にあるマップの一部として機能します。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'overlayPane' |
デフォルトでは、レイヤーはマップのオーバーレイペインに追加されます。このオプションをオーバーライドすると、デフォルトでレイヤーは別のペインに配置されます。 |
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
イベント | データ | 説明 |
---|---|---|
click |
MouseEvent |
ユーザーがレイヤーをクリック(またはタップ)したときに発生します。 |
dblclick |
MouseEvent |
ユーザーがレイヤーをダブルクリック(またはダブルタップ)したときに発生します。 |
mousedown |
MouseEvent |
ユーザーがレイヤー上でマウスボタンを押したときに発生します。 |
mouseup |
MouseEvent |
ユーザーがレイヤー上で押されたマウスボタンを離したときに発生します。 |
mouseover |
MouseEvent |
マウスがレイヤーに入ったときに発生します。 |
mouseout |
MouseEvent |
マウスがレイヤーから離れたときに発生します。 |
contextmenu |
MouseEvent |
ユーザーがレイヤーを右クリックしたときに発生し、このイベントにリスナーがある場合は、デフォルトのブラウザのコンテキストメニューが表示されないようにします。モバイルでユーザーがシングルタッチを1秒間保持した場合(長押しとも呼ばれる)にも発生します。 |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
redraw() |
this |
レイヤーを再描画します。パスが使用する座標を変更した後に役立つ場合があります。 |
setStyle( |
this |
|
bringToFront() |
this |
レイヤーをすべてのパスレイヤーの最上部に移動します。 |
bringToBack() |
this |
レイヤーをすべてのパスレイヤーの最下部に移動します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
ポリライン
マップ上にポリラインオーバーレイを描画するためのクラスです。Path
を拡張します。
使用例
// create a red polyline from an array of LatLng points
var latlngs = [
[45.51, -122.68],
[37.77, -122.43],
[34.04, -118.2]
];
var polyline = L.polyline(latlngs, {color: 'red'}).addTo(map);
// zoom the map to the polyline
map.fitBounds(polyline.getBounds());
多次元配列を渡して、MultiPolyline
シェイプを表すこともできます。
// create a red polyline from an array of arrays of LatLng points
var latlngs = [
[[45.51, -122.68],
[37.77, -122.43],
[34.04, -118.2]],
[[40.78, -73.91],
[41.83, -87.62],
[32.76, -96.72]]
];
作成
ファクトリ | 説明 |
---|---|
L.polyline( |
地理的な点の配列とオプションのオプションオブジェクトを指定して、ポリラインオブジェクトをインスタンス化します。地理的な点の配列の配列を渡すことで、複数の個別の線(MultiPolyline )を持つPolyline オブジェクトを作成できます。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
smoothFactor |
数値 |
1.0 |
各ズームレベルでポリラインを単純化する量。多いほどパフォーマンスが向上し、見た目が滑らかになります。少ないほど、より正確な表現になります。 |
noClip |
ブール値 |
false |
ポリラインのクリッピングを無効にします。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
stroke |
ブール値 |
true |
パスに沿ってストロークを描画するかどうか。ポリゴンまたは円の境界線を無効にするには、false に設定します。 |
color |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'#3388ff' |
ストロークの色 |
weight |
数値 |
3 |
ストロークの幅(ピクセル単位) |
マーカーにマウスオーバーすると表示されるブラウザのツールチップのテキスト(デフォルトではツールチップはありません)。アクセシビリティに役立ちます。 |
数値 |
1.0 |
ストロークの不透明度 |
lineCap |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'round' |
ストロークの終端で使用する形状を定義する文字列。 |
lineJoin |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'round' |
ストロークの角で使用する形状を定義する文字列。 |
dashArray |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
ストロークの破線パターンを定義する文字列。Canvas ベースのレイヤーでは、一部の古いブラウザでは機能しません。 |
dashOffset |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
破線パターンの開始位置までの距離を定義する文字列。Canvas ベースのレイヤーでは、一部の古いブラウザでは機能しません。 |
fill |
ブール値 |
depends |
パスを色で塗りつぶすかどうか。ポリゴンまたは円の塗りつぶしを無効にするには、false に設定します。 |
fillColor |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
* |
塗りつぶしの色。デフォルトでは、color オプションの値になります。 |
fillOpacity |
数値 |
0.2 |
塗りつぶしの不透明度。 |
fillRule |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'evenodd' |
シェイプの内側を決定する方法を定義する文字列。 |
bubblingMouseEvents |
ブール値 |
true |
true の場合、このパスでのマウスイベントはマップで同じイベントをトリガーします(L.DomEvent.stopPropagation が使用されている場合を除く)。 |
renderer |
レンダラー |
|
このパスにこの特定のRenderer インスタンスを使用します。マップのデフォルトのレンダラーよりも優先されます。 |
className |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
要素に設定されたカスタムクラス名。SVGレンダラーの場合のみ。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
interactive |
ブール値 |
true |
false の場合、レイヤーはマウスイベントを発行せず、下にあるマップの一部として機能します。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'overlayPane' |
デフォルトでは、レイヤーはマップのオーバーレイペインに追加されます。このオプションをオーバーライドすると、デフォルトでレイヤーは別のペインに配置されます。 |
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
イベント | データ | 説明 |
---|---|---|
click |
MouseEvent |
ユーザーがレイヤーをクリック(またはタップ)したときに発生します。 |
dblclick |
MouseEvent |
ユーザーがレイヤーをダブルクリック(またはダブルタップ)したときに発生します。 |
mousedown |
MouseEvent |
ユーザーがレイヤー上でマウスボタンを押したときに発生します。 |
mouseup |
MouseEvent |
ユーザーがレイヤー上で押されたマウスボタンを離したときに発生します。 |
mouseover |
MouseEvent |
マウスがレイヤーに入ったときに発生します。 |
mouseout |
MouseEvent |
マウスがレイヤーから離れたときに発生します。 |
contextmenu |
MouseEvent |
ユーザーがレイヤーを右クリックしたときに発生し、このイベントにリスナーがある場合は、デフォルトのブラウザのコンテキストメニューが表示されないようにします。モバイルでユーザーがシングルタッチを1秒間保持した場合(長押しとも呼ばれる)にも発生します。 |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
toGeoJSON( |
Object |
座標値は、指定された |
getLatLngs() |
LatLng[] |
パス内の点の配列、またはマルチポリラインの場合は点のネストされた配列を返します。 |
setLatLngs( |
this |
ポリライン内のすべての点を、指定された地理的な点の配列に置き換えます。 |
isEmpty() |
ブール値 |
ポリラインにLatLngがない場合は |
closestLayerPoint( |
ポイント |
ポリライン上の |
getCenter() |
LatLng |
ポリラインの中心(重心)を返します。 |
getBounds() |
LatLngBounds |
パスの |
addLatLng( |
this |
指定された点をポリラインに追加します。デフォルトでは、マルチポリラインの場合はポリラインの最初のリングに追加されますが、LatLng配列として特定のリングを渡すことでオーバーライドできます( |
メソッド | 戻り値 | 説明 |
---|---|---|
redraw() |
this |
レイヤーを再描画します。パスが使用する座標を変更した後に役立つ場合があります。 |
setStyle( |
this |
|
bringToFront() |
this |
レイヤーをすべてのパスレイヤーの最上部に移動します。 |
bringToBack() |
this |
レイヤーをすべてのパスレイヤーの最下部に移動します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
ポリゴン
マップ上にポリゴンオーバーレイを描画するためのクラスです。Polyline
を拡張します。
ポリゴンを作成するときに渡す点は、最初の点と同じ追加の最後の点を持つべきではないことに注意してください。このような点は除外することをお勧めします。
使用例
// create a red polygon from an array of LatLng points
var latlngs = [[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]];
var polygon = L.polygon(latlngs, {color: 'red'}).addTo(map);
// zoom the map to the polygon
map.fitBounds(polygon.getBounds());
latlngsの配列の配列を渡すこともできます。最初の配列は外側のシェイプを表し、他の配列は外側のシェイプの穴を表します。
var latlngs = [
[[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]], // outer ring
[[37.29, -108.58],[40.71, -108.58],[40.71, -102.50],[37.29, -102.50]] // hole
];
さらに、多次元配列を渡して、MultiPolygonシェイプを表すことができます。
var latlngs = [
[ // first polygon
[[37, -109.05],[41, -109.03],[41, -102.05],[37, -102.04]], // outer ring
[[37.29, -108.58],[40.71, -108.58],[40.71, -102.50],[37.29, -102.50]] // hole
],
[ // second polygon
[[41, -111.03],[45, -111.04],[45, -104.05],[41, -104.05]]
]
];
作成
ファクトリ | 説明 |
---|---|
L.polygon( |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
smoothFactor |
数値 |
1.0 |
各ズームレベルでポリラインを単純化する量。多いほどパフォーマンスが向上し、見た目が滑らかになります。少ないほど、より正確な表現になります。 |
noClip |
ブール値 |
false |
ポリラインのクリッピングを無効にします。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
stroke |
ブール値 |
true |
パスに沿ってストロークを描画するかどうか。ポリゴンまたは円の境界線を無効にするには、false に設定します。 |
color |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'#3388ff' |
ストロークの色 |
weight |
数値 |
3 |
ストロークの幅(ピクセル単位) |
マーカーにマウスオーバーすると表示されるブラウザのツールチップのテキスト(デフォルトではツールチップはありません)。アクセシビリティに役立ちます。 |
数値 |
1.0 |
ストロークの不透明度 |
lineCap |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'round' |
ストロークの終端で使用する形状を定義する文字列。 |
lineJoin |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'round' |
ストロークの角で使用する形状を定義する文字列。 |
dashArray |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
ストロークの破線パターンを定義する文字列。Canvas ベースのレイヤーでは、一部の古いブラウザでは機能しません。 |
dashOffset |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
破線パターンの開始位置までの距離を定義する文字列。Canvas ベースのレイヤーでは、一部の古いブラウザでは機能しません。 |
fill |
ブール値 |
depends |
パスを色で塗りつぶすかどうか。ポリゴンまたは円の塗りつぶしを無効にするには、false に設定します。 |
fillColor |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
* |
塗りつぶしの色。デフォルトでは、color オプションの値になります。 |
fillOpacity |
数値 |
0.2 |
塗りつぶしの不透明度。 |
fillRule |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'evenodd' |
シェイプの内側を決定する方法を定義する文字列。 |
bubblingMouseEvents |
ブール値 |
true |
true の場合、このパスでのマウスイベントはマップで同じイベントをトリガーします(L.DomEvent.stopPropagation が使用されている場合を除く)。 |
renderer |
レンダラー |
|
このパスにこの特定のRenderer インスタンスを使用します。マップのデフォルトのレンダラーよりも優先されます。 |
className |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
要素に設定されたカスタムクラス名。SVGレンダラーの場合のみ。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
interactive |
ブール値 |
true |
false の場合、レイヤーはマウスイベントを発行せず、下にあるマップの一部として機能します。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'overlayPane' |
デフォルトでは、レイヤーはマップのオーバーレイペインに追加されます。このオプションをオーバーライドすると、デフォルトでレイヤーは別のペインに配置されます。 |
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
イベント | データ | 説明 |
---|---|---|
click |
MouseEvent |
ユーザーがレイヤーをクリック(またはタップ)したときに発生します。 |
dblclick |
MouseEvent |
ユーザーがレイヤーをダブルクリック(またはダブルタップ)したときに発生します。 |
mousedown |
MouseEvent |
ユーザーがレイヤー上でマウスボタンを押したときに発生します。 |
mouseup |
MouseEvent |
ユーザーがレイヤー上で押されたマウスボタンを離したときに発生します。 |
mouseover |
MouseEvent |
マウスがレイヤーに入ったときに発生します。 |
mouseout |
MouseEvent |
マウスがレイヤーから離れたときに発生します。 |
contextmenu |
MouseEvent |
ユーザーがレイヤーを右クリックしたときに発生し、このイベントにリスナーがある場合は、デフォルトのブラウザのコンテキストメニューが表示されないようにします。モバイルでユーザーがシングルタッチを1秒間保持した場合(長押しとも呼ばれる)にも発生します。 |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
toGeoJSON( |
Object |
座標値は、指定された |
getCenter() |
LatLng |
ポリゴンの中心(重心)を返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
getLatLngs() |
LatLng[] |
パス内の点の配列、またはマルチポリラインの場合は点のネストされた配列を返します。 |
setLatLngs( |
this |
ポリライン内のすべての点を、指定された地理的な点の配列に置き換えます。 |
isEmpty() |
ブール値 |
ポリラインにLatLngがない場合は |
closestLayerPoint( |
ポイント |
ポリライン上の |
getBounds() |
LatLngBounds |
パスの |
addLatLng( |
this |
指定された点をポリラインに追加します。デフォルトでは、マルチポリラインの場合はポリラインの最初のリングに追加されますが、LatLng配列として特定のリングを渡すことでオーバーライドできます( |
メソッド | 戻り値 | 説明 |
---|---|---|
redraw() |
this |
レイヤーを再描画します。パスが使用する座標を変更した後に役立つ場合があります。 |
setStyle( |
this |
|
bringToFront() |
this |
レイヤーをすべてのパスレイヤーの最上部に移動します。 |
bringToBack() |
this |
レイヤーをすべてのパスレイヤーの最下部に移動します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
矩形
マップ上に長方形オーバーレイを描画するためのクラスです。Polygon
を拡張します。
使用例
// define rectangle geographical bounds
var bounds = [[54.559322, -5.767822], [56.1210604, -3.021240]];
// create an orange rectangle
L.rectangle(bounds, {color: "#ff7800", weight: 1}).addTo(map);
// zoom the map to the rectangle bounds
map.fitBounds(bounds);
作成
ファクトリ | 説明 |
---|---|
L.rectangle( |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
smoothFactor |
数値 |
1.0 |
各ズームレベルでポリラインを単純化する量。多いほどパフォーマンスが向上し、見た目が滑らかになります。少ないほど、より正確な表現になります。 |
noClip |
ブール値 |
false |
ポリラインのクリッピングを無効にします。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
stroke |
ブール値 |
true |
パスに沿ってストロークを描画するかどうか。ポリゴンまたは円の境界線を無効にするには、false に設定します。 |
color |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'#3388ff' |
ストロークの色 |
weight |
数値 |
3 |
ストロークの幅(ピクセル単位) |
マーカーにマウスオーバーすると表示されるブラウザのツールチップのテキスト(デフォルトではツールチップはありません)。アクセシビリティに役立ちます。 |
数値 |
1.0 |
ストロークの不透明度 |
lineCap |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'round' |
ストロークの終端で使用する形状を定義する文字列。 |
lineJoin |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'round' |
ストロークの角で使用する形状を定義する文字列。 |
dashArray |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
ストロークの破線パターンを定義する文字列。Canvas ベースのレイヤーでは、一部の古いブラウザでは機能しません。 |
dashOffset |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
破線パターンの開始位置までの距離を定義する文字列。Canvas ベースのレイヤーでは、一部の古いブラウザでは機能しません。 |
fill |
ブール値 |
depends |
パスを色で塗りつぶすかどうか。ポリゴンまたは円の塗りつぶしを無効にするには、false に設定します。 |
fillColor |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
* |
塗りつぶしの色。デフォルトでは、color オプションの値になります。 |
fillOpacity |
数値 |
0.2 |
塗りつぶしの不透明度。 |
fillRule |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'evenodd' |
シェイプの内側を決定する方法を定義する文字列。 |
bubblingMouseEvents |
ブール値 |
true |
true の場合、このパスでのマウスイベントはマップで同じイベントをトリガーします(L.DomEvent.stopPropagation が使用されている場合を除く)。 |
renderer |
レンダラー |
|
このパスにこの特定のRenderer インスタンスを使用します。マップのデフォルトのレンダラーよりも優先されます。 |
className |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
要素に設定されたカスタムクラス名。SVGレンダラーの場合のみ。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
interactive |
ブール値 |
true |
false の場合、レイヤーはマウスイベントを発行せず、下にあるマップの一部として機能します。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'overlayPane' |
デフォルトでは、レイヤーはマップのオーバーレイペインに追加されます。このオプションをオーバーライドすると、デフォルトでレイヤーは別のペインに配置されます。 |
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
イベント | データ | 説明 |
---|---|---|
click |
MouseEvent |
ユーザーがレイヤーをクリック(またはタップ)したときに発生します。 |
dblclick |
MouseEvent |
ユーザーがレイヤーをダブルクリック(またはダブルタップ)したときに発生します。 |
mousedown |
MouseEvent |
ユーザーがレイヤー上でマウスボタンを押したときに発生します。 |
mouseup |
MouseEvent |
ユーザーがレイヤー上で押されたマウスボタンを離したときに発生します。 |
mouseover |
MouseEvent |
マウスがレイヤーに入ったときに発生します。 |
mouseout |
MouseEvent |
マウスがレイヤーから離れたときに発生します。 |
contextmenu |
MouseEvent |
ユーザーがレイヤーを右クリックしたときに発生し、このイベントにリスナーがある場合は、デフォルトのブラウザのコンテキストメニューが表示されないようにします。モバイルでユーザーがシングルタッチを1秒間保持した場合(長押しとも呼ばれる)にも発生します。 |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
setBounds( |
this |
渡された境界で長方形を再描画します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
getLatLngs() |
LatLng[] |
パス内の点の配列、またはマルチポリラインの場合は点のネストされた配列を返します。 |
setLatLngs( |
this |
ポリライン内のすべての点を、指定された地理的な点の配列に置き換えます。 |
isEmpty() |
ブール値 |
ポリラインにLatLngがない場合は |
closestLayerPoint( |
ポイント |
ポリライン上の |
getBounds() |
LatLngBounds |
パスの |
addLatLng( |
this |
指定された点をポリラインに追加します。デフォルトでは、マルチポリラインの場合はポリラインの最初のリングに追加されますが、LatLng配列として特定のリングを渡すことでオーバーライドできます( |
メソッド | 戻り値 | 説明 |
---|---|---|
redraw() |
this |
レイヤーを再描画します。パスが使用する座標を変更した後に役立つ場合があります。 |
setStyle( |
this |
|
bringToFront() |
this |
レイヤーをすべてのパスレイヤーの最上部に移動します。 |
bringToBack() |
this |
レイヤーをすべてのパスレイヤーの最下部に移動します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
円
マップ上に円オーバーレイを描画するためのクラスです。CircleMarker
を拡張します。
これは近似であり、極に近いほど(投影歪みのために)実際の円から逸脱し始めます。
使用例
L.circle([50.5, 30.5], {radius: 200}).addTo(map);
作成
ファクトリ | 説明 |
---|---|
L.circle( |
地理的な点と円の半径を含むオプションオブジェクトを指定して、円オブジェクトをインスタンス化します。 |
L.circle( |
0.7.xコードとの互換性のために、円をインスタンス化する古い方法です。新しいアプリケーションやプラグインでは使用しないでください。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
radius |
数値 |
|
円の半径(メートル単位)。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
stroke |
ブール値 |
true |
パスに沿ってストロークを描画するかどうか。ポリゴンまたは円の境界線を無効にするには、false に設定します。 |
color |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'#3388ff' |
ストロークの色 |
weight |
数値 |
3 |
ストロークの幅(ピクセル単位) |
マーカーにマウスオーバーすると表示されるブラウザのツールチップのテキスト(デフォルトではツールチップはありません)。アクセシビリティに役立ちます。 |
数値 |
1.0 |
ストロークの不透明度 |
lineCap |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'round' |
ストロークの終端で使用する形状を定義する文字列。 |
lineJoin |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'round' |
ストロークの角で使用する形状を定義する文字列。 |
dashArray |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
ストロークの破線パターンを定義する文字列。Canvas ベースのレイヤーでは、一部の古いブラウザでは機能しません。 |
dashOffset |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
破線パターンの開始位置までの距離を定義する文字列。Canvas ベースのレイヤーでは、一部の古いブラウザでは機能しません。 |
fill |
ブール値 |
depends |
パスを色で塗りつぶすかどうか。ポリゴンまたは円の塗りつぶしを無効にするには、false に設定します。 |
fillColor |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
* |
塗りつぶしの色。デフォルトでは、color オプションの値になります。 |
fillOpacity |
数値 |
0.2 |
塗りつぶしの不透明度。 |
fillRule |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'evenodd' |
シェイプの内側を決定する方法を定義する文字列。 |
bubblingMouseEvents |
ブール値 |
true |
true の場合、このパスでのマウスイベントはマップで同じイベントをトリガーします(L.DomEvent.stopPropagation が使用されている場合を除く)。 |
renderer |
レンダラー |
|
このパスにこの特定のRenderer インスタンスを使用します。マップのデフォルトのレンダラーよりも優先されます。 |
className |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
要素に設定されたカスタムクラス名。SVGレンダラーの場合のみ。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
interactive |
ブール値 |
true |
false の場合、レイヤーはマウスイベントを発行せず、下にあるマップの一部として機能します。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'overlayPane' |
デフォルトでは、レイヤーはマップのオーバーレイペインに追加されます。このオプションをオーバーライドすると、デフォルトでレイヤーは別のペインに配置されます。 |
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
イベント | データ | 説明 |
---|---|---|
click |
MouseEvent |
ユーザーがレイヤーをクリック(またはタップ)したときに発生します。 |
dblclick |
MouseEvent |
ユーザーがレイヤーをダブルクリック(またはダブルタップ)したときに発生します。 |
mousedown |
MouseEvent |
ユーザーがレイヤー上でマウスボタンを押したときに発生します。 |
mouseup |
MouseEvent |
ユーザーがレイヤー上で押されたマウスボタンを離したときに発生します。 |
mouseover |
MouseEvent |
マウスがレイヤーに入ったときに発生します。 |
mouseout |
MouseEvent |
マウスがレイヤーから離れたときに発生します。 |
contextmenu |
MouseEvent |
ユーザーがレイヤーを右クリックしたときに発生し、このイベントにリスナーがある場合は、デフォルトのブラウザのコンテキストメニューが表示されないようにします。モバイルでユーザーがシングルタッチを1秒間保持した場合(長押しとも呼ばれる)にも発生します。 |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
setRadius( |
this |
円の半径を設定します。単位はメートルです。 |
getRadius() |
数値 |
円の現在の半径を返します。単位はメートルです。 |
getBounds() |
LatLngBounds |
パスの |
メソッド | 戻り値 | 説明 |
---|---|---|
redraw() |
this |
レイヤーを再描画します。パスが使用する座標を変更した後に役立つ場合があります。 |
setStyle( |
this |
|
bringToFront() |
this |
レイヤーをすべてのパスレイヤーの最上部に移動します。 |
bringToBack() |
this |
レイヤーをすべてのパスレイヤーの最下部に移動します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
円マーカー
半径がピクセル単位で指定された固定サイズの円。Path
を拡張します。
作成
ファクトリ | 説明 |
---|---|
L.circleMarker( |
地理的な点とオプションのオプションオブジェクトを指定して、円マーカーオブジェクトをインスタンス化します。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
radius |
数値 |
10 |
円マーカーの半径(ピクセル単位) |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
stroke |
ブール値 |
true |
パスに沿ってストロークを描画するかどうか。ポリゴンまたは円の境界線を無効にするには、false に設定します。 |
color |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'#3388ff' |
ストロークの色 |
weight |
数値 |
3 |
ストロークの幅(ピクセル単位) |
マーカーにマウスオーバーすると表示されるブラウザのツールチップのテキスト(デフォルトではツールチップはありません)。アクセシビリティに役立ちます。 |
数値 |
1.0 |
ストロークの不透明度 |
lineCap |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'round' |
ストロークの終端で使用する形状を定義する文字列。 |
lineJoin |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'round' |
ストロークの角で使用する形状を定義する文字列。 |
dashArray |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
ストロークの破線パターンを定義する文字列。Canvas ベースのレイヤーでは、一部の古いブラウザでは機能しません。 |
dashOffset |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
破線パターンの開始位置までの距離を定義する文字列。Canvas ベースのレイヤーでは、一部の古いブラウザでは機能しません。 |
fill |
ブール値 |
depends |
パスを色で塗りつぶすかどうか。ポリゴンまたは円の塗りつぶしを無効にするには、false に設定します。 |
fillColor |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
* |
塗りつぶしの色。デフォルトでは、color オプションの値になります。 |
fillOpacity |
数値 |
0.2 |
塗りつぶしの不透明度。 |
fillRule |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'evenodd' |
シェイプの内側を決定する方法を定義する文字列。 |
bubblingMouseEvents |
ブール値 |
true |
true の場合、このパスでのマウスイベントはマップで同じイベントをトリガーします(L.DomEvent.stopPropagation が使用されている場合を除く)。 |
renderer |
レンダラー |
|
このパスにこの特定のRenderer インスタンスを使用します。マップのデフォルトのレンダラーよりも優先されます。 |
className |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
要素に設定されたカスタムクラス名。SVGレンダラーの場合のみ。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
interactive |
ブール値 |
true |
false の場合、レイヤーはマウスイベントを発行せず、下にあるマップの一部として機能します。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'overlayPane' |
デフォルトでは、レイヤーはマップのオーバーレイペインに追加されます。このオプションをオーバーライドすると、デフォルトでレイヤーは別のペインに配置されます。 |
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
イベント | データ | 説明 |
---|---|---|
move |
イベント |
マーカーがsetLatLng を介して移動されたときに発生します。古い座標と新しい座標は、イベント引数にoldLatLng 、latlng として含まれます。 |
イベント | データ | 説明 |
---|---|---|
click |
MouseEvent |
ユーザーがレイヤーをクリック(またはタップ)したときに発生します。 |
dblclick |
MouseEvent |
ユーザーがレイヤーをダブルクリック(またはダブルタップ)したときに発生します。 |
mousedown |
MouseEvent |
ユーザーがレイヤー上でマウスボタンを押したときに発生します。 |
mouseup |
MouseEvent |
ユーザーがレイヤー上で押されたマウスボタンを離したときに発生します。 |
mouseover |
MouseEvent |
マウスがレイヤーに入ったときに発生します。 |
mouseout |
MouseEvent |
マウスがレイヤーから離れたときに発生します。 |
contextmenu |
MouseEvent |
ユーザーがレイヤーを右クリックしたときに発生し、このイベントにリスナーがある場合は、デフォルトのブラウザのコンテキストメニューが表示されないようにします。モバイルでユーザーがシングルタッチを1秒間保持した場合(長押しとも呼ばれる)にも発生します。 |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
toGeoJSON( |
Object |
座標値は、指定された |
setLatLng( |
this |
円マーカーの位置を新しい場所に設定します。 |
getLatLng() |
LatLng |
円マーカーの現在の地理的な位置を返します。 |
setRadius( |
this |
円マーカーの半径を設定します。単位はピクセルです。 |
getRadius() |
数値 |
円の現在の半径を返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
redraw() |
this |
レイヤーを再描画します。パスが使用する座標を変更した後に役立つ場合があります。 |
setStyle( |
this |
|
bringToFront() |
this |
レイヤーをすべてのパスレイヤーの最上部に移動します。 |
bringToBack() |
this |
レイヤーをすべてのパスレイヤーの最下部に移動します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
SVG
SVGを使用してベクターレイヤーを表示できるようにします。Renderer
を継承します。
技術的な制限により、SVGはすべてのWebブラウザ(特にAndroid 2.xおよび3.x)で利用できるわけではありません。
SVGはIE7およびIE8では利用できませんが、これらのブラウザはVML(現在は非推奨の技術)をサポートしており、この場合、SVGレンダラーはVMLにフォールバックします。
VMLは2012年に非推奨となったため、VML機能は古いバージョンのInternet Explorerとの下位互換性のためだけに存在します。
使用例
マップ内のすべてのパスにはデフォルトでSVGを使用してください
var map = L.map('map', {
renderer: L.svg()
});
特定のベクタージオメトリには、追加のパディング付きのSVGレンダラーを使用してください
var map = L.map('map');
var myRenderer = L.svg({ padding: 0.5 });
var line = L.polyline( coordinates, { renderer: myRenderer } );
var circle = L.circle( center, { renderer: myRenderer } );
作成
ファクトリ | 説明 |
---|---|
L.svg( |
指定されたオプションでSVGレンダラーを作成します。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
paddingTopLeft |
数値 |
0.1 |
マップビューの周りのクリップ領域を拡張する量(サイズに対する相対的な割合)。例えば、0.1は各方向のマップビューの10%になります。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'overlayPane' |
デフォルトでは、レイヤーはマップのオーバーレイペインに追加されます。このオプションをオーバーライドすると、デフォルトでレイヤーは別のペインに配置されます。 |
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
イベント | データ | 説明 |
---|---|---|
update |
イベント |
レンダラーがその境界、中心、およびズームを更新したとき、たとえばマップが移動したときに発生します |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
関数
関数 | 戻り値 | 説明 |
---|---|---|
create( |
SVGElement |
渡されたクラス名に対応するSVGElementのインスタンスを返します。たとえば、「line」を使用すると、SVGLineElementのインスタンスが返されます。 |
pointsToPath( |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
複数のリングのSVGパス文字列を生成します。各リングは「M..L..L..」命令に変わります |
キャンバス
<canvas>
でベクターレイヤーを表示できるようにします。Renderer
を継承します。
技術的な制限のため、CanvasはすべてのWebブラウザー、特にIE8では利用できず、一部のエッジケースではジオメトリの重複が正しく表示されない場合があります。
使用例
マップ内のすべてのパスにはデフォルトでCanvasを使用してください
var map = L.map('map', {
renderer: L.canvas()
});
特定のベクタージオメトリには、追加のパディング付きのCanvasレンダラーを使用してください
var map = L.map('map');
var myRenderer = L.canvas({ padding: 0.5 });
var line = L.polyline( coordinates, { renderer: myRenderer } );
var circle = L.circle( center, { renderer: myRenderer } );
作成
ファクトリ | 説明 |
---|---|
L.canvas( |
指定されたオプションでCanvasレンダラーを作成します。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
tolerance |
数値 |
0 |
マップ上のパス/オブジェクト周辺のクリック許容範囲を拡張する量。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
paddingTopLeft |
数値 |
0.1 |
マップビューの周りのクリップ領域を拡張する量(サイズに対する相対的な割合)。例えば、0.1は各方向のマップビューの10%になります。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'overlayPane' |
デフォルトでは、レイヤーはマップのオーバーレイペインに追加されます。このオプションをオーバーライドすると、デフォルトでレイヤーは別のペインに配置されます。 |
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
イベント | データ | 説明 |
---|---|---|
update |
イベント |
レンダラーがその境界、中心、およびズームを更新したとき、たとえばマップが移動したときに発生します |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
レイヤーグループ
いくつかのレイヤーをグループ化し、それらを1つとして処理するために使用されます。マップに追加すると、グループに追加または削除されたレイヤーもマップに追加/削除されます。Layer
を拡張します。
使用例
L.layerGroup([marker1, marker2])
.addLayer(polyline)
.addTo(map);
作成
ファクトリ | 説明 |
---|---|
L.layerGroup( |
レイヤーグループを作成します。オプションで、初期レイヤーセットとoptions オブジェクトを指定できます。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
interactive |
ブール値 |
true |
false の場合、レイヤーはマウスイベントを発行せず、下にあるマップの一部として機能します。 |
bubblingMouseEvents |
ブール値 |
true |
true の場合、このレイヤー上のマウスイベントは、L.DomEvent.stopPropagation が使用されない限り、マップ上で同じイベントをトリガーします。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'overlayPane' |
デフォルトでは、レイヤーはマップのオーバーレイペインに追加されます。このオプションをオーバーライドすると、デフォルトでレイヤーは別のペインに配置されます。 |
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
イベント | データ | 説明 |
---|---|---|
click |
MouseEvent |
ユーザーがレイヤーをクリック(またはタップ)したときに発生します。 |
dblclick |
MouseEvent |
ユーザーがレイヤーをダブルクリック(またはダブルタップ)したときに発生します。 |
mousedown |
MouseEvent |
ユーザーがレイヤー上でマウスボタンを押したときに発生します。 |
mouseup |
MouseEvent |
ユーザーがレイヤー上で押されたマウスボタンを離したときに発生します。 |
mouseover |
MouseEvent |
マウスがレイヤーに入ったときに発生します。 |
mouseout |
MouseEvent |
マウスがレイヤーから離れたときに発生します。 |
contextmenu |
MouseEvent |
ユーザーがレイヤーを右クリックしたときに発生し、このイベントにリスナーがある場合は、デフォルトのブラウザのコンテキストメニューが表示されないようにします。モバイルでユーザーがシングルタッチを1秒間保持した場合(長押しとも呼ばれる)にも発生します。 |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
toGeoJSON( |
Object |
座標値は、指定された |
addLayer( |
this |
指定されたレイヤーをグループに追加します。 |
removeLayer( |
this |
指定されたレイヤーをグループから削除します。 |
removeLayer( |
this |
指定された内部IDを持つレイヤーをグループから削除します。 |
hasLayer( |
ブール値 |
指定されたレイヤーが現在グループに追加されている場合は |
hasLayer( |
ブール値 |
指定された内部IDが現在グループに追加されている場合は |
clearLayers() |
this |
グループからすべてのレイヤーを削除します。 |
invoke( |
this |
このグループに含まれるすべてのレイヤーで |
eachLayer( |
this |
グループのレイヤーを反復処理します。オプションで、イテレーター関数のコンテキストを指定できます。
|
getLayer( |
レイヤー |
指定された内部IDを持つレイヤーを返します。 |
getLayers() |
Layer[] |
グループに追加されたすべてのレイヤーの配列を返します。 |
setZIndex( |
this |
このグループに含まれるすべてのレイヤーで |
getLayerId( |
数値 |
レイヤーの内部IDを返します |
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
フィーチャーグループ
すべてのメンバーレイヤーに対して同じことを簡単に行うことができるように拡張されたLayerGroup
bindPopup
は、すべてのレイヤーに一度にポップアップをバインドします(同様にbindTooltip
を使用します)。- イベントは
FeatureGroup
に伝播されるため、グループにイベントハンドラーがある場合、いずれかのレイヤーからのイベントを処理します。これには、マウスイベントとカスタムイベントが含まれます。 layeradd
とlayerremove
イベントがあります
使用例
L.featureGroup([marker1, marker2, polyline])
.bindPopup('Hello world!')
.on('click', function() { alert('Clicked on a member of the group!'); })
.addTo(map);
作成
ファクトリ | 説明 |
---|---|
L.featureGroup( |
フィーチャーグループを作成します。オプションで、初期レイヤーセットとoptions オブジェクトを指定できます。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
interactive |
ブール値 |
true |
false の場合、レイヤーはマウスイベントを発行せず、下にあるマップの一部として機能します。 |
bubblingMouseEvents |
ブール値 |
true |
true の場合、このレイヤー上のマウスイベントは、L.DomEvent.stopPropagation が使用されない限り、マップ上で同じイベントをトリガーします。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'overlayPane' |
デフォルトでは、レイヤーはマップのオーバーレイペインに追加されます。このオプションをオーバーライドすると、デフォルトでレイヤーは別のペインに配置されます。 |
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
イベント | データ | 説明 |
---|---|---|
layeradd |
LayerEvent |
レイヤーがこのFeatureGroup に追加されたときに発生します |
layerremove |
LayerEvent |
レイヤーがこのFeatureGroup から削除されたときに発生します |
イベント | データ | 説明 |
---|---|---|
click |
MouseEvent |
ユーザーがレイヤーをクリック(またはタップ)したときに発生します。 |
dblclick |
MouseEvent |
ユーザーがレイヤーをダブルクリック(またはダブルタップ)したときに発生します。 |
mousedown |
MouseEvent |
ユーザーがレイヤー上でマウスボタンを押したときに発生します。 |
mouseup |
MouseEvent |
ユーザーがレイヤー上で押されたマウスボタンを離したときに発生します。 |
mouseover |
MouseEvent |
マウスがレイヤーに入ったときに発生します。 |
mouseout |
MouseEvent |
マウスがレイヤーから離れたときに発生します。 |
contextmenu |
MouseEvent |
ユーザーがレイヤーを右クリックしたときに発生し、このイベントにリスナーがある場合は、デフォルトのブラウザのコンテキストメニューが表示されないようにします。モバイルでユーザーがシングルタッチを1秒間保持した場合(長押しとも呼ばれる)にも発生します。 |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
setStyle( |
this |
|
bringToFront() |
this |
レイヤーグループを他のすべてのレイヤーの一番上に移動します |
bringToBack() |
this |
レイヤーグループを他のすべてのレイヤーの一番下に移動します |
getBounds() |
LatLngBounds |
フィーチャーグループのLatLngBoundsを返します(子要素の境界と座標から作成されます)。 |
メソッド | 戻り値 | 説明 |
---|---|---|
toGeoJSON( |
Object |
座標値は、指定された |
addLayer( |
this |
指定されたレイヤーをグループに追加します。 |
removeLayer( |
this |
指定されたレイヤーをグループから削除します。 |
removeLayer( |
this |
指定された内部IDを持つレイヤーをグループから削除します。 |
hasLayer( |
ブール値 |
指定されたレイヤーが現在グループに追加されている場合は |
hasLayer( |
ブール値 |
指定された内部IDが現在グループに追加されている場合は |
clearLayers() |
this |
グループからすべてのレイヤーを削除します。 |
invoke( |
this |
このグループに含まれるすべてのレイヤーで |
eachLayer( |
this |
グループのレイヤーを反復処理します。オプションで、イテレーター関数のコンテキストを指定できます。
|
getLayer( |
レイヤー |
指定された内部IDを持つレイヤーを返します。 |
getLayers() |
Layer[] |
グループに追加されたすべてのレイヤーの配列を返します。 |
setZIndex( |
this |
このグループに含まれるすべてのレイヤーで |
getLayerId( |
数値 |
レイヤーの内部IDを返します |
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
GeoJSON
GeoJSONオブジェクトまたはGeoJSONオブジェクトの配列を表します。GeoJSONデータを解析してマップに表示できます。FeatureGroup
を拡張します。
使用例
L.geoJSON(data, {
style: function (feature) {
return {color: feature.properties.color};
}
}).bindPopup(function (layer) {
return layer.feature.properties.description;
}).addTo(map);
作成
ファクトリ | 説明 |
---|---|
L.geoJSON( |
GeoJSONレイヤーを作成します。オプションで、マップに表示するGeoJSON形式のオブジェクト(または、後でaddData メソッドで追加することもできます)とoptions オブジェクトを受け入れます。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
pointToLayer |
関数 |
* |
GeoJSONポイントがLeafletレイヤーを生成する方法を定義するFunction 。データが追加されるときに内部的に呼び出され、GeoJSONポイントフィーチャーとそのLatLng を渡します。デフォルトは、デフォルトのMarker を生成することです。
|
style |
関数 |
* |
GeoJSONラインとポリゴンをスタイル設定するためのパスオプション を定義するFunction 。データが追加されるときに内部的に呼び出されます。デフォルト値は、デフォルトを上書きしないことです
|
onEachFeature |
関数 |
* |
作成された各Feature に対して、作成およびスタイル設定された後に一度呼び出されるFunction 。フィーチャーにイベントとポップアップをアタッチするのに役立ちます。デフォルトは、新しく作成されたレイヤーを何もせずに処理することです
|
filter |
関数 |
* |
フィーチャーを含めるかどうかを決定するために使用されるFunction 。デフォルトは、すべてのフィーチャーを含めることです
注: |
coordsToLatLng |
関数 |
* |
GeoJSON座標をLatLng に変換するために使用されるFunction 。デフォルトはcoordsToLatLng 静的メソッドです。 |
markersInheritOptions |
ブール値 |
false |
"Point"タイプのフィーチャーのデフォルトのマーカーがグループオプションから継承するかどうか。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
interactive |
ブール値 |
true |
false の場合、レイヤーはマウスイベントを発行せず、下にあるマップの一部として機能します。 |
bubblingMouseEvents |
ブール値 |
true |
true の場合、このレイヤー上のマウスイベントは、L.DomEvent.stopPropagation が使用されない限り、マップ上で同じイベントをトリガーします。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'overlayPane' |
デフォルトでは、レイヤーはマップのオーバーレイペインに追加されます。このオプションをオーバーライドすると、デフォルトでレイヤーは別のペインに配置されます。 |
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
イベント | データ | 説明 |
---|---|---|
layeradd |
LayerEvent |
レイヤーがこのFeatureGroup に追加されたときに発生します |
layerremove |
LayerEvent |
レイヤーがこのFeatureGroup から削除されたときに発生します |
イベント | データ | 説明 |
---|---|---|
click |
MouseEvent |
ユーザーがレイヤーをクリック(またはタップ)したときに発生します。 |
dblclick |
MouseEvent |
ユーザーがレイヤーをダブルクリック(またはダブルタップ)したときに発生します。 |
mousedown |
MouseEvent |
ユーザーがレイヤー上でマウスボタンを押したときに発生します。 |
mouseup |
MouseEvent |
ユーザーがレイヤー上で押されたマウスボタンを離したときに発生します。 |
mouseover |
MouseEvent |
マウスがレイヤーに入ったときに発生します。 |
mouseout |
MouseEvent |
マウスがレイヤーから離れたときに発生します。 |
contextmenu |
MouseEvent |
ユーザーがレイヤーを右クリックしたときに発生し、このイベントにリスナーがある場合は、デフォルトのブラウザのコンテキストメニューが表示されないようにします。モバイルでユーザーがシングルタッチを1秒間保持した場合(長押しとも呼ばれる)にも発生します。 |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
addData(data) |
this |
GeoJSONオブジェクトをレイヤーに追加します。 |
resetStyle(layer?) |
this |
指定されたベクターレイヤーのスタイルを元のGeoJSONスタイルにリセットします。これは、ホバーイベント後にスタイルをリセットする場合に役立ちます。 |
setStyle(style) |
this |
指定されたスタイル関数を使用して、GeoJSONベクターレイヤーのスタイルを変更します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bringToFront() |
this |
レイヤーグループを他のすべてのレイヤーの一番上に移動します |
bringToBack() |
this |
レイヤーグループを他のすべてのレイヤーの一番下に移動します |
getBounds() |
LatLngBounds |
フィーチャーグループのLatLngBoundsを返します(子要素の境界と座標から作成されます)。 |
メソッド | 戻り値 | 説明 |
---|---|---|
toGeoJSON( |
Object |
座標値は、指定された |
addLayer( |
this |
指定されたレイヤーをグループに追加します。 |
removeLayer( |
this |
指定されたレイヤーをグループから削除します。 |
removeLayer( |
this |
指定された内部IDを持つレイヤーをグループから削除します。 |
hasLayer( |
ブール値 |
指定されたレイヤーが現在グループに追加されている場合は |
hasLayer( |
ブール値 |
指定された内部IDが現在グループに追加されている場合は |
clearLayers() |
this |
グループからすべてのレイヤーを削除します。 |
invoke( |
this |
このグループに含まれるすべてのレイヤーで |
eachLayer( |
this |
グループのレイヤーを反復処理します。オプションで、イテレーター関数のコンテキストを指定できます。
|
getLayer( |
レイヤー |
指定された内部IDを持つレイヤーを返します。 |
getLayers() |
Layer[] |
グループに追加されたすべてのレイヤーの配列を返します。 |
setZIndex( |
this |
このグループに含まれるすべてのレイヤーで |
getLayerId( |
数値 |
レイヤーの内部IDを返します |
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
関数
関数 | 戻り値 | 説明 |
---|---|---|
geometryToLayer( |
レイヤー |
指定されたGeoJSONフィーチャーからLayer を作成します。オプションとして提供されている場合、カスタムのpointToLayer またはcoordsToLatLng 関数を使用できます。 |
coordsToLatLng( |
LatLng |
GeoJSONでポイントに使用される2つの数値(経度、緯度)または3つの数値(経度、緯度、高度)の配列からLatLng オブジェクトを作成します。 |
coordsToLatLngs( |
Array |
GeoJSON座標配列からLatLng の多次元配列を作成します。levelsDeep はネストレベルを指定します(0はポイントの配列、1はポイントの配列の配列など、デフォルトは0)。カスタムのcoordsToLatLng 関数を使用できます。 |
latLngToCoords( |
Array |
coordsToLatLng の逆。座標値は、formatNum 関数で丸められます。 |
latLngsToCoords( |
Array |
coordsToLatLngs の逆。closed は、フィーチャーを閉じるために配列の最後に最初のポイントを追加する必要があるかどうかを決定します。これは、levelsDeep が0の場合にのみ使用されます。デフォルトはfalseです。座標値は、formatNum 関数で丸められます。 |
asFeature( |
Object |
GeoJSONジオメトリ/フィーチャーをGeoJSONフィーチャーに正規化します。 |
グリッドレイヤー
HTML要素のタイルグリッドを処理するための汎用クラス。これは、すべてのタイルレイヤーの基本クラスであり、TileLayer.Canvas
を置き換えます。GridLayerは、<canvas>
、<img>
、または<div>
のようなHTML要素のタイルグリッドを作成するために拡張できます。GridLayerは、これらのDOM要素の作成とアニメーションを処理します。
使用例
同期的な使用法
カスタムレイヤーを作成するには、GridLayerを拡張し、Point
オブジェクトと、タイルの描画に使用するx
、y
、およびz
(ズームレベル)座標が渡されるcreateTile()
メソッドを実装します。
var CanvasLayer = L.GridLayer.extend({
createTile: function(coords){
// create a <canvas> element for drawing
var tile = L.DomUtil.create('canvas', 'leaflet-tile');
// setup tile width and height according to the options
var size = this.getTileSize();
tile.width = size.x;
tile.height = size.y;
// get a canvas context and draw something on it using coords.x, coords.y and coords.z
var ctx = tile.getContext('2d');
// return the tile so it can be rendered on screen
return tile;
}
});
非同期的な使用法
タイルの作成は非同期にすることもできます。これは、サードパーティの描画ライブラリを使用する場合に役立ちます。タイルの描画が完了したら、done()
コールバックに渡すことができます。
var CanvasLayer = L.GridLayer.extend({
createTile: function(coords, done){
var error;
// create a <canvas> element for drawing
var tile = L.DomUtil.create('canvas', 'leaflet-tile');
// setup tile width and height according to the options
var size = this.getTileSize();
tile.width = size.x;
tile.height = size.y;
// draw something asynchronously and pass the tile to the done() callback
setTimeout(function() {
done(error, tile);
}, 1000);
return tile;
}
});
作成
ファクトリ | 説明 |
---|---|
L.gridLayer( |
指定されたオプションを使用して、GridLayerの新しいインスタンスを作成します。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
tileSize |
Number|Point |
256 |
グリッド内のタイルの幅と高さ。幅と高さが等しい場合は数値を使用するか、それ以外の場合は L.point(width, height) を使用します。 |
マーカーにマウスオーバーすると表示されるブラウザのツールチップのテキスト(デフォルトではツールチップはありません)。アクセシビリティに役立ちます。 |
数値 |
1.0 |
タイルの不透明度。createTile() 関数で使用できます。 |
updateWhenIdle |
ブール値 |
(depends) |
パンが終わったときにのみ新しいタイルをロードします。モバイルブラウザでは、過剰なリクエストを回避し、スムーズなナビゲーションを維持するために、デフォルトで true に設定されています。デスクトップブラウザでは、keepBuffer オプションの外に簡単にパンできるため、パン中に新しいタイルを表示するために、それ以外の場合は false に設定されています。 |
updateWhenZooming |
ブール値 |
true |
デフォルトでは、スムーズなズームアニメーション(タッチズームまたは flyTo() 中)は、すべての整数ズームレベルでグリッドレイヤーを更新します。このオプションを false に設定すると、スムーズなアニメーションが終了したときにのみグリッドレイヤーが更新されます。 |
updateInterval |
数値 |
200 |
パン時に、タイルが updateInterval ミリ秒ごとに 1 回以上更新されることはありません。 |
zIndex |
数値 |
1 |
タイルレイヤーの明示的な zIndex。 |
bounds |
LatLngBounds |
未定義 |
設定されている場合、タイルは設定された LatLngBounds 内でのみロードされます。 |
minZoom |
数値 |
0 |
このレイヤーが表示される最小ズームレベル(両端を含む)。 |
maxZoom |
数値 |
未定義 |
このレイヤーが表示される最大ズームレベル(両端を含む)。 |
maxNativeZoom |
数値 |
未定義 |
タイルソースで使用可能な最大ズーム番号。指定されている場合、maxNativeZoom より高いすべてのズームレベルのタイルは、maxNativeZoom レベルからロードされ、自動的にスケーリングされます。 |
minNativeZoom |
数値 |
未定義 |
タイルソースで使用可能な最小ズーム番号。指定されている場合、minNativeZoom より低いすべてのズームレベルのタイルは、minNativeZoom レベルからロードされ、自動的にスケーリングされます。 |
noWrap |
ブール値 |
false |
レイヤーが子午線をラップするかどうか。true の場合、GridLayer は低いズームレベルで 1 回だけ表示されます。マップ CRS がラップしない場合は効果がありません。bounds と組み合わせて使用し、CRS 制限外のタイルを要求しないようにすることができます。 |
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'tilePane' |
グリッドレイヤーが追加される マップペイン 。 |
className |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
タイルレイヤーに割り当てるカスタムクラス名。デフォルトでは空です。 |
keepBuffer |
数値 |
2 |
マップをパンするとき、タイルのこの数の行と列をアンロードする前に保持します。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
イベント | データ | 説明 |
---|---|---|
loading |
イベント |
グリッドレイヤーがタイルのロードを開始したときに発生します。 |
tileunload |
TileEvent |
タイルが削除されたときに発生します(たとえば、タイルが画面外に出たとき)。 |
tileloadstart |
TileEvent |
タイルが要求され、ロードを開始したときに発生します。 |
tileerror |
TileErrorEvent |
タイルのロード中にエラーが発生したときに発生します。 |
tileload |
TileEvent |
タイルがロードされたときに発生します。 |
load |
イベント |
グリッドレイヤーがすべての可視タイルをロードしたときに発生します。 |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
bringToFront() |
this |
すべてのタイルレイヤーの上にタイルレイヤーを移動します。 |
bringToBack() |
this |
すべてのタイルレイヤーの下にタイルレイヤーを移動します。 |
getContainer() |
HTMLElement |
このレイヤーのタイルを含む HTML 要素を返します。 |
setOpacity( |
this |
グリッドレイヤーの opacity を変更します。 |
setZIndex( |
this |
グリッドレイヤーの zIndex を変更します。 |
isLoading() |
ブール値 |
グリッドレイヤーのタイルがロードを完了していない場合、 |
redraw() |
this |
レイヤーがすべてのタイルをクリアし、再度要求するようにします。 |
getTileSize() |
ポイント |
tileSize オプションをポイントに正規化します。 |
拡張メソッド
GridLayer
を拡張するレイヤーは、次のメソッドを再実装する必要があります。メソッド | 戻り値 | 説明 |
---|---|---|
createTile( |
HTMLElement |
内部でのみ呼び出されます。必ず |
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
LatLng
特定の緯度と経度を持つ地理的な点を表します。
使用例
var latlng = L.latLng(50.5, 30.5);
LatLngオブジェクトを受け入れるすべてのLeafletメソッドは、単純な配列形式と単純なオブジェクト形式でも受け入れます(特に記載のない限り)。したがって、次の行は同等です
map.panTo([50, 30]);
map.panTo({lng: 30, lat: 50});
map.panTo({lat: 50, lng: 30});
map.panTo(L.latLng(50, 30));
LatLng
は Leaflet の Class
オブジェクトを継承していないため、新しいクラスがそれを継承したり、include
関数を使って新しいメソッドを追加したりできないことに注意してください。
作成
ファクトリ | 説明 |
---|---|
L.latLng( |
指定された緯度、経度(およびオプションで高度)を持つ地理的な点を表すオブジェクトを作成します。 |
L.latLng( |
代わりに、[Number, Number] または [Number, Number, Number] の形式の配列を予期します。 |
L.latLng( |
代わりに、{lat: Number, lng: Number} または {lat: Number, lng: Number, alt: Number} の形式のプレーンなオブジェクトを予期します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
equals(等しいか)( |
ブール値 |
指定された |
toString() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
(デバッグ目的で)点の文字列表現を返します。 |
distanceTo( |
数値 |
|
wrap() |
LatLng |
経度が常に -180 度から +180 度の間になるようにラップされた新しい |
toBounds( |
LatLngBounds |
各境界が |
プロパティ
Property | 型 | 説明 |
---|---|---|
lat |
数値 |
度単位の緯度 |
lng |
数値 |
度単位の経度 |
マーカーのレンダリングに使用するアイコンインスタンス。マーカーアイコンをカスタマイズする方法の詳細については、Iconドキュメントを参照してください。指定されていない場合は、 |
数値 |
メートル単位の高度(オプション) |
LatLngBounds
地図上の長方形の地理的領域を表します。
使用例
var corner1 = L.latLng(40.712, -74.227),
corner2 = L.latLng(40.774, -74.125),
bounds = L.latLngBounds(corner1, corner2);
LatLngBounds オブジェクトを受け入れるすべての Leaflet メソッドは、特に記載がない限り、単純な配列形式でも受け入れるため、上記の境界の例は次のように渡すことができます。
map.fitBounds([
[40.712, -74.227],
[40.774, -74.125]
]);
注意:領域が子午線を越える場合(国際日付変更線と混同されがちです)、[-180, 180] 度の経度範囲外にコーナーを指定する必要があります。
LatLngBounds
は Leaflet の Class
オブジェクトを継承していないため、新しいクラスがそれを継承したり、include
関数を使って新しいメソッドを追加したりできないことに注意してください。
作成
ファクトリ | 説明 |
---|---|
L.latLngBounds( |
長方形の対角線上にある 2 つのコーナーを定義して、LatLngBounds オブジェクトを作成します。 |
L.latLngBounds( |
それが含む地理的な点によって定義された LatLngBounds オブジェクトを作成します。fitBounds を使用して、特定の場所のセットに合わせて地図をズームするのに非常に便利です。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
extend(拡張)( |
this |
指定された点を含むように境界を拡張します |
extend(拡張)( |
this |
指定された境界を含むように境界を拡張します |
pad(パディング)( |
LatLngBounds |
現在の境界を各方向に指定された比率で拡張または縮小して作成された境界を返します。たとえば、比率 0.5 は、各方向で境界を 50% 拡張します。負の値は境界を縮小します。 |
getCenter() |
LatLng |
境界の中心点を返します。 |
getSouthWest() |
LatLng |
境界の南西点を返します。 |
getNorthEast() |
LatLng |
境界の北東点を返します。 |
getNorthWest() |
LatLng |
境界の北西点を返します。 |
getSouthEast() |
LatLng |
境界の南東点を返します。 |
getWest() |
数値 |
境界の西経度を返します |
getSouth() |
数値 |
境界の南緯度を返します |
getEast() |
数値 |
境界の東経度を返します |
getNorth() |
数値 |
境界の北緯度を返します |
contains(含むか)( |
ブール値 |
指定された長方形をこの長方形が含む場合は |
contains(含むか)( |
ブール値 |
指定された点をこの長方形が含む場合は |
intersects(交差するか)( |
ブール値 |
指定された境界とこの長方形が交差する場合は |
overlaps(重なり合うか)( |
ブール値 |
指定された境界とこの長方形が重なり合う場合は |
toBBoxString() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'southwest_lng,southwest_lat,northeast_lng,northeast_lat' 形式で境界ボックスの座標を持つ文字列を返します。地理データを返す Web サービスにリクエストを送信するのに役立ちます。 |
equals(等しいか)( |
ブール値 |
指定された境界とこの長方形が(小さな誤差範囲内で)等しい場合は |
isValid(有効か)() |
ブール値 |
境界が適切に初期化されている場合は |
ポイント
ピクセル座標での x
および y
座標を持つ点を表します。
使用例
var point = L.point(200, 300);
Point
オブジェクトを受け入れるすべての Leaflet メソッドとオプションは、特に記載がない限り、単純な配列形式でも受け入れるため、これらの行は同等です。
map.panBy([200, 300]);
map.panBy(L.point(200, 300));
Point
は Leaflet の Class
オブジェクトを継承していないため、新しいクラスがそれを継承したり、include
関数を使って新しいメソッドを追加したりできないことに注意してください。
作成
ファクトリ | 説明 |
---|---|
L.point( |
指定された x および y 座標を持つ Point オブジェクトを作成します。オプションの round が true に設定されている場合は、x および y の値を丸めます。 |
L.point( |
代わりに、[x, y] 形式の配列を予期します。 |
L.point( |
代わりに、{x: Number, y: Number} 形式のプレーンなオブジェクトを予期します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
clone(複製)() |
ポイント |
現在の点のコピーを返します。 |
add( |
ポイント |
現在の点と指定された点の加算の結果を返します。 |
subtract(減算)( |
ポイント |
現在の点から指定された点を減算した結果を返します。 |
divideBy(除算)( |
ポイント |
現在の点を指定された数値で除算した結果を返します。 |
multiplyBy(乗算)( |
ポイント |
現在の点を指定された数値で乗算した結果を返します。 |
scaleBy(スケール)( |
ポイント |
現在の点の各座標を |
unscaleBy(逆スケール)( |
ポイント |
|
round(丸め)() |
ポイント |
丸められた座標を持つ現在の点のコピーを返します。 |
floor(床)() |
ポイント |
切り捨てられた座標(切り捨て)を持つ現在の点のコピーを返します。 |
ceil(天井)() |
ポイント |
切り上げられた座標(切り上げ)を持つ現在の点のコピーを返します。 |
trunc(切り捨て)() |
ポイント |
切り捨てられた座標(ゼロに向かって丸め)を持つ現在の点のコピーを返します。 |
distanceTo( |
数値 |
現在と指定された点との間の直交距離を返します。 |
equals(等しいか)( |
ブール値 |
指定された点が同じ座標を持つ場合は |
contains(含むか)( |
ブール値 |
指定された点の両方の座標が、対応する現在の点の座標(絶対値)よりも小さい場合は |
toString() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
デバッグ目的で、点の文字列表現を返します。 |
プロパティ
Property | 型 | 説明 |
---|---|---|
x |
数値 |
点の x 座標 |
y |
数値 |
点の y 座標 |
バウンズ
ピクセル座標での長方形の領域を表します。
使用例
var p1 = L.point(10, 10),
p2 = L.point(40, 60),
bounds = L.bounds(p1, p2);
Bounds
オブジェクトを受け入れるすべての Leaflet メソッドは、特に記載がない限り、単純な配列形式でも受け入れるため、上記の境界の例は次のように渡すことができます。
otherBounds.intersects([[10, 10], [40, 60]]);
Bounds
は Leaflet の Class
オブジェクトを継承していないため、新しいクラスがそれを継承したり、include
関数を使って新しいメソッドを追加したりできないことに注意してください。
作成
ファクトリ | 説明 |
---|---|
L.bounds( |
2 つのコーナー座標ペアから Bounds オブジェクトを作成します。 |
L.bounds( |
指定された点の配列から Bounds オブジェクトを作成します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
extend(拡張)( |
this |
指定された点を含むように境界を拡張します。 |
extend(拡張)( |
this |
指定された境界を含むように境界を拡張します |
getCenter( |
ポイント |
境界の中心点を返します。 |
getBottomLeft() |
ポイント |
境界の左下点を返します。 |
getTopRight() |
ポイント |
境界の右上点を返します。 |
getTopLeft() |
ポイント |
境界の左上点(つまり、 |
getBottomRight() |
ポイント |
境界の右下点(つまり、 |
getSize() |
ポイント |
指定された境界のサイズを返します |
contains(含むか)( |
ブール値 |
指定された長方形をこの長方形が含む場合は |
contains(含むか)( |
ブール値 |
指定された点をこの長方形が含む場合は |
intersects(交差するか)( |
ブール値 |
指定された境界とこの長方形が交差する場合は |
overlaps(重なり合うか)( |
ブール値 |
指定された境界とこの長方形が重なり合う場合は |
isValid(有効か)() |
ブール値 |
境界が適切に初期化されている場合は |
pad(パディング)( |
バウンズ |
現在の境界を各方向に指定された比率で拡張または縮小して作成された境界を返します。たとえば、比率 0.5 は、各方向で境界を 50% 拡張します。負の値は境界を縮小します。 |
equals(等しいか)( |
ブール値 |
長方形が指定された境界と等しい場合は |
プロパティ
Property | 型 | 説明 |
---|---|---|
min |
ポイント |
長方形の左上隅。 |
max |
ポイント |
長方形の右下隅。 |
アイコン
マーカーを作成するときに提供するアイコンを表します。
使用例
var myIcon = L.icon({
iconUrl: 'my-icon.png',
iconSize: [38, 95],
iconAnchor: [22, 94],
popupAnchor: [-3, -76],
shadowUrl: 'my-icon-shadow.png',
shadowSize: [68, 95],
shadowAnchor: [22, 94]
});
L.marker([50.505, 30.57], {icon: myIcon}).addTo(map);
L.Icon.Default
は L.Icon
を拡張したもので、Leaflet がデフォルトでマーカーに使用する青いアイコンです。
作成
ファクトリ | 説明 |
---|---|
L.icon( |
指定されたオプションでアイコンインスタンスを作成します。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
iconUrl |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
(必須)アイコンイメージへの URL(スクリプトパスからの絶対パスまたは相対パス)。 |
iconRetinaUrl |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
アイコンイメージの Retina サイズバージョンの URL(スクリプトパスからの絶対パスまたは相対パス)。Retina スクリーンデバイスに使用されます。 |
iconSize |
ポイント |
null |
ピクセル単位のアイコンイメージのサイズ。 |
iconAnchor |
ポイント |
null |
アイコンの「先端」の座標(左上隅を基準)。アイコンは、この点がマーカーの地理的な位置になるように配置されます。サイズが指定されている場合はデフォルトで中央揃えになり、CSS で負のマージンを設定することもできます。 |
popupAnchor |
ポイント |
[0, 0] |
ポップアップが「開く」ポイントの座標(アイコンアンカーを基準)。 |
tooltipAnchor |
ポイント |
[0, 0] |
ツールチップが「開く」ポイントの座標(アイコンアンカーを基準)。 |
shadowUrl |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
アイコンの影イメージへの URL。指定しない場合は、影イメージは作成されません。 |
shadowRetinaUrl |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
|
shadowSize |
ポイント |
null |
ピクセル単位の影イメージのサイズ。 |
shadowAnchor |
ポイント |
null |
影の「先端」の座標(左上隅を基準)(指定しない場合は iconAnchor と同じ)。 |
className |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
アイコンと影イメージの両方に割り当てるカスタムクラス名。デフォルトでは空。 |
crossOrigin |
ブール値|文字列 |
false |
crossOrigin 属性がタイルに追加されるかどうか。文字列が指定されている場合、すべてのタイルには、指定された文字列に設定された crossOrigin 属性があります。これは、タイルピクセルデータにアクセスする場合に必要です。有効な文字列値については、CORS 設定を参照してください。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
createIcon( |
HTMLElement |
アイコンを表示する必要がある場合に内部的に呼び出され、オプションに従ってスタイルが設定された |
createShadow( |
HTMLElement |
|
Icon.Default
Icon
の簡単なサブクラスで、アイコンが指定されていない場合に Marker
で使用するアイコンを表します。Leaflet リリースで配布される青いマーカーイメージを指します。デフォルトのアイコンをカスタマイズするには、L.Icon.Default.prototype.options
のプロパティ(アイコンオプション
のセット)を変更するだけです。
デフォルトのアイコンを完全に置き換える場合は、代わりに独自のアイコンで L.Marker.prototype.options.icon
をオーバーライドします。
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
imagePath |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
Icon.Default は、青いアイコンイメージの場所を自動的に検出しようとします。これらのイメージを標準外の方法で配置する場合は、このオプションを正しいパスを指すように設定します。 |
Divアイコン
イメージの代わりに単純な <div>
要素を使用する、マーカー用の軽量アイコンを表します。Icon
から継承しますが、iconUrl
および影のオプションは無視します。
使用例
var myIcon = L.divIcon({className: 'my-div-icon'});
// you can set .my-div-icon styles in CSS
L.marker([50.505, 30.57], {icon: myIcon}).addTo(map);
デフォルトでは、'leaflet-div-icon' CSS クラスを持ち、影のある小さな白い正方形としてスタイル設定されています。
作成
ファクトリ | 説明 |
---|---|
L.divIcon( |
指定されたオプションで DivIcon インスタンスを作成します。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
html |
String|HTMLElement |
'' |
div要素内に配置するカスタムHTMLコード。デフォルトでは空です。または、HTMLElement のインスタンス。 |
bgPos |
ポイント |
[0, 0] |
背景のオプションの相対位置(ピクセル単位) |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
iconUrl |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
(必須)アイコンイメージへの URL(スクリプトパスからの絶対パスまたは相対パス)。 |
iconRetinaUrl |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
アイコンイメージの Retina サイズバージョンの URL(スクリプトパスからの絶対パスまたは相対パス)。Retina スクリーンデバイスに使用されます。 |
iconSize |
ポイント |
null |
ピクセル単位のアイコンイメージのサイズ。 |
iconAnchor |
ポイント |
null |
アイコンの「先端」の座標(左上隅を基準)。アイコンは、この点がマーカーの地理的な位置になるように配置されます。サイズが指定されている場合はデフォルトで中央揃えになり、CSS で負のマージンを設定することもできます。 |
popupAnchor |
ポイント |
[0, 0] |
ポップアップが「開く」ポイントの座標(アイコンアンカーを基準)。 |
tooltipAnchor |
ポイント |
[0, 0] |
ツールチップが「開く」ポイントの座標(アイコンアンカーを基準)。 |
shadowUrl |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
アイコンの影イメージへの URL。指定しない場合は、影イメージは作成されません。 |
shadowRetinaUrl |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
|
shadowSize |
ポイント |
null |
ピクセル単位の影イメージのサイズ。 |
shadowAnchor |
ポイント |
null |
影の「先端」の座標(左上隅を基準)(指定しない場合は iconAnchor と同じ)。 |
className |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'' |
アイコンと影イメージの両方に割り当てるカスタムクラス名。デフォルトでは空。 |
crossOrigin |
ブール値|文字列 |
false |
crossOrigin 属性がタイルに追加されるかどうか。文字列が指定されている場合、すべてのタイルには、指定された文字列に設定された crossOrigin 属性があります。これは、タイルピクセルデータにアクセスする場合に必要です。有効な文字列値については、CORS 設定を参照してください。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
createIcon( |
HTMLElement |
アイコンを表示する必要がある場合に内部的に呼び出され、オプションに従ってスタイルが設定された |
createShadow( |
HTMLElement |
|
Control.Zoom
2つのボタン(ズームインとズームアウト)を備えた基本的なズームコントロール。マップのzoomControl
オプションをfalse
に設定しない限り、デフォルトでマップ上に配置されます。Control
を拡張します。
作成
ファクトリ | 説明 |
---|---|
L.control.zoom( |
ズームコントロールを作成します。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
zoomInText |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'<span aria-hidden="true">+</span>' |
'ズームイン'ボタンに設定されたテキスト。 |
zoomInTitle |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'ズームイン' |
'ズームイン'ボタンに設定されたタイトル。 |
zoomOutText |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'<span aria-hidden="true">−</span>' |
'ズームアウト'ボタンに設定されたテキスト。 |
zoomOutTitle |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'ズームアウト' |
'ズームアウト'ボタンに設定されたタイトル。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
position |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'topright' |
コントロールの位置(マップの角の1つ)。指定可能な値は、'topleft' 、'topright' 、'bottomleft' 、または'bottomright' です。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
getPosition() |
string |
コントロールの位置を返します。 |
setPosition( |
this |
コントロールの位置を設定します。 |
getContainer() |
HTMLElement |
コントロールを含むHTMLElementを返します。 |
addTo( |
this |
指定されたマップにコントロールを追加します。 |
remove() |
this |
現在アクティブなマップからコントロールを削除します。 |
Control.Attribution
属性コントロールを使用すると、マップ上の小さなテキストボックスに属性データを表示できます。マップのattributionControl
オプションをfalse
に設定しない限り、デフォルトでマップ上に配置されます。また、getAttribution
メソッドを持つレイヤーから属性テキストを自動的に取得します。Controlを拡張します。
作成
ファクトリ | 説明 |
---|---|
L.control.attribution( |
属性コントロールを作成します。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
prefix |
String|false |
'Leaflet' |
属性の前に表示されるHTMLテキスト。無効にするには、false を渡します。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
position |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'topright' |
コントロールの位置(マップの角の1つ)。指定可能な値は、'topleft' 、'topright' 、'bottomleft' 、または'bottomright' です。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
setPrefix( |
this |
属性の前に表示されるHTMLテキスト。無効にするには、 |
addAttribution( |
this |
属性テキスト(例: |
removeAttribution( |
this |
属性テキストを削除します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
getPosition() |
string |
コントロールの位置を返します。 |
setPosition( |
this |
コントロールの位置を設定します。 |
getContainer() |
HTMLElement |
コントロールを含むHTMLElementを返します。 |
addTo( |
this |
指定されたマップにコントロールを追加します。 |
remove() |
this |
現在アクティブなマップからコントロールを削除します。 |
Control.Layers
レイヤーコントロールを使用すると、ユーザーは異なるベースレイヤーを切り替えたり、オーバーレイのオン/オフを切り替えたりできます(詳細な例をご覧ください)。Control
を拡張します。
使用例
var baseLayers = {
"Mapbox": mapbox,
"OpenStreetMap": osm
};
var overlays = {
"Marker": marker,
"Roads": roadsLayer
};
L.control.layers(baseLayers, overlays).addTo(map);
baseLayers
パラメーターとoverlays
パラメーターは、レイヤー名をキーとし、Layer
オブジェクトを値とするオブジェクトリテラルです。
{
"<someName1>": layer1,
"<someName2>": layer2
}
レイヤー名にはHTMLを含めることができ、これによりアイテムに追加のスタイルを設定できます。
{"<img src='my-layer-icon' /> <span class='my-layer-item'>My Layer</span>": myLayer}
作成
ファクトリ | 説明 |
---|---|
L.control.layers( |
指定されたレイヤーを使用してレイヤーコントロールを作成します。ベースレイヤーはラジオボタンで切り替えられ、オーバーレイはチェックボックスで切り替えられます。すべてのベースレイヤーはベースレイヤーオブジェクトで渡す必要がありますが、マップのインスタンス化中にマップに追加する必要があるのは1つだけであることに注意してください。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
collapsed |
ブール値 |
true |
true の場合、コントロールはアイコンに折りたたまれ、マウスホバー、タッチ、またはキーボード操作で展開されます。 |
autoZIndex |
ブール値 |
true |
true の場合、コントロールはすべてのレイヤーにz-indexを昇順で割り当てて、オン/オフを切り替えるときに順序が保持されるようにします。 |
hideSingleBase |
ブール値 |
false |
true の場合、ベースレイヤーが1つしかない場合、コントロールのベースレイヤーは非表示になります。 |
sortLayers |
ブール値 |
false |
レイヤーをソートするかどうか。false の場合、レイヤーはコントロールに追加された順序を保持します。 |
sortFunction |
関数 |
* |
sortLayers がtrue の場合に、レイヤーのソートに使用される比較関数。この関数は、sortFunction(layerA, layerB, nameA, nameB) のように、L.Layer インスタンスとその名前の両方を受け取ります。デフォルトでは、レイヤーを名前でアルファベット順にソートします。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
position |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'topright' |
コントロールの位置(マップの角の1つ)。指定可能な値は、'topleft' 、'topright' 、'bottomleft' 、または'bottomright' です。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
addBaseLayer( |
this |
指定された名前のベースレイヤー(ラジオボタンエントリ)をコントロールに追加します。 |
addOverlay( |
this |
指定された名前のオーバーレイ(チェックボックスエントリ)をコントロールに追加します。 |
removeLayer( |
this |
指定されたレイヤーをコントロールから削除します。 |
expand() |
this |
折りたたまれている場合は、コントロールコンテナーを展開します。 |
collapse() |
this |
展開されている場合は、コントロールコンテナーを折りたたみます。 |
メソッド | 戻り値 | 説明 |
---|---|---|
getPosition() |
string |
コントロールの位置を返します。 |
setPosition( |
this |
コントロールの位置を設定します。 |
getContainer() |
HTMLElement |
コントロールを含むHTMLElementを返します。 |
addTo( |
this |
指定されたマップにコントロールを追加します。 |
remove() |
this |
現在アクティブなマップからコントロールを削除します。 |
Control.Scale
画面の中心の現在の縮尺をメートル法(m / km)およびヤードポンド法(mi / ft)で表示するシンプルな縮尺コントロール。Control
を拡張します。
使用例
L.control.scale().addTo(map);
作成
ファクトリ | 説明 |
---|---|
L.control.scale( |
指定されたオプションを使用して縮尺コントロールを作成します。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
maxWidth |
数値 |
100 |
コントロールの最大幅(ピクセル単位)。幅は、丸め値(例:100、200、500)を表示するように動的に設定されます。 |
metric |
ブール値 |
True |
メートル法の縮尺線(m / km)を表示するかどうか。 |
imperial |
ブール値 |
True |
ヤードポンド法の縮尺線(mi / ft)を表示するかどうか。 |
updateWhenIdle |
ブール値 |
false |
true の場合、コントロールはmoveend で更新されます。それ以外の場合は、常に最新の状態(move で更新)です。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
position |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'topright' |
コントロールの位置(マップの角の1つ)。指定可能な値は、'topleft' 、'topright' 、'bottomleft' 、または'bottomright' です。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
getPosition() |
string |
コントロールの位置を返します。 |
setPosition( |
this |
コントロールの位置を設定します。 |
getContainer() |
HTMLElement |
コントロールを含むHTMLElementを返します。 |
addTo( |
this |
指定されたマップにコントロールを追加します。 |
remove() |
this |
現在アクティブなマップからコントロールを削除します。 |
ブラウザ
Leafletが内部で使用する、ブラウザ/機能検出用の静的プロパティを持つ名前空間。
使用例
if (L.Browser.ielt9) {
alert('Upgrade your browser, dude!');
}
プロパティ
Property | 型 | 説明 |
---|---|---|
ie |
ブール値 |
すべてのInternet Explorerバージョン(Edgeではない)の場合true 。 |
ielt9 |
ブール値 |
Internet Explorerバージョン9未満の場合true 。 |
edge |
ブール値 |
Edge Webブラウザの場合true 。 |
webkit |
Boolean; |
ChromeやSafari(モバイル版を含む)のようなwebkitベースのブラウザの場合true 。 |
android |
ブール値 |
非推奨。Androidプラットフォームで実行されているすべてのブラウザの場合true 。 |
android23 |
ブール値 |
非推奨。Android 2またはAndroid 3で実行されているブラウザの場合true 。 |
androidStock |
ブール値 |
非推奨。Androidストックブラウザ(つまり、Chromeではない)の場合true 。 |
opera |
ブール値 |
Operaブラウザの場合true 。 |
chrome |
ブール値 |
Chromeブラウザの場合true 。 |
gecko |
ブール値 |
Firefoxのようなgeckoベースのブラウザの場合true 。 |
safari |
ブール値 |
Safariブラウザの場合true 。 |
opera12 |
ブール値 |
CSS変換をサポートするOperaブラウザ(バージョン12以降)の場合true 。 |
win |
ブール値 |
ブラウザがWindowsプラットフォームで実行されている場合true 。 |
ie3d |
ブール値 |
CSS変換をサポートするすべてのInternet Explorerバージョンでtrue 。 |
webkit3d |
ブール値 |
CSS変換をサポートするwebkitベースのブラウザの場合true 。 |
gecko3d |
ブール値 |
CSS変換をサポートするgeckoベースのブラウザの場合true 。 |
any3d |
ブール値 |
CSS変換をサポートするすべてのブラウザの場合true 。 |
mobile |
ブール値 |
モバイルデバイスで実行されているすべてのブラウザの場合true 。 |
mobileWebkit |
ブール値 |
モバイルデバイスのすべてのwebkitベースのブラウザの場合true 。 |
mobileWebkit3d |
ブール値 |
モバイルデバイスでCSS変換をサポートするすべてのwebkitベースのブラウザの場合true 。 |
msPointer |
ブール値 |
Microsoftタッチイベントモデル(特にIE10)を実装するブラウザの場合true 。 |
pointer |
ブール値 |
ポインターイベントをサポートするすべてのブラウザの場合true 。 |
touchNative |
ブール値 |
タッチイベントをサポートするすべてのブラウザの場合true 。これは必ずしもブラウザがタッチスクリーンを備えたコンピュータで実行されていることを意味するわけではなく、ブラウザがタッチイベントを理解できることを意味するだけです。 |
touch |
ブール値 |
タッチイベントまたはポインターイベントのいずれかをサポートするすべてのブラウザの場合true 。注:ポインターイベントは(利用可能な場合)優先され、すべてのtouch* リスナーに対して処理されます。 |
mobileOpera |
ブール値 |
モバイルデバイスのOperaブラウザの場合true 。 |
mobileGecko |
ブール値 |
モバイルデバイスで実行されているgeckoベースのブラウザの場合true 。 |
retina |
ブール値 |
高解像度の「retina」画面またはブラウザのディスプレイズームが100%を超える画面のブラウザの場合true 。 |
passiveEvents |
ブール値 |
パッシブイベントをサポートするブラウザの場合true 。 |
canvas |
ブール値 |
ブラウザが<canvas> をサポートしている場合true 。 |
svg |
ブール値 |
ブラウザがSVGをサポートしている場合true 。 |
vml |
ブール値 |
ブラウザがVMLをサポートしている場合true 。 |
mac |
ブール値 |
ブラウザがMacプラットフォームで実行されている場合true ブラウザがLinuxプラットフォームで実行されている場合true 。 |
Util
Leafletが内部で使用するさまざまなユーティリティ関数。
関数
関数 | 戻り値 | 説明 |
---|---|---|
extend(拡張)( |
Object |
src オブジェクト(または複数のオブジェクト)のプロパティをdest オブジェクトにマージし、後者を返します。L.extend ショートカットがあります。 |
create( |
Object |
Object.createの互換性ポリフィル |
bind( |
関数 |
Function.prototype.bindのように、渡された引数にバインドされた新しい関数を返します。L.bind() ショートカットがあります。 |
stamp( |
数値 |
オブジェクトの一意のIDを返し、持っていない場合は割り当てます。 |
throttle( |
関数 |
指定されたスコープcontext で関数fn を実行する関数を返します(したがって、this キーワードはfn のコード内のcontext を参照します)。関数fn は、指定されたtime ごとに1回までしか呼び出されません。バインドされた関数が受け取る引数は、関数をバインドするときに渡された引数と、バインドされた関数を呼び出すときに渡された引数が続きます。L.throttle ショートカットがあります。 |
wrapNum( |
数値 |
num の剰余をrange に対して返し、range[0] とrange[1] の範囲内に収まるようにします。includeMax がtrue に設定されていない限り、返される値は常にrange[1] より小さくなります。 |
falseFn() |
関数 |
常にfalse を返す関数を返します。 |
formatNum( |
数値 |
指定されたprecision で丸められた数値num を返します。デフォルトのprecision 値は小数点以下6桁です。処理をスキップするためにfalse を渡すことができます(丸め誤差を回避するのに役立ちます)。 |
trim( |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
String.prototype.trimの互換性ポリフィル |
splitWords( |
String[] |
文字列をトリミングして空白で分割し、部分の配列を返します。 |
setOptions( |
Object |
指定されたプロパティを obj オブジェクトの options にマージし、結果のオプションを返します。 Class options を参照してください。L.setOptions ショートカットがあります。 |
getParamString( |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
オブジェクトをパラメータURL文字列に変換します。例えば、{a: "foo", b: "bar"} は '?a=foo&b=bar' に変換されます。existingUrl が設定されている場合、パラメータは末尾に追加されます。 uppercase が true の場合、パラメータ名はすべて大文字になります (例: '?A=foo&B=bar' ) |
template( |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
簡易テンプレート機能で、'Hello {a}, {b}' の形式のテンプレート文字列と、{a: 'foo', b: 'bar'} のようなデータオブジェクトを受け取り、評価された文字列 ('Hello foo, bar') を返します。データ値として文字列の代わりに関数を指定することもできます。その場合、関数は引数として data を渡されて評価されます。 |
isArray(obj) |
ブール値 |
Array.isArray の互換性ポリフィル |
indexOf( |
数値 |
Array.prototype.indexOf の互換性ポリフィル |
requestAnimFrame( |
数値 |
ブラウザが再描画を行うときに fn が実行されるようにスケジュールします。fn は、指定された場合は context にバインドされます。 immediate が設定されている場合、ブラウザが window.requestAnimationFrame をネイティブにサポートしていない場合は fn が即座に呼び出され、それ以外の場合は遅延されます。リクエストをキャンセルするために使用できるリクエストIDを返します。 |
cancelAnimFrame( |
未定義 |
以前の requestAnimFrame をキャンセルします。window.cancelAnimationFrame も参照してください。 |
プロパティ
Property | 型 | 説明 |
---|---|---|
lastId |
数値 |
stamp() で使用される最後のユニークID |
emptyImageUrl |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
Base64エンコードされた空のGIF画像を含むデータURI文字列。WebKitを搭載したモバイルデバイスで(画像 src をこの文字列に設定することで)未使用の画像からメモリを解放するためのハックとして使用されます。 |
変換
アフィン変換を表します。フォーム (x, y)
の点を (a*x + b, c*y + d)
に変換し、逆変換を行うための係数 a
, b
, c
, d
のセットです。Leafletの投影コードで使用されます。
使用例
var transformation = L.transformation(2, 5, -1, 10),
p = L.point(1, 2),
p2 = transformation.transform(p), // L.point(7, 8)
p3 = transformation.untransform(p2); // L.point(1, 2)
作成
ファクトリ | 説明 |
---|---|
L.transformation( |
指定された係数で Transformation オブジェクトをインスタンス化します。 |
L.transformation( |
[a: Number, b: Number, c: Number, d: Number] の形式の係数配列を予期します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
transform( |
ポイント |
変換された点を返します。オプションで、指定されたスケールを乗算します。実際の |
untransform( |
ポイント |
指定された点の逆変換を返します。オプションで、指定されたスケールで除算します。実際の |
LineUtil
ポリラインのポイント処理のための様々なユーティリティ関数。Leaflet内部で、ポリラインを高速化するために使用されます。
関数
関数 | 戻り値 | 説明 |
---|---|---|
simplify( |
Point[] |
ポリラインの形状を保持しながら、その点の数を大幅に減らし、ラマー・ダグラス・ポイカーアルゴリズムを使用して、簡略化された点の新しい配列を返します。各ズームレベルでLeafletポリラインを処理/表示する際のパフォーマンスを大幅に向上させ、視覚的なノイズを低減するために使用されます。tolerance は簡略化の量に影響します(値が小さいほど品質は高くなりますが、処理速度は遅くなり、点が多くなります)。独立したマイクロライブラリ Simplify.js としてもリリースされています。 |
pointToSegmentDistance( |
数値 |
点 p と線分 p1 から p2 までの間の距離を返します。 |
closestPointOnSegment( |
数値 |
点 p から線分 p1 から p2 上の最も近い点を返します。 |
clipSegment( |
Point[]|Boolean |
コーエン・サザーランドアルゴリズムを使って、矩形の境界で線分 a から b をクリップします(線分の点を直接変更します!)。Leafletでは、画面上または近くにあるポリラインポイントのみを表示し、パフォーマンスを向上させるために使用されます。 |
isFlat( |
ブール値 |
latlngs がフラット配列の場合は true を、ネストされている場合は false を返します。 |
polylineCenter( |
LatLng |
ポリラインの渡されたLatLngs(最初のリング)の中心(重心)を返します。 |
PolyUtil
ポリゴンジオメトリのための様々なユーティリティ関数。
関数
関数 | 戻り値 | 説明 |
---|---|---|
clipPolygon( |
Point[] |
与えられた points で定義されたポリゴンジオメトリを、与えられた境界でクリップします(サザーランド・ホッジマンアルゴリズムを使用します)。Leafletでは、画面上または近くにあるポリゴンポイントのみを表示し、パフォーマンスを向上させるために使用されます。ポリゴンのポイントはポリラインとは異なるクリッピングアルゴリズムが必要なため、別のメソッドが存在します。 |
polygonCenter( |
LatLng |
ポリゴンの渡されたLatLngs(最初のリング)の中心(重心)を返します。 |
centroid( |
LatLng |
渡されたLatLngsの「質量中心」を返します。 |
DomEvent
DOMイベントを処理するためのユーティリティ関数。Leaflet内部で使用されます。
関数
関数 | 戻り値 | 説明 |
---|---|---|
on( |
this |
リスナー関数 (fn ) を要素 el の特定のDOMイベントタイプに追加します。リスナーのコンテキスト(this キーワードが指すオブジェクト)をオプションで指定できます。複数のスペース区切りのタイプ(例:'click dblclick' )を渡すこともできます。 |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例:{click: onClick, mousemove: onMouseMove} |
off( |
this |
以前に追加したリスナー関数を削除します。on にカスタムコンテキストを渡した場合は、リスナーを削除するために、off に同じコンテキストを渡す必要があることに注意してください。 |
off( |
this |
type/リスナーペアのセットを削除します。例: {click: onClick, mousemove: onMouseMove} |
off( |
this |
以前に追加した、指定されたタイプのリスナーをすべて削除します。 |
off( |
this |
以前に追加した、指定されたHTMLElementからのリスナーをすべて削除します。 |
stopPropagation( |
this |
指定されたイベントが親要素に伝播するのを停止します。リスナー関数内で使用されます。
|
disableScrollPropagation( |
this |
要素の 'wheel' イベント(およびブラウザのバリアント)に stopPropagation を追加します。 |
disableClickPropagation( |
this |
要素の 'click' , 'dblclick' , 'contextmenu' , 'mousedown' および 'touchstart' イベント(およびブラウザのバリアント)に stopPropagation を追加します。 |
preventDefault( |
this |
DOMイベント ev のデフォルトのアクション(a要素のhrefのリンクをたどる、または <form> が送信されたときにページリロードでPOSTリクエストを実行するなど)が発生するのを防ぎます。リスナー関数内で使用します。 |
stop( |
this |
stopPropagation と preventDefault を同時に実行します。 |
getPropagationPath( |
Array |
Event.composedPath() の互換性ポリフィル。指定されたDOMイベントが伝播するはずの(停止していない場合)HTMLElement を含む配列を返します。 |
getMousePosition( |
ポイント |
container (ボーダーを除く)または指定されていない場合はページ全体を基準とした、DOMイベントからの正規化されたマウス位置を取得します。 |
getWheelDelta( |
数値 |
ホイールDOMイベントからの正規化されたホイールデルタを、スクロールされた垂直ピクセル数(下にスクロールする場合は負)で取得します。正確なスクロールがないポインティングデバイスからのイベントは、60ピクセルと推測される値にマッピングされます。 |
addListener(…) |
this |
L.DomEvent.on のエイリアス |
removeListener(…) |
this |
L.DomEvent.off のエイリアス |
DomUtil
DOMツリーを処理するためのユーティリティ関数。Leaflet内部で使用されます。
HTMLElement
を予期または返すほとんどの関数は、SVG要素でも動作します。唯一の違いは、クラスがHTMLではCSSクラスを、SVGではSVGクラスを参照することです。
関数
関数 | 戻り値 | 説明 |
---|---|---|
get( |
HTMLElement |
DOM IDで指定された要素を返すか、直接渡された場合は要素自体を返します。 |
getStyle( |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
要素の特定のスタイル属性の値(CSSを介して設定された計算値や値を含む)を返します。 |
create( |
HTMLElement |
tagName を持つHTML要素を作成し、そのクラスを className に設定し、オプションで container 要素に追加します。 |
remove( |
|
親要素から el を削除します。 |
empty( |
|
el の子要素をすべて el から削除します。 |
toFront( |
|
el を親の最後の子にし、他の子の前にレンダリングするようにします。 |
toBack( |
|
el を親の最初の子にし、他の子の後ろにレンダリングするようにします。 |
hasClass( |
ブール値 |
要素のクラス属性に name が含まれている場合は true を返します。 |
addClass( |
|
要素のクラス属性に name を追加します。 |
removeClass( |
|
要素のクラス属性から name を削除します。 |
setClass( |
|
要素のクラスを設定します。 |
getClass( |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
要素のクラスを返します。 |
setOpacity( |
|
要素の不透明度を設定します(古いIEのサポートを含む)。 opacity は 0 から 1 までの数値である必要があります。 |
testProp( |
String|false |
スタイル名の配列を調べて、要素の有効なスタイル名である最初の名前を返します。そのような名前が見つからない場合は、falseを返します。transform のようなベンダープレフィックス付きスタイルに役立ちます。 |
setTransform( |
|
el の3D CSS変換をリセットし、offset ピクセルで翻訳し、オプションで scale でスケールするようにします。ブラウザが3D CSS変換をサポートしていない場合は、効果がありません。 |
setPosition( |
|
el の位置を、CSS変換またはブラウザに応じた上/左の位置を使用して、position で指定された座標に設定します(Leafletが内部でレイヤーの位置を決めるために使用します)。 |
getPosition( |
ポイント |
setPosition で以前に配置された要素の座標を返します。 |
disableTextSelection() |
|
ユーザーが selectstart DOMイベントを生成するのを防ぎます。通常、ユーザーがテキストを含むページでマウスをドラッグしたときに生成されます。Leafletでは、マップ上のクリックアンドドラッグ操作の動作を上書きするために内部的に使用されます。ドキュメント全体のドラッグ操作に影響します。 |
enableTextSelection() |
|
以前の L.DomUtil.disableTextSelection の効果をキャンセルします。 |
disableImageDrag() |
|
L.DomUtil.disableTextSelection と同様ですが、dragstart DOMイベントの場合です。通常、ユーザーが画像をドラッグしたときに生成されます。 |
enableImageDrag() |
|
以前の L.DomUtil.disableImageDrag の効果をキャンセルします。 |
preventOutline( |
|
要素el のアウトラインを非表示にします。Leaflet内部で、ユーザーが要素をドラッグ操作した際に、フォーカス可能な要素のアウトラインが表示されるのを防ぐために使用されます。 |
restoreOutline() |
|
以前のL.DomUtil.preventOutline の効果を打ち消します。 |
getSizedParentNode( |
HTMLElement |
サイズ(幅と高さ)が null でない最も近い親ノードを検索します。 |
getScale( |
Object |
要素に現在適用されている CSS スケールを計算します。水平スケールと垂直スケールをそれぞれx とy メンバとして持ち、getBoundingClientRect() の結果をboundingClientRect として持つオブジェクトを返します。 |
プロパティ
Property | 型 | 説明 |
---|---|---|
TRANSFORM |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
ベンダープレフィックス付きの transform スタイル名(例:WebKit の場合は 'webkitTransform' )。 |
TRANSITION |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
ベンダープレフィックス付きの transition スタイル名。 |
TRANSITION_END |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
ベンダープレフィックス付きの transitionend イベント名。 |
PosAnimation
モダンブラウザでは CSS3 Transitions を利用し、IE6-9 ではタイマーによるフォールバックを使用して、パンアニメーションを内部的に実行します。
使用例
var myPositionMarker = L.marker([48.864716, 2.294694]).addTo(map);
myPositionMarker.on("click", function() {
var pos = map.latLngToLayerPoint(myPositionMarker.getLatLng());
pos.y -= 25;
var fx = new L.PosAnimation();
fx.once('end',function() {
pos.y += 25;
fx.run(myPositionMarker._icon, pos, 0.8);
});
fx.run(myPositionMarker._icon, pos, 0.3);
});
コンストラクタ
コンストラクタ | 説明 |
---|---|
L.PosAnimation() |
PosAnimation オブジェクトを作成します。 |
イベント
イベント | データ | 説明 |
---|---|---|
start |
イベント |
アニメーションが開始されたときに発生します |
step |
イベント |
アニメーション中に継続的に発生します。 |
end |
イベント |
アニメーションが終了したときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
run( |
|
指定された要素のアニメーションを指定された新しい位置まで実行します。オプションで、秒単位の継続時間 (デフォルトは |
stop() |
|
アニメーションを停止します(現在実行中の場合)。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
ドラッグ可能
DOM 要素をドラッグ可能にするためのクラスです(タッチサポートを含む)。マップとマーカーのドラッグに内部的に使用されます。L.DomUtil.setPosition
で位置が設定された要素に対してのみ機能します。
使用例
var draggable = new L.Draggable(elementToDrag);
draggable.enable();
コンストラクタ
コンストラクタ | 説明 |
---|---|
L.Draggable( |
dragHandle 要素(デフォルトではel 自体)のドラッグを開始したときにel を移動させるためのDraggable オブジェクトを作成します。 |
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
clickTolerance |
数値 |
3 |
クリックとみなされるための、クリック中のマウスポインタの最大ピクセルシフト数です(マウスクリックのドラッグとは対照的)。 |
イベント
イベント | データ | 説明 |
---|---|---|
down |
イベント |
ドラッグが開始されようとするときに発生します。 |
dragstart |
イベント |
ドラッグが開始されたときに発生します |
predrag |
イベント |
要素の位置が更新される前のドラッグ中に継続的に発生します。 |
drag |
イベント |
ドラッグ中に継続的に発生します。 |
dragend |
DragEndEvent |
ドラッグが終了したときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
enable() |
|
ドラッグ機能を有効にします |
disable() |
|
ドラッグ機能を無効にします |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
クラス
L.Class は Leaflet の OOP 機能を強化し、ここに記載されているほとんどすべての Leaflet クラスを作成するために使用されます。
単純な古典的継承モデルを実装することに加えて、便利なコード構成のためのいくつかの特別なプロパティ (options、includes、statics) を導入します。
使用例
var MyClass = L.Class.extend({
initialize: function (greeter) {
this.greeter = greeter;
// class constructor
},
greet: function (name) {
alert(this.greeter + ', ' + name)
}
});
// create instance of MyClass, passing "Hello" to the constructor
var a = new MyClass("Hello");
// call greet method, alerting "Hello, World"
a.greet("World");
クラスファクトリー
Leafletオブジェクトがnew
キーワードを使用せずに作成されていることに気づいたかもしれません。これは、各クラスに小文字のファクトリーメソッドを補完することによって実現されます
new L.Map('map'); // becomes:
L.map('map');
ファクトリーは非常に簡単に実装されており、独自のクラスでもこれを行うことができます。
L.map = function (id, options) {
return new L.Map(id, options);
};
継承
新しいクラスを定義するには L.Class.extend を使用しますが、任意のクラスで同じメソッドを使用して継承できます
var MyChildClass = MyClass.extend({
// ... new properties and methods
});
これにより、親クラスのすべてのメソッドとプロパティを継承する(適切なプロトタイプチェーンを通じて)クラスが作成され、extend に渡すクラスが追加またはオーバーライドされます。また、instanceof にも適切に反応します。
var a = new MyChildClass();
a instanceof MyChildClass; // true
a instanceof MyClass; // true
親クラスのプロトタイプにアクセスし、JavaScript の call または apply を使用することで、対応する子クラスから親メソッド(コンストラクタを含む)を呼び出すことができます(他の言語のスーパー呼び出しと同様)。
var MyChildClass = MyClass.extend({
initialize: function () {
MyClass.prototype.initialize.call(this, "Yo");
},
greet: function (name) {
MyClass.prototype.greet.call(this, 'bro ' + name + '!');
}
});
var a = new MyChildClass();
a.greet('Jason'); // alerts "Yo, bro Jason!"
オプション
options
は、extend
に渡す他のオブジェクトとは異なり、親のオブジェクトと完全にオーバーライドするのではなくマージされる特別なプロパティです。これにより、オブジェクトの構成とデフォルト値を管理するのに便利になります。
var MyClass = L.Class.extend({
options: {
myOption1: 'foo',
myOption2: 'bar'
}
});
var MyChildClass = MyClass.extend({
options: {
myOption1: 'baz',
myOption3: 5
}
});
var a = new MyChildClass();
a.options.myOption1; // 'baz'
a.options.myOption2; // 'bar'
a.options.myOption3; // 5
コンストラクターに渡されたオプションをクラスで定義されたデフォルト値と便利にマージするためのメソッドであるL.Util.setOptions
もあります。
var MyClass = L.Class.extend({
options: {
foo: 'bar',
bla: 5
},
initialize: function (options) {
L.Util.setOptions(this, options);
...
}
});
var a = new MyClass({bla: 10});
a.options; // {foo: 'bar', bla: 10}
optionsオブジェクトは、クラスとその基底クラスで定義されたオプションだけでなく、任意のキーを許可することに注意してください。つまり、問題のクラスですでに使用されているキーを避ける限り、アプリケーション固有の情報を格納するために options オブジェクトを使用できます。
インクルード
includes
は、指定されたすべてのオブジェクトをクラスにマージする特別なクラスプロパティです(このようなオブジェクトはミックスインと呼ばれます)。
var MyMixin = {
foo: function () { ... },
bar: 5
};
var MyClass = L.Class.extend({
includes: MyMixin
});
var a = new MyClass();
a.foo();
include
メソッドを使用すると、ランタイムでこのようなインクルードを実行することもできます。
MyClass.include(MyMixin);
statics
は、指定されたオブジェクトプロパティをクラスの静的プロパティとして注入するだけの便利なプロパティであり、定数を定義するのに役立ちます。
var MyClass = L.Class.extend({
statics: {
FOO: 'bar',
BLA: 5
}
});
MyClass.FOO; // 'bar'
コンストラクタフック
プラグイン開発者の場合、既存のクラスに初期化コードを追加する必要がある場合がよくあります(例:L.Polyline
の編集フック)。Leaflet には、addInitHook
メソッドを使用して簡単に実行する方法があります。
MyClass.addInitHook(function () {
// ... do something in constructor additionally
// e.g. add event listeners, set custom properties etc.
});
1つの追加のメソッド呼び出しのみが必要な場合は、次のショートカットを使用することもできます
MyClass.addInitHook('methodName', arg1, arg2, …);
関数
関数 | 戻り値 | 説明 |
---|---|---|
extend(拡張)( |
関数 |
含めるプロパティを指定して現在のクラスを拡張します。クラスコンストラクタである Javascript 関数を返します(new で呼び出される)。 |
include( |
this |
ミックスインを現在のクラスにインクルードします。 |
mergeOptions( |
this |
options をクラスのデフォルトにマージします。 |
addInitHook( |
this |
コンストラクタフックをクラスに追加します。 |
Evented
Map
やMarker
など、イベント駆動クラス間で共有される一連のメソッドです。一般に、イベントを使用すると、オブジェクトで何かが発生したときに(例:ユーザーがマップをクリックすると、マップが'click'
イベントを発生させる)、何らかの関数を実行できます。
使用例
map.on('click', function(e) {
alert(e.latlng);
} );
Leafletはイベントリスナーを参照で処理するため、リスナーを追加してから削除する場合は、関数として定義します
function onClick(e) { ... }
map.on('click', onClick);
map.off('click', onClick);
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
レイヤー
すべてのLeafletレイヤーが使用するLayer基底クラスからの一連のメソッドです。L.Evented
からすべてのメソッド、オプション、およびイベントを継承します。
使用例
var layer = L.marker(latlng).addTo(map);
layer.addTo(map);
layer.remove();
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'overlayPane' |
デフォルトでは、レイヤーはマップのオーバーレイペインに追加されます。このオプションをオーバーライドすると、デフォルトでレイヤーは別のペインに配置されます。 |
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
イベント | データ | 説明 |
---|---|---|
add |
イベント |
レイヤーがマップに追加された後に発生します |
remove |
イベント |
レイヤーがマップから削除された後に発生します |
ポップアップイベント
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
ツールチップイベント
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
L.Layer
を拡張するクラスは、次のメソッドを継承しますメソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
拡張メソッド
L.Layer
から拡張し、次のメソッドを(再)実装する必要があります。メソッド | 戻り値 | 説明 |
---|---|---|
onAdd( |
this |
レイヤーの DOM 要素を作成し、それらを所属すべき |
onRemove( |
this |
レイヤーの要素を DOM から削除し、 |
getEvents() |
Object |
このオプションのメソッドは、 |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
このオプションのメソッドは、レイヤーが表示されるたびに |
beforeAdd( |
this |
オプションのメソッド。 |
ポップアップメソッド
var layer = L.Polygon(latlngs).bindPopup('Hi There!').addTo(map);
layer.openPopup();
layer.closePopup();
ポップアップは、レイヤーがクリックされたときにも自動的に開き、レイヤーがマップから削除されるか、別のポップアップが開かれたときに閉じられます。
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
ツールチップメソッド
var layer = L.Polygon(latlngs).bindTooltip('Hi There!').addTo(map);
layer.openTooltip();
layer.closeTooltip();
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
インタラクティブレイヤー
一部のLayer
はインタラクティブにすることができます。ユーザーがそのようなレイヤーを操作すると、click
やmouseover
などのマウスイベントを処理できます。イベント処理メソッドを使用して、これらのイベントを処理します。
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
interactive |
ブール値 |
true |
false の場合、レイヤーはマウスイベントを発行せず、下にあるマップの一部として機能します。 |
bubblingMouseEvents |
ブール値 |
true |
true の場合、このレイヤー上のマウスイベントは、L.DomEvent.stopPropagation が使用されない限り、マップ上で同じイベントをトリガーします。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'overlayPane' |
デフォルトでは、レイヤーはマップのオーバーレイペインに追加されます。このオプションをオーバーライドすると、デフォルトでレイヤーは別のペインに配置されます。 |
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
マウスイベント
イベント | データ | 説明 |
---|---|---|
click |
MouseEvent |
ユーザーがレイヤーをクリック(またはタップ)したときに発生します。 |
dblclick |
MouseEvent |
ユーザーがレイヤーをダブルクリック(またはダブルタップ)したときに発生します。 |
mousedown |
MouseEvent |
ユーザーがレイヤー上でマウスボタンを押したときに発生します。 |
mouseup |
MouseEvent |
ユーザーがレイヤー上で押されたマウスボタンを離したときに発生します。 |
mouseover |
MouseEvent |
マウスがレイヤーに入ったときに発生します。 |
mouseout |
MouseEvent |
マウスがレイヤーから離れたときに発生します。 |
contextmenu |
MouseEvent |
ユーザーがレイヤーを右クリックしたときに発生し、このイベントにリスナーがある場合は、デフォルトのブラウザのコンテキストメニューが表示されないようにします。モバイルでユーザーがシングルタッチを1秒間保持した場合(長押しとも呼ばれる)にも発生します。 |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
コントロール
L.Control は、マップコントロールを実装するための基底クラスです。ポジショニングを処理します。他のすべてのコントロールはこのクラスから拡張されます。
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
position |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'topright' |
コントロールの位置(マップの角の1つ)。指定可能な値は、'topleft' 、'topright' 、'bottomleft' 、または'bottomright' です。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
getPosition() |
string |
コントロールの位置を返します。 |
setPosition( |
this |
コントロールの位置を設定します。 |
getContainer() |
HTMLElement |
コントロールを含むHTMLElementを返します。 |
addTo( |
this |
指定されたマップにコントロールを追加します。 |
remove() |
this |
現在アクティブなマップからコントロールを削除します。 |
拡張メソッド
L.Control
から拡張し、次のメソッドを(再)実装する必要があります。メソッド | 戻り値 | 説明 |
---|---|---|
onAdd( |
HTMLElement |
コントロールのコンテナ DOM 要素を返し、関連するマップイベントにリスナーを追加する必要があります。 |
onRemove( |
|
オプションのメソッド。 |
ハンドラー
マップインタラクションハンドラーの抽象クラス
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
enable() |
this |
ハンドラーを有効にします |
disable() |
this |
ハンドラーを無効にします |
enabled() |
ブール値 |
ハンドラーが有効な場合は |
拡張メソッド
Handler
から継承するクラスは、次の2つのメソッドを実装する必要がありますメソッド | 戻り値 | 説明 |
---|---|---|
addHooks() |
|
ハンドラーが有効になったときに呼び出され、イベントフックを追加する必要があります。 |
removeHooks() |
|
ハンドラーが無効になったときに呼び出され、以前に追加されたイベントフックを削除する必要があります。 |
関数
L.Handler をインスタンス化せずに呼び出すことができる静的関数があります
関数 | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
指定された名前で、指定されたマップに新しい Handler を追加します。 |
投影
世界中の地理座標を平面(およびその逆)に投影するためのメソッドを持つオブジェクト。地図投影を参照してください。
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
project( |
ポイント |
地理座標を 2D ポイントに投影します。配列ではなく、実際の |
unproject( |
LatLng |
投影インスタンスは Leaflet の |
プロパティ
Property | 型 | 説明 |
---|---|---|
bounds |
バウンズ |
投影が有効な範囲(CRS 単位で指定) |
定義済み投影
投影 | 説明 |
---|---|
L.Projection.LonLat |
正距円筒図法またはPlate Carree投影 — 最も単純な投影であり、主にGIS愛好家によって使用されます。x を経度、y を緯度として直接マッピングします。ゲームマップなどのフラットな世界にも適しています。EPSG:4326 およびSimple CRSで使用されます。 |
L.Projection.Mercator |
楕円メルカトル図法 — 球面メルカトル図法よりも複雑です。地球が楕円体であると想定します。EPSG:3395 CRSで使用されます。 |
L.Projection.SphericalMercator |
球面メルカトル図法 — ほとんどすべての無料および商用タイルプロバイダーで使用される、オンラインマップで最も一般的な投影法です。地球が球であると想定します。EPSG:3857 CRSで使用されます。 |
CRS
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
latLngToPoint( |
ポイント |
指定されたズームの地理座標をピクセル座標に投影します。 |
pointToLatLng( |
LatLng |
|
project( |
ポイント |
地理座標を、このCRSで受け入れられる単位の座標に投影します(例:WMSサービスに渡すためのEPSG:3857の場合はメートル)。 |
unproject( |
LatLng |
投影された座標から対応するLatLngを返します。 |
scale( |
数値 |
特定のズームレベルで、投影された座標をピクセル座標に変換する際に使用されるスケールを返します。例えば、メルカトル図法のCRSの場合、 |
zoom( |
数値 |
|
getProjectedBounds( |
バウンズ |
指定された |
distance( |
数値 |
2つの地理座標間の距離を返します。 |
wrapLatLng( |
LatLng |
CRSの |
wrapLatLngBounds( |
LatLngBounds |
指定されたものと同じサイズの |
プロパティ
Property | 型 | 説明 |
---|---|---|
コード |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
WMSサービスに渡されるCRSの標準コード名(例:'EPSG:3857' ) |
wrapLng |
数値[] |
経度(水平)座標軸が特定の範囲で折り返すかどうか、およびその方法を定義する2つの数値の配列。ほとんどの地理的なCRSでは、デフォルトで[-180, 180] です。undefined の場合、経度軸は折り返しをしません。 |
wrapLat |
数値[] |
wrapLng と同様ですが、緯度(垂直)軸に対してです。 |
無限 |
ブール値 |
trueの場合、座標空間は境界なし(両軸で無限)になります。 |
定義済みのCRS
CRS | 説明 |
---|---|
L.CRS.Earth |
地球全体をカバーするようなグローバルなCRSのベースとして機能します。code 、projection 、またはtransformation を持っていないため、他のCRSのベースとしてのみ使用でき、直接使用することはできません。distance() はメートルを返します。 |
L.CRS.EPSG3395 |
一部の商用タイルプロバイダーによってまれに使用されます。楕円メルカトル図法を使用します。 |
L.CRS.EPSG3857 |
オンラインマップで最も一般的なCRSで、ほとんどすべての無料および商用タイルプロバイダーで使用されています。球体メルカトル図法を使用します。Mapのcrs オプションでデフォルトで設定されます。 |
L.CRS.EPSG4326 |
GIS愛好家の間で一般的なCRSです。単純な正距円筒図法を使用します。 Leaflet 1.0.xは、EPSG:4326のTMS座標スキームに準拠しており、0.7.xの動作からの破壊的な変更です。 |
L.CRS.Base |
地理的な点をピクセル(画面)座標に投影し、その逆(およびWMSサービスのための他の単位の座標)に投影するための座標参照系を定義するオブジェクトです。空間参照系を参照してください。 Leafletは、最も一般的なCRSをデフォルトで定義しています。デフォルトで定義されていないCRSを使用したい場合は、Proj4Leafletプラグインを参照してください。 CRSインスタンスはLeafletの |
L.CRS.Simple |
経度と緯度をx とy に直接マッピングする単純なCRSです。平らな表面の地図(例:ゲームマップ)に使用できます。y 軸はまだ反転している必要があることに注意してください(下から上に移動)。distance() は単純なユークリッド距離を返します。 |
レンダラー
ベクターレンダラー実装(SVG
、Canvas
)の基本クラスです。レンダラーのDOMコンテナ、その境界、およびズームアニメーションを処理します。
Renderer
は、すべてのPath
の暗黙的なレイヤーグループとして機能します。レンダラー自体をマップに追加または削除できます。すべてのパスはレンダラーを使用します。レンダラーは、暗黙的(マップがレンダラーの種類を決定し、自動的に使用します)または明示的(パスのrenderer
オプションを使用)にできます。
このクラスを直接使用しないでください。代わりにSVG
およびCanvas
を使用してください。
オプション
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
paddingTopLeft |
数値 |
0.1 |
マップビューの周りのクリップ領域を拡張する量(サイズに対する相対的な割合)。例えば、0.1は各方向のマップビューの10%になります。 |
オプション | 型 | デフォルト | 説明 |
---|---|---|---|
pane |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
'overlayPane' |
デフォルトでは、レイヤーはマップのオーバーレイペインに追加されます。このオプションをオーバーライドすると、デフォルトでレイヤーは別のペインに配置されます。 |
attribution |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
null |
帰属コントロールに表示される文字列(例:「© OpenStreetMap contributors」)。レイヤーデータを記述し、著作権者およびタイルプロバイダーに対する法的義務となることが多い。 |
イベント
イベント | データ | 説明 |
---|---|---|
update |
イベント |
レンダラーがその境界、中心、およびズームを更新したとき、たとえばマップが移動したときに発生します |
イベント | データ | 説明 |
---|---|---|
popupopen |
PopupEvent |
このレイヤーにバインドされたポップアップが開かれたときに発生します |
popupclose |
PopupEvent |
このレイヤーにバインドされたポップアップが閉じられたときに発生します |
イベント | データ | 説明 |
---|---|---|
tooltipopen |
TooltipEvent |
このレイヤーにバインドされたツールチップが開かれたときに発生します。 |
tooltipclose |
TooltipEvent |
このレイヤーにバインドされたツールチップが閉じられたときに発生します。 |
メソッド
メソッド | 戻り値 | 説明 |
---|---|---|
addTo( |
this |
レイヤーを指定されたマップまたはレイヤーグループに追加します。 |
remove() |
this |
現在アクティブになっているマップからレイヤーを削除します。 |
removeFrom( |
this |
指定されたマップからレイヤーを削除します |
removeFrom( |
this |
指定された |
getPane( |
HTMLElement |
マップ上の名前付きペインを表す |
getAttribution() |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
|
メソッド | 戻り値 | 説明 |
---|---|---|
bindPopup( |
this |
渡された |
unbindPopup() |
this |
|
openPopup( |
this |
指定された |
closePopup() |
this |
開いている場合は、このレイヤーにバインドされたポップアップを閉じます。 |
togglePopup() |
this |
このレイヤーにバインドされたポップアップを、現在の状態に応じて開閉します。 |
isPopupOpen() |
boolean |
このレイヤーにバインドされたポップアップが現在開いている場合は |
setPopupContent( |
this |
このレイヤーにバインドされたポップアップのコンテンツを設定します。 |
getPopup() |
ポップアップ |
このレイヤーにバインドされたポップアップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
bindTooltip( |
this |
渡された |
unbindTooltip() |
this |
|
openTooltip( |
this |
指定された |
closeTooltip() |
this |
開いている場合は、このレイヤーにバインドされたツールチップを閉じます。 |
toggleTooltip() |
this |
このレイヤーにバインドされたツールチップを、現在の状態に応じて開閉します。 |
isTooltipOpen() |
boolean |
このレイヤーにバインドされたツールチップが現在開いている場合は |
setTooltipContent( |
this |
このレイヤーにバインドされたツールチップのコンテンツを設定します。 |
getTooltip() |
ツールチップ |
このレイヤーにバインドされたツールチップを返します。 |
メソッド | 戻り値 | 説明 |
---|---|---|
on( |
this |
オブジェクトの特定のイベントタイプにリスナー関数( |
on( |
this |
タイプ/リスナーのペアのセットを追加します。例: |
off( |
this |
以前に追加されたリスナー関数を削除します。関数が指定されていない場合は、その特定のイベントのすべてのリスナーがオブジェクトから削除されます。 |
off( |
this |
タイプ/リスナーのペアのセットを削除します。 |
off() |
this |
オブジェクトのすべてのイベントに対するすべてのリスナーを削除します。これには、暗黙的にアタッチされたイベントが含まれます。 |
fire( |
this |
指定されたタイプのイベントを発生させます。データオブジェクトをオプションで提供できます。リスナー関数の最初の引数には、そのプロパティが含まれます。イベントはオプションでイベントの親に伝播できます。 |
listens( |
ブール値 |
特定のイベントタイプにリスナーがアタッチされている場合は |
once(…) |
this |
|
addEventParent( |
this |
イベントの親を追加します。これは、伝播されたイベントを受信する |
removeEventParent( |
this |
イベントの親を削除すると、伝播されたイベントの受信が停止します |
addEventListener(…) |
this |
|
removeEventListener(…) |
this |
|
clearAllEventListeners(…) |
this |
|
addOneTimeEventListener(…) |
this |
|
fireEvent(…) |
this |
|
hasEventListeners(…) |
ブール値 |
|
イベントオブジェクト
Evented
から継承するクラスがイベントを発生させると、イベントに関する情報を含むプレーンオブジェクトであるイベント引数とともにリスナー関数が呼び出されます。例えば
map.on('click', function(ev) {
alert(ev.latlng); // ev is an event object (MouseEvent in this case)
});
利用可能な情報はイベントタイプによって異なります
イベント
Property | 型 | 説明 |
---|---|---|
type |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
イベントタイプ(例:'click' )。 |
target |
Object |
イベントを発生させたオブジェクト。伝播されたイベントの場合、イベントを発生させた伝播チェーンの最後のオブジェクト。 |
sourceTarget |
Object |
最初にイベントを発生させたオブジェクト。伝播されていないイベントの場合、これはtarget と同じになります。 |
propagatedFrom |
Object |
伝播されたイベントの場合、イベントをイベントの親に伝播した最後のオブジェクト。 |
layer |
Object |
非推奨。propagatedFrom と同じ。 |
KeyboardEvent
Property | 型 | 説明 |
---|---|---|
originalEvent |
DOMEvent |
このLeafletイベントをトリガーした元のDOM KeyboardEvent 。 |
Property | 型 | 説明 |
---|---|---|
type |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
イベントタイプ(例:'click' )。 |
target |
Object |
イベントを発生させたオブジェクト。伝播されたイベントの場合、イベントを発生させた伝播チェーンの最後のオブジェクト。 |
sourceTarget |
Object |
最初にイベントを発生させたオブジェクト。伝播されていないイベントの場合、これはtarget と同じになります。 |
propagatedFrom |
Object |
伝播されたイベントの場合、イベントをイベントの親に伝播した最後のオブジェクト。 |
layer |
Object |
非推奨。propagatedFrom と同じ。 |
MouseEvent
Property | 型 | 説明 |
---|---|---|
latlng |
LatLng |
マウスイベントが発生した地理的な点。 |
layerPoint |
ポイント |
マウスイベントが発生した点のマップレイヤーに対するピクセル座標。 |
containerPoint |
ポイント |
マウスイベントが発生した点のマップコンテナに対するピクセル座標。 |
originalEvent |
DOMEvent |
このLeafletイベントをトリガーした元のDOM MouseEvent またはDOM TouchEvent 。 |
Property | 型 | 説明 |
---|---|---|
type |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
イベントタイプ(例:'click' )。 |
target |
Object |
イベントを発生させたオブジェクト。伝播されたイベントの場合、イベントを発生させた伝播チェーンの最後のオブジェクト。 |
sourceTarget |
Object |
最初にイベントを発生させたオブジェクト。伝播されていないイベントの場合、これはtarget と同じになります。 |
propagatedFrom |
Object |
伝播されたイベントの場合、イベントをイベントの親に伝播した最後のオブジェクト。 |
layer |
Object |
非推奨。propagatedFrom と同じ。 |
LocationEvent
Property | 型 | 説明 |
---|---|---|
latlng |
LatLng |
ユーザーの検出された地理的な場所。 |
bounds |
LatLngBounds |
ユーザーが位置している領域の地理的な境界(位置の精度に関して)。 |
accuracy |
数値 |
メートル単位の位置の精度。 |
altitude |
数値 |
WGS84楕円体からの位置の高さ(メートル単位)。 |
altitudeAccuracy |
数値 |
メートル単位の高度の精度。 |
heading |
数値 |
真北から時計回りに数えた度単位での移動方向。 |
speed |
数値 |
メートル毎秒単位の現在の速度。 |
timestamp |
数値 |
位置が取得された時間。 |
Property | 型 | 説明 |
---|---|---|
type |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
イベントタイプ(例:'click' )。 |
target |
Object |
イベントを発生させたオブジェクト。伝播されたイベントの場合、イベントを発生させた伝播チェーンの最後のオブジェクト。 |
sourceTarget |
Object |
最初にイベントを発生させたオブジェクト。伝播されていないイベントの場合、これはtarget と同じになります。 |
propagatedFrom |
Object |
伝播されたイベントの場合、イベントをイベントの親に伝播した最後のオブジェクト。 |
layer |
Object |
非推奨。propagatedFrom と同じ。 |
ErrorEvent
Property | 型 | 説明 |
---|---|---|
message |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
エラーメッセージ。 |
コード |
数値 |
エラーコード(該当する場合)。 |
Property | 型 | 説明 |
---|---|---|
type |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
イベントタイプ(例:'click' )。 |
target |
Object |
イベントを発生させたオブジェクト。伝播されたイベントの場合、イベントを発生させた伝播チェーンの最後のオブジェクト。 |
sourceTarget |
Object |
最初にイベントを発生させたオブジェクト。伝播されていないイベントの場合、これはtarget と同じになります。 |
propagatedFrom |
Object |
伝播されたイベントの場合、イベントをイベントの親に伝播した最後のオブジェクト。 |
layer |
Object |
非推奨。propagatedFrom と同じ。 |
LayerEvent
Property | 型 | 説明 |
---|---|---|
layer |
レイヤー |
追加または削除されたレイヤー。 |
Property | 型 | 説明 |
---|---|---|
type |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
イベントタイプ(例:'click' )。 |
target |
Object |
イベントを発生させたオブジェクト。伝播されたイベントの場合、イベントを発生させた伝播チェーンの最後のオブジェクト。 |
sourceTarget |
Object |
最初にイベントを発生させたオブジェクト。伝播されていないイベントの場合、これはtarget と同じになります。 |
propagatedFrom |
Object |
伝播されたイベントの場合、イベントをイベントの親に伝播した最後のオブジェクト。 |
LayersControlEvent
Property | 型 | 説明 |
---|---|---|
layer |
レイヤー |
追加または削除されたレイヤー。 |
name |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
追加または削除されたレイヤーの名前。 |
Property | 型 | 説明 |
---|---|---|
type |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
イベントタイプ(例:'click' )。 |
target |
Object |
イベントを発生させたオブジェクト。伝播されたイベントの場合、イベントを発生させた伝播チェーンの最後のオブジェクト。 |
sourceTarget |
Object |
最初にイベントを発生させたオブジェクト。伝播されていないイベントの場合、これはtarget と同じになります。 |
propagatedFrom |
Object |
伝播されたイベントの場合、イベントをイベントの親に伝播した最後のオブジェクト。 |
TileEvent
Property | 型 | 説明 |
---|---|---|
tile |
HTMLElement |
タイル要素(画像)。 |
coords |
ポイント |
タイルのx 、y 、およびz (ズームレベル)座標を持つPointオブジェクト。 |
Property | 型 | 説明 |
---|---|---|
type |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
イベントタイプ(例:'click' )。 |
target |
Object |
イベントを発生させたオブジェクト。伝播されたイベントの場合、イベントを発生させた伝播チェーンの最後のオブジェクト。 |
sourceTarget |
Object |
最初にイベントを発生させたオブジェクト。伝播されていないイベントの場合、これはtarget と同じになります。 |
propagatedFrom |
Object |
伝播されたイベントの場合、イベントをイベントの親に伝播した最後のオブジェクト。 |
layer |
Object |
非推奨。propagatedFrom と同じ。 |
TileErrorEvent
Property | 型 | 説明 |
---|---|---|
tile |
HTMLElement |
タイル要素(画像)。 |
coords |
ポイント |
タイルのx 、y 、およびz (ズームレベル)座標を持つPointオブジェクト。 |
error |
* |
タイルのdone() コールバックに渡されたエラー。 |
Property | 型 | 説明 |
---|---|---|
type |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
イベントタイプ(例:'click' )。 |
target |
Object |
イベントを発生させたオブジェクト。伝播されたイベントの場合、イベントを発生させた伝播チェーンの最後のオブジェクト。 |
sourceTarget |
Object |
最初にイベントを発生させたオブジェクト。伝播されていないイベントの場合、これはtarget と同じになります。 |
propagatedFrom |
Object |
伝播されたイベントの場合、イベントをイベントの親に伝播した最後のオブジェクト。 |
layer |
Object |
非推奨。propagatedFrom と同じ。 |
ResizeEvent
Property | 型 | 説明 |
---|---|---|
oldSize |
ポイント |
リサイズイベント前の古いサイズ。 |
newSize |
ポイント |
リサイズイベント後の新しいサイズ。 |
Property | 型 | 説明 |
---|---|---|
type |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
イベントタイプ(例:'click' )。 |
target |
Object |
イベントを発生させたオブジェクト。伝播されたイベントの場合、イベントを発生させた伝播チェーンの最後のオブジェクト。 |
sourceTarget |
Object |
最初にイベントを発生させたオブジェクト。伝播されていないイベントの場合、これはtarget と同じになります。 |
propagatedFrom |
Object |
伝播されたイベントの場合、イベントをイベントの親に伝播した最後のオブジェクト。 |
layer |
Object |
非推奨。propagatedFrom と同じ。 |
GeoJSONEvent
Property | 型 | 説明 |
---|---|---|
layer |
レイヤー |
マップに追加されているGeoJSONフィーチャのレイヤー。 |
プロパティ |
Object |
フィーチャのGeoJSONプロパティ。 |
geometryType |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
フィーチャのGeoJSONジオメトリタイプ。 |
id |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
フィーチャのGeoJSON ID(存在する場合)。 |
Property | 型 | 説明 |
---|---|---|
type |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
イベントタイプ(例:'click' )。 |
target |
Object |
イベントを発生させたオブジェクト。伝播されたイベントの場合、イベントを発生させた伝播チェーンの最後のオブジェクト。 |
sourceTarget |
Object |
最初にイベントを発生させたオブジェクト。伝播されていないイベントの場合、これはtarget と同じになります。 |
propagatedFrom |
Object |
伝播されたイベントの場合、イベントをイベントの親に伝播した最後のオブジェクト。 |
PopupEvent
Property | 型 | 説明 |
---|---|---|
popup |
ポップアップ |
開いたまたは閉じたポップアップ。 |
Property | 型 | 説明 |
---|---|---|
type |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
イベントタイプ(例:'click' )。 |
target |
Object |
イベントを発生させたオブジェクト。伝播されたイベントの場合、イベントを発生させた伝播チェーンの最後のオブジェクト。 |
sourceTarget |
Object |
最初にイベントを発生させたオブジェクト。伝播されていないイベントの場合、これはtarget と同じになります。 |
propagatedFrom |
Object |
伝播されたイベントの場合、イベントをイベントの親に伝播した最後のオブジェクト。 |
layer |
Object |
非推奨。propagatedFrom と同じ。 |
TooltipEvent
Property | 型 | 説明 |
---|---|---|
tooltip |
ツールチップ |
開いたまたは閉じたツールチップ。 |
Property | 型 | 説明 |
---|---|---|
type |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
イベントタイプ(例:'click' )。 |
target |
Object |
イベントを発生させたオブジェクト。伝播されたイベントの場合、イベントを発生させた伝播チェーンの最後のオブジェクト。 |
sourceTarget |
Object |
最初にイベントを発生させたオブジェクト。伝播されていないイベントの場合、これはtarget と同じになります。 |
propagatedFrom |
Object |
伝播されたイベントの場合、イベントをイベントの親に伝播した最後のオブジェクト。 |
layer |
Object |
非推奨。propagatedFrom と同じ。 |
DragEndEvent
Property | 型 | 説明 |
---|---|---|
distance |
数値 |
ドラッグ可能な要素が移動したピクセル単位の距離。 |
Property | 型 | 説明 |
---|---|---|
type |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
イベントタイプ(例:'click' )。 |
target |
Object |
イベントを発生させたオブジェクト。伝播されたイベントの場合、イベントを発生させた伝播チェーンの最後のオブジェクト。 |
sourceTarget |
Object |
最初にイベントを発生させたオブジェクト。伝播されていないイベントの場合、これはtarget と同じになります。 |
propagatedFrom |
Object |
伝播されたイベントの場合、イベントをイベントの親に伝播した最後のオブジェクト。 |
layer |
Object |
非推奨。propagatedFrom と同じ。 |
ZoomAnimEvent
Property | 型 | 説明 |
---|---|---|
center |
LatLng |
マップの現在の中心 |
zoom |
数値 |
マップの現在のズームレベル |
noUpdate |
ブール値 |
このイベントが原因でレイヤーがコンテンツを更新する必要があるかどうか |
Property | 型 | 説明 |
---|---|---|
type |
地理的なポイントとオプションでオプションオブジェクトを指定して、Markerオブジェクトをインスタンス化します。 |
イベントタイプ(例:'click' )。 |
target |
Object |
イベントを発生させたオブジェクト。伝播されたイベントの場合、イベントを発生させた伝播チェーンの最後のオブジェクト。 |
sourceTarget |
Object |
最初にイベントを発生させたオブジェクト。伝播されていないイベントの場合、これはtarget と同じになります。 |
propagatedFrom |
Object |
伝播されたイベントの場合、イベントをイベントの親に伝播した最後のオブジェクト。 |
layer |
Object |
非推奨。propagatedFrom と同じ。 |
グローバルスイッチ
グローバルスイッチはまれなケースのために作成され、一般的にLeafletが特定のブラウザー機能をたとえ存在していても検出しないようにします。ページのLeafletを含める前に、次のようにグローバル変数をtrueとして設定する必要があります。
<script>L_NO_TOUCH = true;</script>
<script src="leaflet.js"></script>
スイッチ | 説明 |
---|---|
L_NO_TOUCH |
Leafletがタッチイベントを検出しても、使用しないように強制します。 |
L_DISABLE_3D |
ハードウェアアクセラレーションされたCSS 3D変換をポジショニングに使用しないように強制します(一部のまれな環境でグリッチを引き起こす可能性があります)たとえそれらがサポートされていても。 |
noConflict
このメソッドは、L
グローバル変数をLeafletを含める前の元の値に戻し、実際のLeaflet名前空間を返すため、次のように別の場所に配置できます。
<script src='libs/l.js'>
<!-- L points to some other library -->
<script src='leaflet.js'>
<!-- you include Leaflet, it replaces the L variable to Leaflet namespace -->
<script>
var Leaflet = L.noConflict();
// now L points to that other library again, and you can use Leaflet.Map etc.
</script>
バージョン
使用中のLeafletバージョンを表す定数。
L.version; // contains "1.0.0" (or whatever version is currently in use)
map.getPane
またはmap.getPanes
メソッドを使用してペインにアクセスできます。新しいペインは、map.createPane
メソッドを使用して作成できます。すべてのマップには、zIndexのみが異なる次のデフォルトペインがあります。